Updated on 2023-12-22 GMT+08:00

APIs

Parameters in a request body are as follows.

Table 1 Request message data structure

Parameter

Type

Description

appID

String

Subscriber ID in the configuration under the Meeting Event Push tab.

timestamp

Integer

Message timestamp, in milliseconds.

nonce

String

Random string.

signature

String

Message body signature generated using hmacSHA256(appID + timestamp + nonce + eventInfo, appkey), in which appkey indicates the password in the configuration under the Meeting Event Push tab. Enterprise developers can verify data integrity using the signature.

eventInfo in the signature algorithm is a JSON character string converted from the event information object.

eventInfo

EventInfo

Event information.

Table 2 EventInfo data structure

Parameter

Type

Description

event

String

Event type. Values:

  • meeting.verify: event of verifying configuration enabling.
  • meeting.started: meeting start event.
  • meeting.end: meeting end event.
  • meeting.conclude: meeting close event.
  • record.finish: recording end event.

timestamp

Integer

Event timestamp, in milliseconds.

payload

Payload

Event content.

Table 3 Payload data structure

Parameter

Type

Description

meetingInfo

MeetingInfo

Event content.

Table 4 MeetingInfo data structure

Parameter

Type

Description

meetingID

String

Meeting ID.

meetingUUID

String

Meeting UUID.

meetingCycleSubID

String

Recurring meeting UUID.

Parameters in the response body are as follows.

Table 5 Response message data structure

Parameter

Type

Description

event

String

Event type. In the response of verifying configuration enabling, the value is meeting.verify.

nonce

String

In the response of verifying configuration enabling, the value is the nonce value obtained from the request.