查询用户列表

请求方法

GET

请求地址

/users

请求参数

参数	参数类型	数据类型	是否必需	描述
limit	Query	Long	否	获取的最大记录数，默认为10，最大100
offset	Query	Long	否	跳过的记录数，默认为0
groupId	Query	String	否	指定查询的起始分组，长度32，默认从根分组开始查询
searchKey	Query	String	否	模糊查询关键字，长度小于128，支持按名称搜索

HTTP状态码

返回值	描述
200	操作成功，详见响应参数
400	客户端传参异常
401	鉴权失败
500	服务端异常

响应参数

参数	数据类型	描述
offset	Long	偏移量
limit	Long	返回最大数量
total	Long	总数据量
data	User[]	User信息数组

User对象定义

参数	数据类型	描述
id	String	主键id
partyId	String	所属企业id
groupId	String	分组id
name	String	名称
namePinyinForSearch	String	名称全拼，简拼用于搜索
alias	String	用户别名
aliasPinyinForSearch	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：已验证
extAccount	String	第三方账号
extAccountType	Integer	第三方账号类型，1：LDAP账号, null:普通账号
userName	String	用户名

请求消息示例

GET /open/api/v2/users HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"offset": 0,
	"limit": 10,
	"total": 4,
	"data": [{
		"id": "8d07a56207074d26b61026099625b9e2",
		"partyId": "c22c0ab68bc74219aa894261b2d131dc",
		"groupId": "65ddf0d5c0d64d4aab3bacc2cd690c28",
		"type": 2,
		"name": "zd2",
		"namePinyinForSearch": "z,zd2,zd2"
		"alias": "zz",
		"aliasPinyinForSearch": "z,zz,zz",
		"email": null,
		"number": "145516*3333",
		"status": "offline",
		"extension": null,
		"mobile": "17700000000",
		"title": null,
		"gender": null,
		"accountStatus": 0,
		"extAccount": null,
		"extAccountType": null,
		"userName": "xxtest"
	}]
}

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/open/api/v2/users'