接口行为

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

调用接口

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`UserBroadcast`	接口名称，本接口取值：`UserBroadcast`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

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

注释 1：全员广播对象由 TagOp 和 Tags 字段共同控制，TagOp 控制筛选标签的匹配关系，Tags 控制筛选标签。

当 TagOp = 0时，用户 {"key":"value"} 只需与 Tags 的 {"key":["value"]} 中有相同标签，即会对该用户进行广播；
当 TagOp = 1时，用户 {"key":"value"} 必须与 Tags 的{"key":["value"]} 一一对应才会对该用户进行广播。

例如：当 A 用户的标签为 {"age":"young" , "level":"10" ,"keyA":"valueA"} , B 用户的标签为{"age":"old" , "level":"5"}，Tags 为 {"age":["young"] , "level":["10","20"],"keyB":["valueB"]}

当 TagOp = 0 时，A 用户与 Tags 有相同标签"age":"young" , "level":"10"， B 用户与 Tags 没有相同标签，因此只会对 A 用户进行广播。
当 TagOp = 1 时，A 用户与 B 用户的标签均不与 Tags 的标签一一对应，因此不会对 A 和 B 用户进行广播。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=UserBroadcast&Version=2020-12-01
postscript

Body

{
    "AppId":666675,
    "InboxType":0,
    "Sender":10001,
    "MsgTTL":300,
    "MsgType":10001,
    "Content":"Your_Content",
    "TagOp":0,
    "Tags":{"age":["young"] , "level":["10"],"keyB":["valueB"]},
    "Ext":{"message_ext":"123"}
}
Json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。
请求成功或失败时，Result 均返回为空。

正常返回示例

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