接口行为

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

调用接口

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
InboxType	Int	否	`0`	信箱，用做逻辑隔离。默认值为 `0`。
UserIds	Array of Int	是	`[10002,10003]`	查询用户 UserId。一次最多查询 10 个用户。

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "InboxType":0,
    "UserIds":[10002,10003]
}
json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。
其中 Result 的结构如下：

参数名	类型	描述
Users	User	用户信息

参数名	类型	示例值	描述
AppId	Int	`000000`	应用的唯一标志
InboxType	Int	`0`	信箱主要用做逻辑隔离
UserId	Int	`10001`	用户 UserId
Tags	Map-key(string)-value(string)	`{"key":"value"}`	用户标签
CreateTime	Int	`1690977217576`	用户注册时间戳，单位为毫秒
ModifyTime	Int	`1690977217576`	更新时间戳，单位为毫秒

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchGetUser",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Users": [
            {
                "AppId": 000000,
                "InboxType": 0,
                "UserId": 10001,
                "Tags": {
                    "age": "old"
                },
                "CreateTime": 1690977217576,
                "ModifyTime": 1690977217876
            }
        ]
    }
}
json