根据分机号查询用户列表
更新时间:2025-04-17 03:42:15

根据分机号查询用户列表

请求方法

POST

请求地址

/users/byPhoneExtensions

请求参数

参数 参数类型 数据类型 是否必需 描述
phoneExtensions Body String[] 查询的分机号列表,一次最多查200个

HTTP状态码

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

响应参数

参数 参数类型 描述
users User[] 用户列表

User对象定义

参数 数据类型 描述
id String 主键id,用户id
partyId String 所属企业id
name String 名称
alias String 用户别名
email String 邮箱
title String 职位
gender Integer 性别,0:保密;1:男;2:女
extAccount String 第三方账号,如AD账号 th489211
phoneExtension String 分机号
regList Reg[] 绑定设备列表

Reg对象定义

参数 数据类型 描述
model String 设备型号
clientAddress String ip地址
clientId String 终端标识

请求消息示例

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

{
    "phoneExtensions": [
        "0000",
        "0001"
    ]
}

响应消息示例

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

{
	"users": [
		{
			"id": "8d07a56207074d26b61026099625b9e2",
			"partyId": "c22c0ab68bc74219aa894261b2d131dc",
			"name": "zd2",
			"alias": "zz",
			"email": null,
			"extAccount": "th489211", // 第三方账号:AD账号
			"title": null,
			"gender": null,
			"regList": [
				{
					"clientId": "2ccd72e6c3f341c4b2cba7c1fd8a1b50", //终端标识
					"clientAddress": "10.66.22.5", //ip
					"model": "UME(Android)" // 设备型号
				}
			]
		}
	]
}

CURL命令示例

curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" -d '{"phoneExtensions":["0000","0001"]}' 'https://api.yealink.com/open/api/v2/users/byPhoneExtensions'
本页目录