查询座席业务账号信息(agentAccount/query)
场景描述
查询座席业务账号信息。填写座席业务账号条件时,为指定座席业务账号查询。不填写座席业务账号参数,填写pageNum,pageSize分页参数时,为批量查询。
接口方法
POST
接口URI
https://域名/apiaccess/rest/cc-management/v1/agentAccount/query,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
x-app-key |
string |
False |
appKey字段,用户标识,请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
requestParams |
object |
True |
请求参数对象 |
1.1 |
userAccount |
string |
False |
座席业务账号,不含分页参数pageNum,pageSize时必填,传userAccount时,其他入参无效 |
1.2 |
pageNum |
integer |
True |
页号,不填userAccount时生效,从0开始 |
1.3 |
pageSize |
integer |
True |
每页大小,不填userAccount时生效 |
1.4 |
agentType |
array |
False |
座席类型: 4:音频座席; 11:视频座席 5:多媒体座席; 99:全能座席 |
1.5 |
transparentDisplayFlag |
boolean |
False |
座席透显特性标记 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
是否必选
说明
1
schema
object
True
请求成功
1.1
resultCode
string
True
0成功,1失败
1.2
resultMessage
string
True
返回消息
1.3
data
array[object]
False
返回结果对象
1.3.1
userAccount
string
False
座席业务账号
1.3.2
userName
string
False
座席业务账号用户名
1.3.3
phone
string
False
电话号码
1.3.4
email
string
False
邮箱
1.3.5
agentType
integer
False
座席类型:
4:音频座席;
11:视频座席
5:多媒体座席;
99:全能座席
255:闲置的座席
1.3.6
ccRoleId
integer
False
座席角色id:
2:话务员;
3:质检员;
4:外呼座席
255:闲置角色
1.3.7
sipAccount
string
False
座席默认软电话号码
1.3.8
skills
array[object]
False
技能参数数组
1.3.8.1
skillId
integer
False
技能队列Id
1.3.8.2
agentWeight
integer
False
座席权重
1.3.8.3
skillWeight
integer
False
技能队列权重
1.3.9
workNo
integer
False
座席工号
1.3.10
transparentDisplayFlag
boolean
False
座席透显特性标记
1.4
total
integer
False
总数
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:查询座席业务账号——按业务账号查询
请求头:
x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX
请求参数:
{ "userAccount":"test123456" }
响应参数:
{ "data": [ { "skills": [ { "skillId": 2, "agentWeight": 1, "skillWeight": 2 } ], "agentType": 11, "phone": "", "userAccount": "test123456", "ccRoleId": 2, "userName": "test111", "sipAccount": "88880551", "email": "tst@*****.com" } ], "resultCode": "0", "resultMessage": "get agent account info success" }
- 场景描述:查询座席——按分页查询
请求头:
x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX
请求参数:
{ "pageNum":0, "pageSize":1 }
响应参数:
{ "data": [ { "skills": [ { "skillId": 3, "agentWeight": 1, "skillWeight": 1 } ], "agentType": 4, "phone": "", "userAccount": "chenchuang0513", "ccRoleId": 2, "sipAccount": "88880550", "userName": "chenchuang0513", "email": "che@*****.com" } ], "resultCode": "0", "resultMessage": "get agent account info success" }