握手
场景描述
第三方业务客户端调用该接口可向呼叫中心CTI平台发起心跳握手,以维持订阅任务的有效性。当呼叫中心CTI平台五分钟内未检测到心跳,则对订阅任务进行失效,客户端需重新向呼叫中心CTI平台发起订阅请求进行注册。
建议业务客户端每2分钟向呼叫中心CTI平台发起一次心跳。
接口方法
该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://IP:Port/agentgateway/resource/config/subscribe/handshake/{serviceid}
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|
serverid |
string |
True |
CTI平台已存在的订阅任务的编号,也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。 |
日志中的方法名
handshake
请求消息
- 消息头
表2 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
响应消息
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
返回消息 |
2 |
retcode |
string |
操作的结果原因码。 取值类型为整数。
|