批量获取账号信息
更新时间: 2024/11/04 15:22:15
本文介绍如何批量获取 NERoom 账号的昵称、头像和 Token信息。
请先 创建 NERoom 账号,再调用本接口。
请求
URI
GET https://{endpoint}/neroom/v3/users?user_uuids=:user_uuids
{endpoint} 为 NERoom 接入地址的域名,默认为 roomkit.netease.im
。如果您的应用主要服务于海外用户,请将域名设置为海外数据中心域名(roomkit-sg.netease.im
)。
Header
请求 Header 的设置请参见 请求结构。
查询参数
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
user_uuids | String | 是 | user1%2user2%2user3 | 账号列表,以英文逗号分隔后再经过 URL 编码,账号个数上限100。 |
请求示例
GET https://roomkit.netease.im/neroom/v3/users?user_uuids=user1%2user2%2user3
响应
响应参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | int | 0 | 状态码,0表示成功,具体请参见错误码。 |
msg | String | Operation succeeded. | 业务结果描述 |
ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。 该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数。 |
request_id | String | 7c4b***e3a4d995 | 请求的唯一标识。 |
cost | String | 48ms | 处理该请求所消耗的时间。 |
- data | Array of Object | 用户信息数组 | |
user_uuid | String | user_uuid_00001 | 用户账号。 |
user_token | String | 0ZNLD4***2N251D1 | 用户的 Token。 |
im_token | String | 0ZNLD4***2N251D1 | IM 的 Token。 |
user_name | String | 用户01 | 用户昵称。如果没有设置参数,则不会返回。 |
icon | String | https://tupian.jpg | 用户的头像。如果没有设置参数,则不会返回。 |
响应体示例
json{
"code": 0,
"msg": "Operation succeeded.",
"ts": 1691410833636,
"cost": "318ms",
"request_id": "local_a7e68aa2d1ee46e1be0f239d1f352773",
"data": [
{
"user_uuid": "user1",
"user_name": "user1",
"icon": "https://tupian.jpg",
"user_token": "token1",
"im_token": "token1"
},
{
"user_uuid": "user2",
"user_name": "user2",
"icon": "https://tupian.jpg",
"user_token": "token2",
"im_token": "token2"
}
]
}
错误码
错误码 | 错误信息 | 说明 | 处理建议 |
---|---|---|---|
0 | Success | 请求成功 | 无需处理 |
400 | Invalid parameter. | 参数错误 | 检查接口传参 |
此文档是否对你有帮助?