批量查询用户详情
描述
批量查询用户详情，支持指定第三方账号查询详情。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
POST |
|---|---|
请求地址 |
/v1/usg/abs/users/list |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
idType |
是 |
String |
Query |
查询类型。默认是USER_ID。
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Request-Id |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN，英文为en-US。 |
[数组元素] |
否 |
Array of ShowUserRequestDTO objects |
Body |
用户ID或第三方账号信息列表。 minLength: 1 maxLength: 200 |
状态码
HTTP状态码 |
描述 |
|---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
[数组元素] |
Array of UserDTO objects |
用户信息列表。 |
参数 |
类型 |
描述 |
|---|---|---|
id |
String |
用户ID。 |
statusCode |
Integer |
查询用户详情时, 根据不同情况，响应不同。
|
account |
String |
用户账号。 |
name |
String |
用户名。 |
englishName |
String |
英文名。 |
String |
邮箱。 |
|
phone |
String |
用户手机。 |
deptName |
String |
用户部门。 |
number |
String |
用户SIP号码。 |
updateTime |
Long |
用户信息最后更新时间。 |
isHardTerminal |
Boolean |
是否为硬终端。
说明：
该参数将废弃，请勿使用。 |
vmrId |
String |
用户个人会议ID。 |
signature |
String |
用户签名。 |
title |
String |
职位。 |
description |
String |
描述信息。 |
hidePhone |
Boolean |
是否隐藏手机号（如果为true，其他人查询该用户时，不会返回该用户的手机号。自己查自己是可见的） |
type |
String |
类型：
|
deptCodes |
Array of strings |
部门编码列表。 |
请求消息示例
POST https://{endpoint}/v1/usg/abs/users/list?idType=USER_ID
Connection: keep-alive
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
[
{
"id": "ff8080816993bac00169bdf14e0800ad"
},
{
"id": "718b8be14f09432caf66f3076505207b"
}
]
响应消息示例
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 646
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 551aeb8cafbbaa7bbbdc7b1c76bba8ac
[
{
"account": "Zhangsan@example.com",
"name": "张三",
"englishName": "Zhangsan",
"email": "******",
"phone": "177****0476",
"deptName": "cloudcore",
"number": "+99111283523475338",
"updateTime": 1554268817303,
"isHardTerminal": false,
"vmrId": "912992631",
"signature": "张三的签名信息",
"title": "Project Manager",
"description": "张三的备注信息",
"type": "NORMAL_USER",
"deptCodes": [
"1"
]
}
]
错误码
当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '[{"id": "ff8080816993bac00169bdf14e0800ad"},{"id": "718b8be14f09432caf66f3076505207b"}]' https://api.meeting.huaweicloud.com/v1/usg/abs/users/list?idType=USER_ID
