发送自定义系统消息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

发送自定义系统消息

最近更新时间：2024.07.10 15:40:50首次发布时间：2022.07.29 09:31:39

您可通过此接口发送自定义系统消息，包括在观看页展示的自定义系统消息，以及发送给 Web SDK 或 Native SDK 的自定义 IM（即时消息）信令。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

ActivityId Long 是 123123 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`123123`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
Content	String	是	`***下单成功`	待发送的自定义系统消息。`MessageType` 的取值不同，自定义系统消息的长度也不同。 `MessageType` 取值为 `1` 时，最多支持输入 120 个字符。 `MessageType` 取值为 `2` 时，最多支持输入 600 个字符。
MessageType	Float	否	`1`	自定义系统消息类型。支持以下取值，默认取值为 `1`。 `1`：在观看页展示的自定义系统消息。 `2`：发送给 Web SDK 或 Native SDK 的自定义 IM（即时消息）信令。详见customMessage.send、iOS 开播 SDK 回调、iOS 观播 SDK 回调、Android 开播 SDK 回调、Android 观播 SDK 回调。

Content

String

是

***下单成功

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

MessageType 取值为 1 时，最多支持输入 120 个字符。
MessageType 取值为 2 时，最多支持输入 600 个字符。

MessageType

Float

否

1

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

1：在观看页展示的自定义系统消息。
2：发送给 Web SDK 或 Native SDK 的自定义 IM（即时消息）信令。详见customMessage.send、iOS 开播 SDK 回调、iOS 观播 SDK 回调、Android 开播 SDK 回调、Android 观播 SDK 回调。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	自定义系统消息是否发送成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

自定义系统消息是否发送成功。支持以下取值：

true：成功
false：失败

请求示例

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

返回示例

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

错误码

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