查询用户资料 BatchGetUser--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

查询用户资料 BatchGetUser

最近更新时间：2024.01.30 16:36:08首次发布时间：2023.08.15 19:07:15

你可以使用此接口查询用户资料

使用说明

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

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
UserIds	Array of Long	是	`[10001,10002]`	查询用户 UserId，一次最多查询50个用户

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Users	Array of Users	`-`	用户详细信息
NotFoundUsers	Array of Long	`[10002]`	未查到的用户uid，原因：未注册或者已注销

Users

参数	类型	示例值	描述
AppId	Integer	`000000`	用户所属应用
UserId	Long	`10001`	用户 UserId
Tags	Array of String	`["age","level"]`	用户标签
CreateTime	Long	`1690977217576`	用户注册时间戳，单位为毫秒
ModifyTime	Long	`1690977217876`	更新时间戳，单位为毫秒
NickName	String	`"Your_NickName"`	用户昵称
Portrait	String	`"http://xxxx"`	用户头像
Ext	JSON Map	`"key","value"`	用户扩展字段。`key` 的类型为`String`，`value` 的类型为 `String`。

请求示例

POST https://rtc.volcengineapi.com?Action=BatchGetUser&Version=2020-12-01
{
    "AppId": 0,
    "UserIds": [
        10001, 10002
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchGetUser",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Users": [
            {
                "AppId": 000000,
                "UserId": 10001,
                "Portrait": "http://xxxx",
                "NickName": "Your_NickName",
                "Tags": [ "age","level"],
                "CreateTime": 1690977217576,
                "ModifyTime": 1690977217876,
                "Ext":{
                    "key":"value"
                }
            }
        ],
        "NotFoundUsers": [10002]
    }
}

错误码

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