接口行为

你可以调用 RegisterUsers 接口，指定你所属的 AppId、用户 ID ，用户 Tag 对广播用户进行注册。

当前注册广播用户仅用来进行全员广播，其他操作如发消息无需注册用户。

调用接口

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
InboxType	Int	否	`0`	信箱，用做逻辑隔离。默认值为 `0`
Users	Array of User	是	/	注册用户的信息。一次最多注册 10 个用户。

User

参数名	类型	必填	示例值	描述
UserId	Int	是	`10001`	注册用户的 UserId
Tags	Map-key(string)-value(string)	否	`"age":"old"`	用户标签

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "InboxType":0,
    "Users":[
        {
            "UserId":30333,
            "Tags":{
                "age":"young"
            }
        },
        {
            "UserId":30331,
            "Tags":{
                "age":"old"
            }
        },
        {
            "UserId":30332,
            "Tags":{
                "level":"5"
            }
        },
        {
            "UserId":30333,
            "Tags":{
                "level":"10"
            }
        }
    ]
}
json

返回调用结果

返回参数说明

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

正常返回示例

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