查询技能队列(querySkills)
场景描述
查询技能队列
接口方法
POST
接口URI
https://域名/apiaccess/rest/cc-management/v1/skill/querySkills,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
X-APP-KEY |
string |
False |
appKey字段,用户标识,请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权信息,值为Bearer + tokenByAKSK接口的返回值中的AccessToken(Bearer后有空格) |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
name |
string |
False |
技能队列的名称,不超过20个字符。 不允许的特殊字符: [ `~!#$%^&*()+=|{}':;',<>/?~!#¥%……&*()+|{}【】‘;:”“’。,、?]|\n|\r|\t |
1.2 |
mediaTypeId |
string |
False |
媒体类型。5:音视频;53:多媒体;2:语音点击通话;18:视频点击通话 |
1.3 |
limit |
string |
False |
表示每页的查询数量,正整数,最大为100 |
1.4 |
offset |
string |
False |
offset用于确定查询的起始页。offset取值范围为:offset=limit*(page-1),page为需要查询的起始页。 |
1.5 |
skillIds |
array |
False |
根据skillId查技能队列,可传多个,为String型的数组,可以传空数组,查询所有技能队列,最多返回100个 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
是否必选
说明
1.1
returnCode
string
False
操作结果。0:成功,非0为失败
1.2
description
string
False
提示信息
1.3
total
number
False
数据总数
1.4
data
array[object]
False
数据信息
1.4.1
skillId
number
False
技能ID
1.4.2
name
string
False
技能队列的名称,不超过20个字符。
不允许的特殊字符:
[ `~!#$%^&*()+=|{}':;',<>/?~!#¥%……&*()+|{}【】‘;:”“’。,、?]|\n|\r|\t
1.4.3
description
string
False
技能简称或描述,不超过50个字符(允许的字符包括中文、字母、数字)
1.4.4
mediaTypeId
number
False
媒体类型。5:语音;53:多媒体;19:视频;2:语音点击通话;18:视频点击通话
1.4.5
maxWaitTime
number
False
最大排队等待时间,单位秒,最大值60000
1.4.6
maxWaitNum
number
False
最大排队等待人数,最大值10000
1.4.7
maxAgentWrapupTime
number
False
整理态时长,单位秒,最大值3600
1.4.8
skillParam
object
False
技能队列参数信息,媒体类型为53或2或18时,只有noAgents、busy和timeOut三项配置,媒体类型为53时deviceType的值只能为1
1.4.8.1
noAgents
object
False
无人上班配置
1.4.8.1.1
deviceType
string
False
设备类型。3:IVR;1:技能队列
1.4.8.1.2
transferType
string
False
处理策略。
Release:释放
Transfer:转接
1.4.8.1.3
value
number
False
技能队列时取skillId,IVR时取IVR流程编号id
1.4.8.2
busy
object
False
排队遇忙、溢出配置
1.4.8.2.1
deviceType
string
False
设备类型。3:IVR;1:技能队列
1.4.8.2.2
transferType
string
False
处理策略Release释放Transfer转接
1.4.8.2.3
value
number
False
技能队列时取skillId,IVR时取IVR流程编号id
1.4.8.2.4
busyRate
string
False
遇忙、排队溢出转接队列占用率
1.4.8.2.5
calcOfMaxCallNum
string
False
最大呼叫排队数目计算方法
0:固定值
1:按签入座席比例
1.4.8.2.6
maxCallNum
string
False
比例系数(按签入座席比例)
最大呼叫排队数目(固定值)
1.4.8.2.7
valueOfCondition
string
False
设备占有率或等待时长
1.4.8.2.8
conditionOfBusyTransfer
string
False
忙转条件
0:设备占用率
1:等待时长
1.4.8.3
answerFunction
string
False
业务代表应答方式配置。
0:报工号
2:不报语音
4:自定义报工号
1.4.8.4
timeOut
object
False
排队超时配置
1.4.8.4.1
deviceType
string
False
设备类型。3:IVR;1:技能队列
1.4.8.4.2
transferType
string
False
处理策略。
Release:释放
Transfer:转接
1.4.8.4.3
value
number
False
技能队列时取skillId,IVR时取IVR流程编号id
1.4.8.5
waitVoice
object
False
排队等待配置
1.4.8.5.1
parameterType
string
False
参数类型。
取值范围:
- Voice:表示默认等待音,此时同级其他参数不填
- IVR:IVR,此时同级其他参数必填
1.4.8.5.2
value
string
False
IVR时取accessCode
1.4.8.5.3
id
string
False
IVR时取IVR流程编号id
1.4.8.6
workNoBeforeVoice
object
False
报工号前配置
1.4.8.6.1
value
string
False
报工号前ivr语音id
1.4.8.6.2
deviceDesc
string
False
报工号前语音描述
1.4.8.7
workNoAfterVoice
object
False
报工号后配置
1.4.8.7.1
value
string
False
报工号后ivr语音id
1.4.8.7.2
deviceDesc
string
False
报工号后语音描述
1.4.8.8
keepVoice
object
False
排队等待配置
1.4.8.8.1
parameterType
string
False
等待音类型
CustomVoice:自定义等待音
Voice:默认等待音
1.4.8.8.2
value
string
False
ivr提示音id
- 响应状态码: 401
鉴权失败
- 响应状态码: 404
请求资源不存在
- 响应状态码: 500
服务器内部异常
错误码
无。
报文样例
请求头:
Content-Type:application/json X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
请求参数:
{ "limit": "10", "offset": 0 }
响应参数:
{ "returnCode": "0", "total": 1, "data": [ { "skillId": 1, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "name": "defaultVideoSkill", "mediaTypeId": 19, "description": "2021ok", "maxWaitNum": 100, "skillParam": { "noAgents": { "transferType": "Release" }, "busy": { "transferType": "Release" }, "answerFunction": "0", "timeOut": { "transferType": "Release" }, "waitVoice": { "parameterType": "Voice" } } } ], "description": "success" }