Maintaining the Heartbeat by an Agent
Prerequisites
The agent has signed in.
Description
When the event push mode is used after an agent signs in, the third-party system needs to periodically invoke the heartbeat interface to maintain the session. The recommended invoking interval is 30 seconds. If no heartbeat message is received within 2 minutes, the agent signs out.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
URI
https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake
In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.
No. |
Parameter |
Data Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|---|
1 |
agentid |
string |
Yes |
Agent ID. The value ranges from 101 to 59999. |
Method Name in Logs
handShake
Request Description
- Message header
Table 2 Parameters in the request message header No.
Parameter
Value Type
Mandatory (Yes/No)
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
GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
3
service_token
string
No
User-defined. The value contains a maximum of 50 characters and cannot contain special characters. Otherwise, 100-001 is returned. It is recommended that the page be dynamically refreshed every minute.
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
message |
string |
Description. |
2 |
retcode |
string |
Error code. The options are as follows:
For details, see Error Codes. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot