Help Center/ Meeting/ Server API Reference/ Meeting Event Push/ Meeting-Level Event Push/ APIs/ Pushing Meeting Status Information
Updated on 2022-07-04 GMT+08:00
View PDF
Share

Pushing Meeting Status Information

Table 1 Message frame for pushing meeting statuses

Parameter

Type

Description

action

String

"ConfDynamicInfoNotify"

version

Long

For a full message, the value is the timestamp (in milliseconds) when the message is generated.

For an incremental message, the value is a sequence number in ascending order.

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.

1: incremental message.

confID

String

ID of the subscribed-to meeting.

endTime

String

Meeting end time (UTC time, in milliseconds).

mode

String

Meeting mode. The options are as follows:

FREE: free mode.

FIXED: broadcasting continuous presence in a fixed screen.

ROLLCALL: giving the floor.

BROADCAST: broadcasting a participant.

state

String

Meeting status. The options are as follows:

Schedule: The meeting is to be held.

Created: The meeting has been created and is in progress.

Destroyed: The meeting has ended.

vas

Integer

Whether voice activation is enabled. The options are as follows:

0: disabled.

1: enabled.

lock

Integer

Meeting locking status. The options are as follows:

0: unlocked.

1: locked.

mute

Integer

Meeting mute status (whether participants are automatically muted after they join the meeting). The options are as follows:

0: unmuted.

1: muted.

lockSharing

Integer

Status of screen sharing locking. The options are as follows:

0: unlocked.

1: locked.

canUnmute

Integer

Whether participants can unmute themselves when all participants in the meeting are muted. The options are as follows:

0: no.

1: yes.

chairView

Integer

Whether participants are displayed to the host in turn. The options are as follows:

0: no.

1: yes.

picNum

String

Number of screens displayed in continuous presence.

partViewNum

Integer

Number of participants that are being focused on.

maxPartViewNum

Integer

Maximum number of participants that can be focused on.

recState

Integer

Recording status. The options are as follows:

0: disabled.

1: enabled.

multiPic

MultiPicInfoNotify object

Custom continuous presence.

confIMGroupId

String

ID of the chat group in the meeting.

forbiddenChat

Integer

Whether chat is disabled in the meeting. The options are as follows:

0: Chat is enabled.

1: Chat is disabled.

recOccurred

Integer

Whether the meeting has already been recorded.

0: no.

1: yes.
Table 2 MultiPicInfoNotify data structure

Parameter

Type

Description

picInfos

Array of PicInfoNotify objects

List of information about a single screen.

picNum

Integer

Number of screens.

period

Integer

Interval of displaying participants in turn.
Table 3 PicInfoNotify data structure

Parameter

Type

Description

index

Integer

Screen index.

id

Array of strings

List of participant IDs in the screen.

share

Integer

0: non-presentation.

1: presentation.

Example of Pushing Meeting Statuses

{
	"state": "Created",
	"endTime": "1611994784164",
	"mode": "FREE",
	"vas": 1,
	"picNum": 16,
	"lock": 0,
	"mute": 1,
	"lockSharing": 0,
	"canUnmute": 1,
	"chairView": 0,
	"recState": 0,
	"aiRecState": 0,
	"enableShareSetting": 1,
	"callInRestriction": 0,
	"audienceCallInRestriction": 0,
	"forbiddenChat": 0,
	"realTimeSubtitle": 0,
	"audienceTotalCount": 0,
	"simultaneousInterpretation": 0,
	"lanChannels": [],
	"allowAudience": false,
	"pause": false,
	"partViewNum": 0,
	"maxPartViewNum": 8,
	"audienceVideoLayout": "speakerVideoLayout",
	"recOccurred": 0,
	"clientRecState": 0,
	"clientRecMode": 0,
	"waitingRoomState": 0,
	"showAudienceMode": 0,
	"audienceCountMultiple": 0,
	"audienceCountReal": 0,
	"confID": "900487914",
	"msgID": "23a1dff762d111eb980a9172a5e3d682",
	"msgMode": 0,
	"version": 1611993595043,
	"createTime": 1611993595043,
	"action": "ConfDynamicInfoNotify"
}
Parent topic: APIs