功能描述

该接口可以查询一批云信账号的用户名片信息。

名片信息包括账户的昵称、头像、签名、邮箱、生日、手机号、性别等信息。

如果提供的账号列表中某个账号 ID 不存在或者用户名片不存在，则返回其他存在的账号 ID 的用户信息以及查询失败的账号列表。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

GET https://open.yunxinapi.com/im/v2/users

Header

请求 Header 的参数说明请参见请求 Header。

查询参数

参数名称	类型	是否必选	描述	示例
account_ids	Array of strings	必选	需要查询用户名片的云信账号 ID 列表，该值是由多个经过 URL 编码后的用户 ID 组成，以逗号分隔，一次最多查询 100 个账号。如果提供的账号列表中某个账号 ID 不存在或者用户名片不存在，则返回其他存在的账号 ID 的用户信息以及查询失败的账号列表。	"account1,account2,account3"

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
- success_list	Array of objects	查询成功的云信账号用户信息列表。	否
account_id	String	云信账号 ID。	否
name	String	用户昵称。	否
avatar	String	用户头像的 URL 地址。	否
sign	String	用户签名。	否
email	String	用户邮箱地址。	否
birthday	String	用户生日。	否
mobile	String	用户手机号码。	否
gender	Integer	用户性别，0-未知，1-男，2-女。	否
extension	String	预留给开发者的扩展字段，建议封装成 JSON 格式。	否
- failed_list	Array of objects	查询失败的云信账号列表。	否
account_id	String	查询失败的云信账号 ID。	否
error_code	Integer	查询失败的错误码。	否
error_msg	String	查询失败的提示信息。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "account_id": "123456",
                "name": "zhangsan",
                "avatar": "http://xxxx.xx/x.png",
                "sign": "Hello World",
                "email": "zhangsan@corp.xx.com",
                "birth": "xxxx-xx-xx",
                "mobile": "13312345678",
                "gender": "2",
                "extension": "xxxx"
            },
            {
                "account_id": "123456",
                "name": "zhangsan",
                "avatar": "http://xxxx.xx/x.png",
                "sign": "Hello World",
                "email": "zhangsan@corp.xx.com",
                "birth": "xxxx-xx-xx",
                "mobile": "13312345678",
                "gender": "2",
                "extension": "xxxx"
            }
        ],
        "failed_list": [
            {
                "account_id": "Accid1",
                "error_code": 102404,
                "error_msg": "account_id does not exist"
            }
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
500	服务器内部错误	internal server error