Help Center/ Meeting/ Server API Reference/ Meeting Event Push/ Meeting-Level Event Push/ APIs/ Subscribing to Messages
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Subscribing to Messages

Subscription Message Frame

Table 1 Message frame for subscribing to information

Parameter

Mandatory

Type

Description

action

Yes

String

"Subscribe"

sequence

Yes

String

Random sequence number of a message. The recommended length is 20 to 30.

data

Yes

SubscribeData object

Subscription data.
Table 2 SubscribeData data structure

Parameter

Mandatory

Type

Description

conferenceID

Yes

String

Meeting ID.

subscribeType

Yes

Array of strings

Subscription type. The options are as follows:

ConfBasicInfoNotify: basic meeting information.

ConfDynamicInfoNotify: meeting status.

ParticipantsNotify: online participant information.

AttendeesNotify: information of participants invited during meeting scheduling.

SpeakerChangeNotify: speaker status.

InviteResultNotify: invitation results.

RealTimeSubtitleNotify: live captions.

WaitingListNotify: list of waiting room members.

InterpreterGroupNotify: interpreter group information.

confToken

Yes

String

Meeting control token.

Subscription Message Example

{
	"sequence": "000000000000000001702459164879",
	"action": "Subscribe",
	"data": "{\"subscribeType\":[\"ConfBasicInfoNotify\",\"ConfDynamicInfoNotify\",\"ParticipantsNotify\",\"AttendeesNotify\",\"SpeakerChangeNotify\",\"CustomMultiPicNotify\",\"InviteResultNotify\",\"InterpreterGroupNotify\",\"NetworkQualityNotify\",\"WaitingListNotify\"],\"confToken\":\"Basic c3RiZjYyMjZlZWU4YjQ4YjllNThmNGRkYWYzMGVlMWE5YzdlZjJhZTU4ZTkzMDI0MzRh\"}"
}

Successful Subscription Example

{
	"action": "Subscribe",
	"sequence": "000000000000000001611747313677",
	"data": {
		"returnCode": 0,
		"returnDesc ": "SUCCESS"
	}
}
Parent topic: APIs