You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

发送自定义系统消息

最近更新时间：2024.02.27 15:43:45

首次发布时间：2022.07.29 09:31:39

我的收藏

通过该接口实现自定义系统消息的发送。

注意事项

请求频率：单用户请求频率限制为 15 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=SendCustomSystemMessageAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是SendCustomSystemMessageAPI接口名称。当前 API 的名称为 SendCustomSystemMessageAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是123123直播间 ID。您可通过 ListActivityAPI 接口查询 ID。
ContentString是***下单成功待发送的自定义系统消息，长度不大于 120 个字符。

返回参数

参数类型示例值描述

Status

Boolean

true

自定义系统消息是否发送成功。

  • true：成功
  • false：失败

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=SendCustomSystemMessageAPI&Version=2020-06-01
{
  "ActivityId": 123123,
  "Content": "***下单成功"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D5",
    "Action": "SendCustomSystemMessageAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656419846
  },
  "Result": {
    "Status": true
  }
}

错误码

访问公共错误码和错误码获取详细信息。