全员广播 UserBroadcast--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

全员广播 UserBroadcast

最近更新时间：2024.01.25 17:26:24首次发布时间：2023.08.15 19:07:15

你可以使用该接口对符合标签的用户进行全员广播。

使用说明

你可以调用 UserBroadcast 接口，指定你所属的 AppId、发送方 UserId，标签，标签匹配关系对符合标签的用户进行全员广播。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 50。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=UserBroadcast&Version=2020-12-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
InboxType	Integer	否	`0`	信箱，用做逻辑隔离。默认值为 0。
Sender	Long	是	`10001`	发送方
MsgTTL	Long	是	`300`	消息过期时间，单位为秒，范围为[1,604800]
MsgType	Integer	是	`10001`	消息类型。
Content	String	是	`Your_Content`	消息内容。关于消息类型和消息内容，参看消息相关
TagOp	Integer	否	`0`	筛选用户时，Tag 匹配关系。 0：或 1：且默认值为 0。
Tags	Array of String	否	`["age","level"]`	筛选标签。不填表示全员广播。
Ext	JSON Map	否	`"key":"value"`	消息的扩展字段。`key` 的类型为 String，`value` 的类型为 String。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
请求成功或失败时，Result 均返回为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UserBroadcast&Version=2020-12-01
{
    "AppId": 000000,
    "InboxType": 0,
    "Sender": 104,
    "MsgTTL": 60480,
    "MsgType": 10001,
    "Content": "Your_Content",
    "TagOp": 0,
    "Tags": ["tag1:v1"],
    "Ext": {
        "message_ext": "123"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UserBroadcast",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。