QueryUserInfos

POST

https://zim-api.zego.im/

支持通过用户 ID 查询用户的信息，包含用户名称、用户头像和扩展字段。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [QueryUserInfos]

接口原型参数

https://zim-api.zego.im/?Action=QueryUserInfos

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

UserIds string[]必填

可选值: <= 100

需要查询的用户 ID 列表（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API，最大支持查询 100 个用户 ID。单个用户 ID 不超过 64 字节。

说明

UserIds 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

以下仅列出了接口业务逻辑相关的 Code 和 SubCode ，完整返回码请参考全局返回码。

Code / SubCode	描述	处理建议
660000001	业务类通用错误。	请重试，或联系 ZEGO 技术支持。
660000002	不存在的用户 ID，或者用户已经登出。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660700008	获取用户信息出错。	请检查用户 ID 是否正确，或联系 ZEGO 技术支持。
660700015	用户未注册。	请先注册用户。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

Result object[]

查询成功结果。

Array[

UserId string

查询成功的用户 ID。

UserName string

用户名称。

UserAvatar string

用户头像地址。

Extra string

扩展字段。

]

ErrorList object[]

查询失败列表。用户 ID 不存在或者用户已登出时，通过该字段返回。

Code 为 0：
ErrorList 为空，全部用户在线状态查询成功。
ErrorList 不为空，表示部分用户在线状态查询失败，请参考 SubCode 处理。

Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示所有用户在线状态查询失败。

Array[

UserId string

查询失败的用户 ID。

SubCode number

查询失败时的返回码，完整返回码请参考 Code 说明或者全局返回码。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Result": [
    {
      "UserId": "UserA",
      "UserName": "userName",
      "UserAvatar": "avatar",
      "Extra": "extra"
    }
  ],
  "ErrorList": [
    {
      "UserId": "UserB",
      "SubCode": 660000002
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "Result": [
    {
      "UserId": "UserA",
      "UserName": "userName",
      "UserAvatar": "avatar",
      "Extra": "extra"
    }
  ],
  "ErrorList": [
    {
      "UserId": "UserB",
      "SubCode": 660000002
    }
  ]
}