文档帮助平台
首页服务端API参考 企业成员管理 批量查询用户信息
批量查询用户信息
更新时间：2024-11-15 15:00:47

批量查询用户信息

请求方法

POST

请求地址

/users/batch

请求参数

参数 参数类型 数据类型 是否必需 描述
ids Body String[] 是 用户id列表，最大200
detail Body Boolean 否 是否查询详细的用户信息，默认否

HTTP状态码

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

响应参数

参数 数据类型 描述
users User[] User信息数组

User对象定义

参数 数据类型 描述
id String 主键id
partyId String 所属企业id
groupId String 分组id
name String 名称
alias String 用户别名
gender Integer 性别，0：保密；1：男；2：女
number String 账号
extAccount String 第三方账号

当请求参数的 detail = true 时，响应参数额外返回如下参数：

参数 数据类型 描述
namePinyinForSearch String 名称全拼，简拼用于搜索
email String 邮箱
status String 在线状态，offline：离线，online：在线
extension String 分机号
mobile String 手机号
mobileCode String 手机区号
title String 职位
accountStatus Integer 账户状态，0：未验证；1：已验证
emailBound Boolean 是否绑定邮箱
mobileBound Boolean 是否绑定手机号
enableMeetingNow Boolean 是否启用即时会议功能
enableMeetingAppoinitment Boolean 是否启用会议预约功能
isManager Boolean 是否为企业管理员
aliasPinyinForSearch String 别名全拼，简拼用于搜索
userName String 用户名
index Long 排序
enableAudioPermission Boolean 是否开启语音权限
callPermissions String[] 呼叫权限列表,intra_office:局内呼叫，local：本地呼叫，national_toll：国内长途, international_toll：国际长途
callForward CallForward 工作时间呼叫转移配置
customFields Map<String, Object> 自定义字段
extAccountType Integer 第三方账号类型，1：LDAP账号。null: 普通账号
enableMobileHide Boolean 手机号隐藏
enableAutomaticRecording Boolean 是否开启自动录音权限
recordingRange Integer 自动录音范围，0：外线通话，1：全部通话
enableManualRecording Boolean 是否开启手动录音权限
enableIm Boolean 是否开启IM权限
enableIpLimit Boolean 是否开启Ip限制
networkSegmentRang String 网段范围 , ip/掩码位: 比如"1.1.1.1/2"
telNumbers TelNumber[] 电话号码列表
callerTelNumber TelNumber 外呼主叫电话号码
enableAudioConferencePermission Boolean 是否开启语音会议权限
enableVideoPermission Boolean 是否开启视频权限

CallForward

请求参数 数据类型 描述
ringMode Integer 工作时间响铃模式，1：顺序响铃， 2：同时响铃
noAnswerForward Integer 工作时间无应答转移，1：断开忙音，2：语音信箱
callForwardQueue CallForwardQueue[] 工作时间转移队列

CallForwardQueue

参数名称 数据类型 描述
enable Boolean 是否启用
answerTime Integer 应答时间(单位s)
forwardTargetType Integer 转移目标类型，0：账号在线设备，1：手机号码，2：外部号码，3：内部分机号，4：振铃组
forwardTarget String 转移目标，转移目标类型为3时，转移目标为企业内部分机号； 转移目标类型为4时，转移目标为振铃组分机号

TelNumber

请求参数 数据类型 描述
id String 电话号码id
number String 电话号码

请求消息示例

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

{
    "ids": ["b83ba3ae902e43679be4e311d0ccaa4a"],
    "detail": true
}

响应消息示例

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

[
	{
		"id": "9ecc83e4c7d44728bbb1e2ec226dffe7",
		"partyId": "c22c0ab68bc74219aa894261b2d131dc",
		"groupId": "65ddf0d5c0d64d4aab3bacc2cd690c28",
		"type": 2,
		"name": "zd3",
		"namePinyinForSearch": "z,zd3,zd3",
		"email": "test@yealink.com",
		"number": "145516*2222",
		"status": "offline",
		"extension": null,
		"extAccount": "zd3",
		"mobile": "13500000000",
		"title": null,
		"gender": 0,
		"accountStatus": 0,
		"emailBound": false,
		"mobileBound": false,
		"enableMeetingNow": false,
		"enableMeetingAppoinitment": true,
		"isManager": false,
		"alias": null,
		"aliasPinyinForSearch": null,
		"userName": "zxw",
		"index": 1000,
		"enableVideoPermission": false,
		"enableAudioConferencePermission": false,
		"enableAudioPermission": false,
		"callPermissions": [
			"national_toll",
			"intra_office"
		],
		"callForward": {
			"ringMode": 1,
			"noAnswerForward": 0,
			"callForwardQueue": [
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 0,
					"forwardTarget": ""
				},
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 1,
					"forwardTarget": ""
				},
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 3,
					"forwardTarget": "0002"
				},
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 2,
					"forwardTarget": "2232"
				},
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 1,
					"forwardTarget": ""
				},
				{
					"enable": true,
					"answerTime": 60,
					"forwardTargetType": 4,
					"forwardTarget": "110238"
				}
			]
		},
		"customFields": {
			"customField5": {
				"name": "xxx",
				"url": "http://10.10.10.10"
			},
			"customField7": null,
			"customField8": null,
			"customField1": "test",
			"customField10": null,
			"customField3": "dingyi3",
			"customField4": null,
			"customField9": null
		},
		"extAccountType": null,
		"enableMobileHide": true,
		"enableAutomaticRecording": true,
		"recordingRange": 1,
		"enableManualRecording": true,
		"enableIm": false,
		"enableIpLimit": true,
		"callerTelNumber": {
			"id": "f5ee96d9ba4c4d5fa4502419212c0049",
			"number": "10086"
		},
		"telNumbers": [
			{
				"id": "428b301ee648449c80fe2b9238cbedac",
				"number": "10088"
			}
		],
		"networkSegmentRang": "1.1.1.1/2"
	}
]

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 '{"ids":["b83ba3ae902e43679be4e311d0ccaa4a"], "detail": true}' 'https://api.yealink.com/open/api/v2/users/batch'
本页目录