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

增加

场景描述

调用该接口增加接入码。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/sys/accesscode?acId=3

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

acId

number

False

接入码的编号。

取值的类型为整数,取值范围为1~10000。

说明:

如果不填,系统会自动分配。

日志中的方法名

addAccessCode

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    accessCode

    string

    True

    系统接入码。

    取值:0123456789*#。

    不能以000开头,最大长度24。

    2

    codeDescription

    string

    True

    系统接入码描述。

    最大长度为100个字符。

    3

    mediatypeId

    number

    True

    媒体类型编号。取值范围:

    • 1:文字交谈
    • 2:点击通话
    • 4:回呼请求
    • 5:普通呼叫
    • 6:电子邮件
    • 7:传真呼叫
    • 14:OPS呼叫
    • 15:预测呼出
    • 16:预浏览呼出
    • 17:消息呼叫
    • 20:留言呼叫
    • 51:Web Chat
    • 52:SMS Chat
    • 53:Social Chat
    • 54:Fax Chat
    • 55:H5 Video

响应消息

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

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

表5 result对象

序号

名称

参数类型

说明

1

acId

number

增加接入码的编号。

范围1-10000。

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "accessCode": "1231",
        "codeDescription": "accessCode",
        "mediatypeId": 2
    }
  • 响应参数
    {
        "result": {
            "acId": 28
        },
        "message": "success",
        "retcode": "0"
    }

相关文档