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

增加

场景描述

调用该接口增加IVR服务进程。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/sys/ivr?ivrId=3

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

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

ivrId

number

False

IVR的编号。不携带时,自动分配一个。

取值的类型为整数,取值范围为1~70,100~299。

日志中的方法名

addIVR

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    serverIp

    string

    True

    服务器IPV4地址。

    最大长度16。

    2

    maxCallNum

    number

    False

    最大并发呼叫数。

    3

    checkTime

    number

    False

    流程检测时间,单位:秒。

    4

    poolNodeId

    number

    False

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

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

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

表5 result对象

序号

名称

参数类型

说明

3.1

ivrId

number

IVR编号

3.2

serverIp

string

服务器IPV4地址

3.3

maxCallNum

number

最大并发呼叫数

3.4

checkTime

number

流程检测时间,单位:秒

3.5

progId

number

进程ID

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "serverIp": "10.0.0.1",
        "maxCallNum": 300
    }
  • 响应参数
    {
        "result": {
            "progId": 303,
            "ivrId": 3
        },
        "message": "success",
        "retcode": "0"
    }

相关文档