Help Center/ Meeting/ Server API Reference/ Meeting Event Push/ Meeting-Level Event Push/ APIs/ Pushing Basic Meeting Information
Updated on 2023-12-22 GMT+08:00
View PDF

Pushing Basic Meeting Information

Table 1 Message frame for pushing basic meeting information

Parameter

Type

Description

action

String

"ConfBasicInfoNotify"

version

Long

Message version number, which is identified by the timestamp (in milliseconds) when the message is generated.

createTime

Long

Timestamp when a message is generated, in milliseconds.

msgID

String

Unique message ID.

msgMode

Integer

Message mode. The value is fixed at 0.

0: full message.

confID

String

ID of the subscribed-to meeting.

displayID

String

Meeting display ID. (For a meeting with a random ID, the value of displayID is the same as that of confID. For a meeting with a fixed ID, the value of displayID is the fixed ID.)

title

String

Meeting topic.

startTime

String

Meeting start time (UTC time, in milliseconds).

pwds

Array of ConfPwdInfo objects

Meeting passwords.

recType

Integer

Live broadcast type. The options are as follows:

0: disabled.

1: recording.

2: recording and live broadcast.

3: live broadcast only.

media

Integer

Media type of the meeting. The options are as follows:

1: voice.

2: video.

owner

String

Meeting scheduler.

ownerID

String

UUID of the scheduler.

userType

Integer

Role of the meeting scheduler.

0: system administrator.

1: SP administrator.

2: enterprise member.

3: user registered using a mobile number or email address. They have the same rights as enterprise members.

4: user who uses a temporary account, which has obtained a temporary token using a verification code.

10: enterprise device.

11: anonymous user.

12: smart TV user.

13: IdeaHub.

14: whiteboard (SmartRooms).

supportWatermark

Integer

Whether to enable watermarks on the shared screen.

0: Disable watermarks.

1: Enable watermarks.

scheduledStartTime

String

Start time of a scheduled meeting (UTC time, in milliseconds).

guestJoinUri

String

Link for guests to join the meeting.

callInRestriction

Integer

Participants who can join the meeting.

  • 0: everyone.
  • 2: enterprise users.
  • 3: invited users.

confMode

String

Meeting type.

  • COMMON: common meeting.
  • RTC: RTC meeting.
Table 2 ConfPwdInfo data structure

Parameter

Type

Description

role

String

Meeting role. The options are as follows:

chair: meeting host.

general: common participant.

pwd

String

Password for a participant role, which is in plaintext mode.

Example of Pushing Basic Meeting Information

{
	"displayID": "900487914",
	"title": "Tom's Meeting",
	"startTime": "1611988484164",
	"guestJoinUri": "https://100.95.188.184:443/#/j/900487914/29a3cb420d228e2a507bb40f81c36157f07659389f3bf570",
	"pwds": [{
		"role": "chair",
		"pwd": "677081"
	}, {
		"role": "general",
		"pwd": "385856"
	}],
	"recType": 1,
	"media": 2,
	"owner": "Tom",
	"orgID": "44252",
	"aiRecType": 0,
	"callInRestriction": 0,
	"audienceCallInRestriction": 0,
	"confMode": "COMMON",
	"webinar": false,
	"realTimeSubtitle": 0,
	"bignumMultiPicSwitch": true,
	"partViewSwitch": true,
	"simultaneousInterpretation": 0,
	"supportWatermark": 1,
	"userType": 2,
	"ownerID": "271682cfdbe14fa9ae3a8b25f7502627",
	"scheduledStartTime": "1611988483700",
	"supportCohost": 1,
	"supportClientRecord": 1,
	"inviteShareSwitch": true,
	"confPortalCapabilities": "1",
	"supportWaitingRoom": false,
	"confID": "900487914",
	"msgID": "239fbd1662d111eb980abbd127030a68",
	"msgMode": 0,
	"version": 1611993595029,
	"createTime": 1611993595029,
	"action": "ConfBasicInfoNotify"
}
Parent topic: APIs