查询用户信息

描述

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

接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=QueryUserInfos
传输协议：HTTPS
调用频率限制：20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
UserIds[]	Array of String	是	需要查询的用户 ID 列表，最大支持查询 100 个用户 ID。单个用户 ID 不超过 64 字节。

说明

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

请求示例

请求地址 URL：

Untitled

https://zim-api.zego.im/?Action=QueryUserInfos
&<公共请求参数>

Copied!

请求消息体：

Untitled

{
    "UserIds": ["userA","userB","userC"]
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Result	Object	查询成功结果。
└UserId	String	查询成功的用户 ID。
└UserName	String	用户名称。
└UserAvatar	String	用户头像地址。
└Extra	String	扩展字段。
ErrorList	Object	查询失败列表。用户 ID 不存在或者用户未注册时，通过该字段返回。 Code 为 0： ErrorList 为空，全部用户信息查询成功。 ErrorList 不为空，表示部分用户信息查询失败，请参考 SubCode 处理。 Code 不为 0： ErrorList 为空，表示参数错误、接口频率限制、系统错误。
└UserId	String	查询失败的用户 ID。
└SubCode	Number	查询失败时的返回码。

响应示例

Untitled

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

Copied!

返回码

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

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