更新时间:2023-09-27 GMT+08:00

设置呼叫随路数据(扩展)

前置条件

  • 座席已签入。
  • 当前在通话中。

场景描述

座席签入通话后,设置呼叫随路数据。

接口方法

设置成“PUT”。该接口仅支持PUT方法,不支持POST、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/calldata/{agentid}/setcalldataex

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

座席的工号,取值范围:101~59999。

日志中的方法名

setCallAppDataEx

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    callid

    string

    False

    呼叫ID。

    2

    calldata

    string

    False

    随路数据。原始内容最大长度支持16K字节。

    说明:

    该信息采用AES128-CBC加密存储,采用TLS1.2加密通道传输。

    该字段为敏感数据,日志中只使用calldatalength表示该字段长度。

    3

    isDataEncoded

    boolean

    False

    呼叫数据是否经过base64编码,取值如下:

    • true:calldata必须是经过base64编码后的字符。
    • false:calldata未经过base64编码。

    默认值为false。

    说明:

    Base64是一种编码方式,不是加密算法,不能用作任何敏感信息的加密用途。

响应说明

表4 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

object

预留字段

触发事件

错误结果码

  • 000-002
  • 100-006
  • 100-007
  • 400-001

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数
    {
        "callid": "1456229294-1191",
        "calldata": "1233",
        "isDataEncoded": "true"
    }
  • 响应参数
    {
      "result": {},
      "message": "success",
      "retcode": "0"
    }