You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

查询用户资料 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

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

Body

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

返回参数

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

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

Users

参数类型示例值描述
AppIdInteger000000用户所属应用
UserIdLong10001用户 UserId
TagsArray of String["age","level"]用户标签
CreateTimeLong1690977217576用户注册时间戳，单位为毫秒
ModifyTimeLong1690977217876更新时间戳，单位为毫秒
NickNameString"Your_NickName"用户昵称
PortraitString"http://xxxx"用户头像
ExtJSON 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]
    }
}

错误码

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