更新时间:2025-12-01 GMT+08:00
分享

查询

场景描述

调用该接口查询IVR。

接口方法

该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/config/sys/ivr?ids=5,4

其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。

URI中携带的参数说明如表1所示。

表1 URI携带参数说明

序号

名称

参数类型

是否必选

说明

1

ids

string

False

需要查询的IVR编号。

为空时,表示查询所有班组的数据。

取值类型为整数,根据实际的班组编号填写。每个id用“,”分割,一次最多不超过100个。

日志中的方法名

queryIVR

请求消息

  • 消息头
    表2 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

    2

    Guid

    string

    True

    Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

array

返回结果。该对象参数说明请参见表4

表4 result参数说明

序号

名称

参数类型

说明

3.1

ivrId

number

IVR进程编号

3.2

serverIp

string

服务器IPV4地址

3.3

maxCallNum

number

最大并发呼叫数

3.4

supportVxml

number

是否支持VoiceXML

IVR取值范围如下

  • 0:否
  • 1:是

CCIVR取值为2

3.5

checkTime

number

流程检测时间,单位:秒

3.6

progId

number

进程ID

3.7

poolNodeId

number

CTI节点(只在CTI POOL模式下可选,Single模式下不可选。)

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

  • 响应参数
    {
        "result": [
            {
                "ivrId": 101,
                "serverIp": "10.0.0.1",
                "supportVxml": 1,
                "progId": 2501,
                "maxCallNum": 300,
                "checkTime": 0
            }
        ],
        "retcode": "0"
    }

相关文档