Updated on 2022-07-04 GMT+08:00

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