更新时间:2025-03-07 GMT+08:00
        
          
          
        
      
      
      
      
      
      
      
      
  
      
      
      
        
座席心跳接口
前置条件
- 座席已签入
 
场景描述
座席签入后,采用事件推送模式时,第三方需要定时调用心跳接口保持会话,建议调用周期为30秒,2分钟内没收到心跳则签出座席。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持GET、PUT和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
| 
        序号  | 
      
        参数名  | 
      
        数据类型  | 
      
        选取原则  | 
      
        说明  | 
     
|---|---|---|---|---|
| 
        1  | 
      
        agentid  | 
      
        string  | 
      
        True  | 
      
        座席的工号,取值范围:101~59999。  | 
     
日志中的方法名
handShake
请求说明
- 消息头 
    
表2 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
静态鉴权(AUTHMODE = 1)签入接口返回的Guid
动态鉴权(AUTHMODE = 2)座席心跳接口返回header中的Guid。
3
service_token
string
False
自定义,最大长度为50,不能包含特殊字符,否则会返回100-001,建议1分钟动态刷新一次。
 
- 消息体
    
无
 
响应说明
| 
        序号  | 
      
        名称  | 
      
        参数类型  | 
      
        说明  | 
     
|---|---|---|---|
| 
        1  | 
      
        message  | 
      
        string  | 
      
        描述  | 
     
| 
        2  | 
      
        retcode  | 
      
        string  | 
      
        错误码。取值如下: 
 详情请参见错误结果码  | 
     
报文样例
- 消息头
    
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 service_token:******************
 - 请求参数
    
无
 - 响应参数
    
{ "message": "success", "retcode": "0" } 
   父主题: 座席操作类接口:onlineagent