查询用户详情
请求方法
GET
请求地址
/users/{userId}
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
userId |
Path |
String |
是 |
用户主键id,长度32 |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
id |
String |
主键id |
partyId |
String |
所属企业id |
groupId |
String |
分组id |
name |
String |
名称 |
email |
String |
邮箱 |
number |
String |
号码 |
status |
String |
在线状态,offline:离线,online:在线 |
extension |
String |
分机号 |
mobile |
String |
手机号 |
mobileCode |
String |
手机区号 |
title |
String |
职位 |
gender |
Integer |
性别,0:保密;1:男;2:女 |
accountStatus |
Integer |
账户状态,0:未验证;1:已验证 |
emailBound |
Boolean |
是否绑定邮箱 |
mobileBound |
Boolean |
是否绑定手机号 |
enableMeetNow |
Boolean |
是否启用即时会议功能 |
enableScheduled |
Boolean |
是否启用会议预约功能 |
~~visiblePermission~~ |
VisiblePermission |
可见权限,字段废弃 |
VisiblePermission
VisiblePermissionNode
参数 |
数据类型 |
是否必须 |
描述 |
dataId |
String |
是 |
节点数据id,E权限时有效,其值为节点数据类型对应的实体id |
dataType |
Integer |
否 |
节点数据类型,E权限时有效,详见节点数据类型 |
可见权限类型
可见权限类型 |
值 |
可见企业内全部联系人 |
A |
可见所在部门及同级部门的所有联系人 |
B |
仅可见所在部门的所有联系人 |
C |
仅可见自己 |
D |
自定义 |
E |
节点数据类型
节点数据类型 |
值 |
用户分组 |
1 |
用户 |
2 |
设备分组 |
3 |
设备 |
4 |
VMR分组 |
5 |
VMR |
6 |
外部联系人分组 |
9 |
外部联系人 |
10 |
请求消息示例
GET /v2/users/9ecc83e4c7d44728bbb1e2ec226dffe7 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "9ecc83e4c7d44728bbb1e2ec226dffe7",
"partyId": "c22c0ab68bc74219aa894261b2d131dc",
"groupId": "65ddf0d5c0d64d4aab3bacc2cd690c28",
"type": 2,
"name": "zd3",
"email": "test@yealink.com",
"number": "81455162222",
"status": "offline",
"extension": null,
"mobile": "13500000000",
"title": null,
"gender": 0,
"accountStatus": 0,
"emailBound": false,
"mobileBound": false,
"enableScheduled": true,
"enableMeetNow": true
}
CURL命令示例
curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" 'https://api.yealink.com/v2/users/7e7e10443f92422ea0d70fa6398a8dd3'