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

获取VDN下的所有被叫配置

场景描述

获取VDN下的所有被叫配置。

接口方法

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

请求URL

https://ip:port/rest/cmsapp/v1/openapi/configures/calledconfigs/{ccId}/{vdn}

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

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

{ccId}为呼叫中心ID,取值范围:1~65535,{vdn}为虚拟呼叫中心ID,取值范围:1~5000。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

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

2

Authorization

String

True

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

响应消息

表2 响应消息体参数说明

序号

名称

参数类型

说明

1

result

String

查询结果。取值如下:

  • 0:成功
  • 其他:失败

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

说明:

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

2

resultCode

string

查询结果。取值如下:

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

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

3

resultDatas

array

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

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

说明:

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

4

resultDesc

array

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

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

表3 resultDesc/resultDatas对象参数说明

序号

名称

参数类型

说明

2.1

ccId

int

呼叫中心ID。

2.2

vdnId

int

虚拟呼叫中心ID。

2.3

accessCode

string

接入码。

2.4

subCode

string

后续接入码。

最大长度:100。

取值:0123456789*#。

2.5

deviceType

string

设备类型,请参见表1

返回值的类型为四字节整数。

2.6

deviceName

string

设备名称。

  • 当设备类型为1表示技能队列时,设备名称为技能队列名称。
  • 当设备类型为3表示IVR自动流程时,设备名称为流程描述。

2.7

deviceNo

string

设备编号。

2.8

dnid

string

配置编号。

样例报文

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

    无。

  • 响应参数:
    {
        "result": "0",
        "resultCode": "0100000",
        "resultDatas": [
            {
                "ccId": 1,
                "vdnId": 1,
                "accessCode": "6045",
                "subCode": "1110",
                "deviceType": "1",
                "deviceName": "test",
                "deviceNo": "22",
                "dnid": "22"
            }
        ],
        "resultDesc": [
            {
                "ccId": 1,
                "vdnId": 1,
                "accessCode": "6045",
                "subCode": "1110",
                "deviceType": "1",
                "deviceName": "test",
                "deviceNo": "22",
                "dnid": "22"
            }
        ]
    }