Updated on 2025-02-10 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.
  • meeting.create: reservation event.
  • meeting.modify: modification event.
  • meeting.cancel: cancelation event.
  • meeting.join: meeting joining event.
  • meeting.left: meeting leaving event.

timestamp

Integer

Event timestamp, in milliseconds.

payload

Payload

Event content.

Table 3 Payload data structure

Parameter

Type

Description

meetingInfo

MeetingInfo

Event content.

attendeeInfo

AttendeeInfo

Participant details.

Table 4 MeetingInfo data structure

Parameter

Type

Description

meetingID

String

Meeting ID.

meetingUUID

String

Meeting UUID.

meetingCycleSubID

String

Recurring meeting UUID.

Table 5 AttendeeInfo data structure

Parameter

Type

Description

userUUID

String

User UUID.

userAgent

String

User client type.

account

String

Account.

participantID

String

Participant ID.

displayName

String

Display name.

joinTime

Integer

Timestamp when the participant joined the meeting, in milliseconds.

leftTime

Integer

Timestamp when the participant left the meeting, in milliseconds.

role

String

Role in the meeting.

callNumber

String

Called number.

Parameters in the response body are as follows.

Table 6 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.