查询
场景描述
调用该接口查询座席。
接口方法
该接口仅支持GET方法。
接口URI
https://ip:port/agentgateway/resource/config/vdn/agents?agentIdSet=103,102
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
|
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
|---|---|---|---|---|
|
1 |
agentIdSet |
string |
False |
需要查询的座席编号。 多个以英文逗号分隔,根据实际的座席工号填写,一次最多不超过100个座席。 |
日志中的方法名
queryAgent
请求消息
- 消息头
表2 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
响应消息
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
1 |
message |
string |
描述 |
|
2 |
retcode |
string |
错误码。取值如下:
|
|
3 |
result |
array |
查询座席结果信息的对象数组,如表4所示。 |
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
3.1 |
agentId |
number |
座席工号 |
|
3.2 |
name |
string |
业务代表名。 最大长度为20字节,不含特殊字符。 |
|
3.3 |
agentPwd |
string |
座席密码。 |
|
3.4 |
fullName |
string |
业务代表全名 |
|
3.5 |
socialChatNum |
number |
座席并发多媒体呼叫数。取值类型为整数。 |
|
3.6 |
timeRemaining |
string |
密码剩余过期时间。 空字符串则表示坐席密码永不过期。取值范围为0~180(天)。
说明:
空字符串有安全风险,请谨慎使用,建议设置取值范围内的值,保证定期修改密码。 |
|
3.7 |
userClassId |
number |
角色编号。 取值类型为整数,根据实际的角色编号填写。 |
|
3.8 |
asrInd |
number |
是否开启智能识别。 取值类型为整数,取值如下:
|
|
3.9 |
enableDualChannelRec |
number |
是否开启双声道录音。 0:不开启 1:开启 默认值为0。 须知: “开启双声道录音”和“开启智能识别”不能同时打开,双声道录音和座席智能识别互斥,即在开启双声道录音,则不能开启智能识别,在开启智能识别时,不能开启双声道录音。 |
|
3.10 |
skills |
array |
技能信息。目前没有按照技能组配置。 取值类型为整数数组。该对象的参数说明请参见表5。 |
|
3.11 |
h5VideoNum |
number |
H5 视频呼叫最大呼叫数,默认为0,表示不生效。 输入范围 0-1 |
|
3.12 |
validTime |
int |
密码过期时间,单位天,默认值 90,值域范围:0~180,0表示永不失效。
说明:
永不失效有安全风险,请谨慎使用,建议设置取值范围内的值,保证定期修改密码。 |
|
3.13 |
skillGroupIds |
array |
座席具备的技能组信息,取值类型为整数数组。 |
|
3.14 |
mediaChanTotalCallNum |
number |
VDN级座席多媒体全渠道总并发数 取值范围:[0,60] 0表示不限制全渠道总并发数 |
|
3.15 |
mmConcurrentCallNum |
array |
座席并发处理多媒体呼叫数, 为空则不按照媒体类型设置,兼容老数据。 如果传值,则原座席多媒体并发数(socialChatNum)字段失效。 字段说明如表6所示。 |
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
3.10.1 |
skillId |
number |
技能编号。 取值类型为整数,根据实际的技能编号填写。 |
|
3.10.2 |
skillPower |
number |
技能权值。 取值类型为整数,取值范围为1~100。 |
|
3.10.3 |
agentPower |
number |
座席权值。 取值类型为整数,取值范围为1~300。 |
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
12.1 |
chnType |
number |
媒体类型。其中: 50:多媒体Email 51:多媒体Web Chat 52:多媒体SMS 53:Social Chat 56:多媒体Wechat 57:多媒体Facebook 58:多媒体Twitter 59:多媒体5G 60:多媒体Line 61:多媒体WhatsApp 62:多媒体Instagram 63:多媒体Telegram |
|
12.2 |
mmCallNum |
number |
座席最大会话数,取值范围:[-1,60],其中: 默认0表示使用vdn配置 -1表示无并发数 |
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
- 响应参数
{ "message": "success", "retcode": "0", "result": [ { "agentId": 102, "name": "agent", "agentPwd": "****", "userClassId": 2, "asrInd": 0, "skills": [], "fullName": "", "socialChatNum": 0, "timeRemaining": "", "enableDualChannelRec": 0, "h5VideoNum": 0, "validTime": 180, "skillGroupIds": [], "mmConcurrentCallNums": [ { "chnType": 50, "mmCallNum": -1 }, { "chnType": 51, "mmCallNum": -1 }, { "chnType": 52, "mmCallNum": 0 }, { "chnType": 53, "mmCallNum": 0 }, { "chnType": 54, "mmCallNum": 2 }, { "chnType": 55, "mmCallNum": 0 }, { "chnType": 56, "mmCallNum": 0 }, { "chnType": 57, "mmCallNum": 0 }, { "chnType": 58, "mmCallNum": 0 }, { "chnType": 59, "mmCallNum": 0 }, { "chnType": 60, "mmCallNum": 0 }, { "chnType": 61, "mmCallNum": 0 }, { "chnType": 62, "mmCallNum": 0 }, { "chnType": 63, "mmCallNum": 0 }, { "chnType": 64, "mmCallNum": 0 }, { "chnType": 65, "mmCallNum": 0 } ], "mediaChanTotalCallNum": 3 } ] }