文档首页/ 云客服/ API参考/ CC-Gateway 配置接口参考/ VDN配置接口说明/ IVR流程/ 查询
更新时间：2025-12-01 GMT+08:00
查看PDF
分享

查询

场景描述

调用该接口查询IVR流程。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/vdn/ivrflow?flowIdSet=1,2

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

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

flowIdSet

string

False

IVR流程编号

如果为空，则查询所有的IVR流程标号。可以查询多个，以“,”逗号进行分隔，最多一次可查询500个字符。

日志中的方法名

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

flowId

number

流程编号。

最小值：1；

最大值：1500。

3.2

flowdescription

string

流程描述。

最大长度：50。

3.3

flowaccesscode

string

流程接入码。

最大长度：24；

取值：0123456789*#。

3.4

flowname

string

流程文件名。

最大长度：255。

3.5

flowtype

string

流程启动类型：

取值范围：1、2、3。

默认值：1。

1：非自启动流程；

2：单实例自动启动流程；

3：多实例自动启动流程；

3.6

isLoad

number

是否加载；

默认值：1；

取值说明：0 否；没有IVR加载到该流程；

1 是。有IVR加载到该流程。

3.7

Ivrs

array

加载的IVR，如，[1,2，3,4,5]。

报文样例

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

    无

  • 响应参数 
    {
    "result": [
        {
            "flowaccesscode": "T1",
            "isLoad": 1,
            "flowdescription": "test1",
            "flowname": "IVRplay.gsl",
            "Ivrs": [
                2,
                3
            ],
            "flowId": 1,
            "flowtype": 2
        },
        {
            "flowaccesscode": "10087",
            "isLoad": 0,
            "flowdescription": "test2",
            "flowname": "IVRplay.GSL",
            "Ivrs": [],
            "flowId": 2,
            "flowtype": 1
        }
    ],
    "message": "success",
    "retcode": "0"
}
父主题： IVR流程

相关文档