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

查询呼叫随路数据

前置条件

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

场景描述

座席签入后,查询呼叫随路数据。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/calldata/{agentid}/appdata?isEncodeResult={isEncodeResult}&callId={callId}

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

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

2

isEncodeResult

boolean

False

查询到的呼叫数据是否经过base64编码。取值范围:

  • true:查询到的呼叫数据经过了base64编码
  • false:查询到的呼叫数据没有经过base64编码

true以外的参数都作为false处理。

说明:

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

3

callid

string

False

被查询呼叫ID。多媒体会话时为必传。

日志中的方法名

queryCallAppData

请求说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

  • 消息体

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下:

0:成功

非0:失败

3

result

string

查询成功后,返回随路数据

查询失败后,不返回该项

触发事件

错误结果码

  • 100-006
  • 100-007

报文样例

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

  • 响应参数
    {
        "message": "",
        "retcode": "0",
        "result": "1234"
    }