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

握手(扩展)

场景描述

第三方业务客户端调用该接口可向呼叫中心CTI平台发起心跳握手,以维持订阅任务的有效性。当呼叫中心CTI平台五分钟内未检测到心跳,则对订阅任务进行失效,客户端需重新向呼叫中心CTI平台发起订阅请求进行注册。

建议业务客户端每2分钟向呼叫中心CTI平台发起一次心跳。

本握手接口修改为POST方法,携带service_token 头域,其他与握手一致

接口方法

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

接口URI

https://IP:Port/agentgateway/resource/config/subscribe/handshake/{serviceid}

表1 URI携带的参数说明

序号

名称

参数类型

是否必选

说明

1

serverid

string

True

CTI平台已存在的订阅任务的编号,也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。

不能设置为空或空白字符串。

日志中的方法名

handshakeEx

请求消息

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

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

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

    2

    Guid

    string

    True

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

    3

    service_token

    string

    True

    鉴权token,通过订阅生成,例如:3320EA1E5E**********************7112A68E336ED638

    最大长度256。

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

报文样例

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

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