Handshake (Extended)

Updated on 2023-09-27 GMT+08:00

View PDF

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}

**Table 1** Parameter in the URI
No.	Parameter	Value Type	Mandatory	Description
1	serverid	string	Yes	ID of an existing subscription task on the CTI platform, that is, subscription task ID returned by the CTI platform to a third-party business client upon successful subscription. This parameter cannot be left empty or set to null.

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

**Table 3** Parameters in the message body
No.	Parameter	Value Type	Description
1	message	string	Returned message.
2	retcode	string	Result cause code. The value is an integer. 0: success Others: failure. For details, see Error Code Definition.

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"
}

Parent topic: Voice Recognition Result Subscription Interfaces

Previous topic: Handshake

Next topic: Recognition Result Notification

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot