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

增加

场景描述

调用该接口增加IVR流程。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/vdn/ivrflow?flowId=7

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

表1 URI携带的参数说明

序号

名称

参数类型

是否必选

说明

1

flowId

number

False

IVR流程ID编号。

取值的类型为整数,取值范围:1-1500。

如果为空,则返回1个。

日志中的方法名

addIvr

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

  • 消息体
    表3 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    description

    string

    True

    流程描述。

    最大长度:50。

    2

    accessCode

    string

    True

    流程接入码;

    最大长度:24;

    取值:0123456789*#。

    3

    flowFileName

    string

    True

    流程文件名。

    最大长度:255。

    4

    flowType

    number

    False

    流程启动类型:

    取值范围:1、2、3。

    默认值:1。

    1:非自启动流程;

    2:单实例自动启动流程;

    3:多实例自动启动流程;

    5

    maxCallNum

    number

    False

    流程最大并发呼叫数。

    默认值为0。

    最小值:0;

    最大值:65535。

    6

    selfBootFeq

    number

    False

    自启动时间间隔。

    说明:当流程启动类型为非自启动或单实例自启动时,取值无效,值为0,保持不变。

    当流程启动类型为多实例自动启动时

    默认值:30,

    最小值:0,

    最大值:10000。

    7

    isLoad

    number

    False

    是否加载;

    取值范围:0、1;

    默认值:1;

    取值说明:0 否;没有IVR加载到该流程;

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

    加载到IVR的流程数最多只支持500个

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

结果内容。该对象参数说明请参见表5

表5 Result结果参数说明

序号

名称

参数类型

说明

3.1

flowId

number

流程ID。

最小值:1;

最大值:1500。

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "description": "ivr7",
        "accessCode": 1007,
        "flowFileName": "IVR7",
        "flowType": 1,
        "maxCallNum": 2,
        "selfBootFeq": 0,
        "isLoad": 1
    }
  • 响应参数
    {
        "result": {
            "flowId": 7
        },
        "message": "success",
        "retcode": "0"
    }

相关文档