Using WebSocket Heartbeats

Description

This API is used to keep the established WebSocket message stream alive. If the meeting server does not receive a heartbeat request within 180 seconds, it closes the WebSocket connection. It is recommended that a heartbeat request be sent every minute.

**Table 1** WebSocket heartbeat request
Parameter	Type	Description
action	String	"HeartBeat"
sequence	String	Timestamp when a message is generated, in milliseconds.

Example WebSocket Heartbeat Request

{
	"sequence": "000000000000000001611993655770",
	"action": "HeartBeat"
}

**Table 2** WebSocket heartbeat response parameters
Parameter	Type	Description
action	String	"HeartBeat"
sequence	String	Timestamp when a message is generated, in milliseconds. The value is the same as sequence in the heartbeat request.

Example WebSocket Heartbeat Response

{
	"sequence": "000000000000000001611993655770",
	"action": "HeartBeat"
}

Parent topic: APIs

Previous topic: Pushing Live Captions

Next topic: Enterprise-Level Meeting Event Push

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