Handshake (Extended)

Description

This interface is used by a third-party client to send heartbeat messages to the CTI platform of the call center to remain the validity of a subscription task. If the CTI platform of the call center does not detect any heartbeat message within five minutes, it invalids the subscription task. Then the client needs to send a subscription request to the CTI platform of the call center again.

It is recommended that a third-party business client send a heartbeat message to the CTI platform of the call center every two minutes.

The handshake interface contains the service_token header field and is changed to support the POST method. Other information is the same as that in the handshake.

Interface Method

This interface supports only the POST method.

URI

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

Method Name in Logs

handshakeEx

Request Message

• Message header

  Table 2 Parameters in the message header

  No.	Parameter	Value Type	Mandatory	Description
  1	Content-Type	string	Yes	Coding mode of the message body. The default value is application/json; charset=UTF-8.
  2	Guid	string	Yes	The value of Guid is that returned through the interface in C5 Intelligent Auxiliary Interface Authentication.
  3	service_token	string	Yes	Authentication token, which is generated in Subscription, for example, 3320EA1E5E**********************7112A68E336ED638. The value contains a maximum of 256 characters.

Response Message

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  None

• Response parameter

  {
      "message": "success",
      "retcode": "0"
  }