Help Center/ Meeting/ Server API Reference/ Meeting Event Push/ Meeting-Level Event Push/ APIs/ Pushing Online Participant Information
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Pushing Online Participant Information

Table 1 Message frame for pushing online participant information

Parameter

Type

Description

action

String

"ParticipantsNotify"

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.

data

Array of ParticipantNotifyDTO objects

List of online participants.
Table 2 ParticipantNotifyDTO data structure

Parameter

Type

Description

pid

String

Participant ID.

mode

Integer

0: Refresh the participant information.

1: Remove the participant.

pinfoMap

Map<String,String>

Keys and values of variables in the participant information.
Table 3 Description of the keys and values of pinfoMap

Key

Value Type

Description

NAME

String

Participant name or alias. The value can contain up to 96 characters.

TEL

String

Participant ID.

ROLE

String

Participant roles. Enumerated values:

1: meeting host.

0: common participant.

2: attendee.

STATE

String

Participant status. Enumerated values:

0: The participant is in the meeting.

1: The participant is being called.

HAND

String

Hand raising status of the participant. Values:

1: Hand raised.

0: Hand lowered.

BROADCAST

String

Broadcast status of the participant. Values:

0: The participant is not being broadcast.

1: The participant is being broadcast.

ROLLCALL

String

Floor-giving status of the participant. Values:

0: The participant is not given the floor.

1: The participant is given the floor.

SHARE

String

Data sharing status of the participant. Values:

0: The participant is not sharing a screen.

1: The participant is sharing a screen.

ADDTIME

String

Time when the participant joins the meeting (UTC time, in milliseconds).

MUTE

String

Whether the participant is muted. The options are as follows:

0: no.

1: yes

VIDEO

String

Whether the participant is a video site. Values:

1: yes.

0: no.

M

String

M number of the participant.

T

String

T number of the participant.

ANONYMOUS

String

0: common participant.

1: anonymous participant.

LOCALREC

String

0: The participant does not record the meeting locally.

1: The participant is recording the meeting locally.

CLICENT_LOGIN_TYPE

String

Terminal type.

Desktop: PC.

Mobile: mobile phone.

Pad: tablet.

OtherType: other.

VIEW_TYPE

String

Focusing mode.

0: The participant does not focus on any screen.

1: The participant views continuous presence.

2: The participant focuses on the screen of a participant.

NOTE:
  • To push the continuous presence to the host, set this parameter to 1 for the host. To cancel the push for the host, set this parameter to 0.
  • To push the video of participant B to participant A, set this parameter to 2 for participant A. To cancel the push for participant A, set this parameter to 0.
  • To push the continuous presence to participant A, set this parameter to 1 for the participant. To cancel the push for participant A, set this parameter to 0.

If the meeting does not involve the preceding functions, leave this parameter blank for the participant.

PART_VIEW_SRC

String

ID of the participant being focused on.

NOTE:

To push the video of participant B to participant A, set this parameter to the participant ID of participant B. To cancel the push for participant A, leave this parameter blank.

If the meeting does not involve the preceding functions, leave this parameter blank.

IS_SVC

String

Whether the participant is an SVC site.

0: AVC site.

1: SVC site.

ORG_ID

String

Enterprise ID.

CLIENT_CAPABILITIES

String

Terminal capability set, which is transparently transmitted to each terminal and the Management Platform through the online participant list. This parameter is carried when capabilities are supported. Multiple capabilities are separated by commas (,). The value contains up to 1024 characters.

1: co-host.

2: screen sharing invitation.

3: role switch between panelists and attendees.

4: waiting room.

5: invitation to unmute the microphone.

6: invitation to enable the camera.

ACCOUNT_ID

String

Participant UUID.

ACCOUNT

String

Participant account.

THIRDACCOUNT

String

Third-party account.

Example of Pushing Online Participant Information

{
	"data": [{
		"pid": "uzr571a9brwu11cvcibvru5a7r7rryiy",
		"mode": 0,
		"pinfoMap": {
			"CAMERASTATE": "1",
			"ORG_ID": "44252",
			"LOCKED_VIEW": "0",
			"MUTE": "1",
			"ACCOUNT_ID": "271682cfdbe14fa9ae3a8b25f7502627",
			"LOCALREC": "0",
			"TEL": "+86571299676493248",
			"ALLOW_CLIENT_REC": "0",
			"STATE": "0",
			"SHARE": "0",
			"ANONYMOUS": "0",
			"ADDTIME": "1611988486336",
			"NAME": "Tom",
			"CLIENT_REC_STATE": "0",
			"CLIENT_CAPABILITIES": "1,3",
			"ROLE_SWITCH_OVER": "0",
			"RTC_USER_ID": "uzr571a9brwu11cvcibvru5a7r7rryiy",
			"CLIENT_LOGIN_TYPE": "Desktop",
			"T": "1",
			"ACCOUNT": "zhangsan",
			"BROADCAST": "0",
			"IS_COHOST": "0",
			"HAND": "0",
			"IS_SVC": "1",
			"ROLLCALL": "0",
			"M": "1",
			"VIDEO": "1",
			"ROLE": "1",
			"THIRDACCOUNT": "zhangsan",
			"INVITE_SHARE_STATE": "0"
		}
	}],
	"confID": "900487914",
	"msgID": "23a429e862d111eb980a11b5be5aab3c",
	"msgMode": 0,
	"version": 1611993595058,
	"createTime": 1611993595058,
	"action": "ParticipantsNotify"
}
Parent topic: APIs