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

Pushing Information of Participants Invited During Meeting Scheduling

Table 1 Message frame for pushing information of participants invited during meeting scheduling

Parameter

Type

Description

action

String

"AttendeesNotify"

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.

0: full message.

1: incremental message.

confID

String

ID of the subscribed-to meeting.

data

Array of AttendeeNotifyDTO objects

Information about all participants invited during meeting scheduling.
Table 2 AttendeeNotifyDTO data structure

Parameter

Type

Description

userUUID

String

Participant UUID.

participantID

String

Participant ID.

mode

Integer

0: Refresh the participant information.

1: Remove the participant.

phone

String

Called number.

name

String

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

accountId

String

Participant account, which is optional.

role

Integer

Participant role in the meeting.

0: common participant.

1: meeting host.

email

String

Email address, which contains up to 255 characters.

sms

String

Mobile number for receiving SMS notifications. The value contains up to 32 characters.

isMute

Integer

Whether to mute participants automatically when they join the meeting.

0: no.

1: yes.

isAutoInvite

Integer

Whether to automatically invite participants when the meeting starts. The default value is defined in the enterprise-level configuration.

0: Do not automatically invite participants.

1: Automatically invite participants.

type

String

Number type.

normal: voice, HD video, and SD video participant address (default).

terminal: meeting room or hard terminal.

outside: external participant.

anonymous: anonymous participant.

telepresence: uni-screen or tri-screen telepresence participant address.

mobile: mobile number.

telephone: fixed-line number.

customnumber: SIP number of an external participant.

board: Board.

address

String

Hard terminal meeting room information.

deptUUID

String

Department UUID, which contains up to 64 characters.

deptName

String

Department name, which contains up to 128 characters.

orgId

String

Enterprise ID.

thirdAccount

String

Third-party account.

Example of Pushing Information of Participants Invited During Meeting Scheduling

{
	"data": [{
		"mode": 0,
		"orgID": "44252",
		"thirdAccount": "zhangsan",
		"phone": "+86571********",
		"accountId": "zhangsan",
		"userUUID": "271682cfdbe14fa9ae3a8b25f7502627",
		"name": "Tom",
		"role": 1,
		"isMute": 0,
		"isAutoInvite": 0,
		"type": "normal",
		"deptUUID": "ff808081689de0d901689df549fe0009",
		"deptName": "department2",
		"hidePhone": false,
		"isNotOverlayPidName": false
	}],
	"confID": "900487914",
	"msgID": "23a450f962d111eb980aa1747c1cf8f9",
	"msgMode": 0,
	"version": 1611993595059,
	"createTime": 1611993595059,
	"action": "AttendeesNotify"
}
Parent topic: APIs