查询用户树
请求方法
GET
请求地址
/open/api/v1/users/tree
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
onlyGroup |
Query |
Boolean |
否 |
是否只查分组,true表示只查分组,默认false |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见Node[] |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
Node对象定义
参数 |
数据类型 |
描述 |
id |
String |
节点id |
parentId |
String |
父节点Id |
index |
Long |
分组下序号 |
dataType |
Integer |
节点数据类型,1:用户分组;2:用户 |
dataId |
String |
对应数据类型的主键id |
type |
Integer |
节点类型,0:非叶子节点;1:叶子节点 |
name |
String |
节点名称 |
number |
String |
账号 |
email |
String |
邮箱 |
请求消息示例
GET /open/api/v1/users/tree HTTP/1.1
Host: smart.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
[
{
"id": "418cb07091dc497f94d4112fbb9d7157",
"dataId": "e69e2b513c114294aaf027ecc5fd892a",
"parentId": null,
"index": 1,
"type": 0,
"name": "企业成员1",
"dataType": 1,
"number": null
}, {
"id": "6fe08cebe0444bb1bf5168e2697872ae",
"dataId": "9a4d2579c05c4b7bb812c8d79d83ff50",
"parentId": "b1114d1b95cf4ba69f18277e11f5c7e9",
"index": 100000000,
"type": 0,
"name": "企业成员2",
"dataType": 1,
"number": null
}
]
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://smart.yealink.com/open/api/v1/users/tree'