You need to enable JavaScript to run this app.
导航
SendCustomSystemMessageAPI - 发送自定义系统消息
最近更新时间:2025.03.24 16:50:54首次发布时间:2022.07.29 09:31:39
我的收藏
有用
有用
无用
无用

调用 SendCustomSystemMessageAPI 接口发送自定义系统消息。您可按需选择发送在观看页展示的自定义系统消息或向 SDK 发送自定义 IM(长链接消息)信令。

注意事项

  • 请求频率:单用户请求频率限制为 15 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

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

Body

参数类型是否必选示例值描述

ActivityId

Long

177****9762

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

Content

String

***下单成功

待发送的自定义系统消息。MessageType 的取值不同,自定义系统消息的长度也不同。

  • MessageType 取值为 1 时,长度为 1 到 120 个字符。
  • MessageType 取值为 2 时,长度为 1 到 1200 个字符。

MessageType

Float

1

自定义系统消息类型。支持以下取值,默认取值为 1

返回参数

参数类型示例值描述

Status

Boolean

true

自定义系统消息是否发送成功。取值如下:

  • true:成功
  • false:失败

请求示例

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

返回示例

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

错误码

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