更新时间:2023-12-19 GMT+08:00

依据VDNId查询所有座席信息

场景描述

依据VDNId查询所有座席信息。(VDN:虚拟呼叫中心,一个租户创建配置完毕后即对应一个虚拟呼叫中心)

接口方法

设置成“GET”。该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。

内部封装接口

BMS接口:/ccbms/ws/monitor/siteagentcallandskillinfobyagentids

请求URL

https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn}/{offset}/{limit}

其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。

{ccId}为呼叫中心ID,取值范围:1~65535,{vdn}为虚拟呼叫中心ID,取值范围:1~5000,{offset}为查询起始偏移量,非必填,{limit}表示每页的查询数量,最大100,非必填,{offset}和{limit}需同时传递才生效。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

响应消息

表2 响应消息体参数说明

参数名

数据类型

说明

result

String

查询结果。取值如下:

  • 0:成功
  • 其他:失败

失败的原因说明请参见错误码参考

说明:

当前字段为兼容8.13及其之前版本接口响应参数使用。

resultCode

string

查询结果。取值如下:

  • "0100000":成功
  • 其他:失败

失败的原因说明请参见错误码参考

count

int

座席总数,请求中{offset}和{limit}生效才会返回。

resultDatas

array

查询成功后,返回结果信息的对象数组。

该数组中对象的参数说明请参见表3

说明:

当前字段为兼容8.13及其之前版本接口响应参数使用。

resultDesc

array

查询成功后,返回结果信息的对象数组。

该数组中对象的参数说明请参见表3

表3 resultDesc/resultDatas对象参数说明

参数名

数据类型

说明

agentNo

string

座席工号。

agentName

string

座席名称。

roleId

string

座席角色。

skillId

string

技能ID集合,多个技能ID之间以";"进行分割。例如1;3;10;11;25;31;32;40

样例报文

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数

    无。

  • 响应参数:
    {
        "result": "0",
        "resultCode": "0100000",
        "count": 101,
        "resultDatas": [
            {
                "agentNo": "10000",
                "agentName": "z1",
                "roleId": "1",
                "skillId": ""
            },
            {
                "agentNo": "101",
                "agentName": "z2",
                "roleId": "1",
                "skillId": "2;3"
            }
        ],
        "resultDesc": [
            {
                "agentNo": "10000",
                "agentName": "z1",
                "roleId": "1",
                "skillId": ""
            },
            {
                "agentNo": "101",
                "agentName": "z2",
                "roleId": "1",
                "skillId": "2;3"
            }
        ]
    }