Subscribing to Messages
Subscription Message Frame
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
conferenceID |
Yes |
String |
Meeting ID. |
subscribeType |
Yes |
Array of strings |
Subscription type. The options are as follows: ConfBasicInfoNotify: subscribing to basic meeting information. ConfDynamicInfoNotify: subscribing to meeting status information. ParticipantsNotify: subscribing to online participant information. AttendeesNotify: subscribing to information of participants invited during meeting scheduling. SpeakerChangeNotify: subscribing to speaker status information. NetConditionNotify: subscribing to meeting media quality statuses. InviteResultNotify: subscribing to invitation results. RealTimeSubtitleNotify: subscribing to live captions. WaitingListNotify: subscribing to the list of waiting room members. |
confToken |
Yes |
String |
Subscription Message Example
{ "action": "Subscribe", "sequence": "000000000000000002611382271289", "data": "{\"subscribeType\":[\"ConfBasicInfoNotify\",\"ConfDynamicInfoNotify\",\"ParticipantsNotify\",\"AttendeesNotify\",\"SpeakerChangeNotify\",\"NetConditionNotify\",\"InviteResultNotify\"],\"confToken\":\"Basic Y25yYWJkZmQ5YjJjYmM2NmMyNDMzMzlhOTNhYjg0ODM3OWJmOTMyNTdlYTE2ZTg0MGRj\"}" }
Successful Subscription Example
{ "action": "Subscribe", "sequence": "000000000000000001611747313677", "data": { "returnCode": 0, "returnDesc ": "SUCCESS" } }
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