Updated on 2024-07-30 GMT+08:00

Obtaining the Participant List

Function

This API is used to obtain the participant list in a meeting. Call this API only when you are in a meeting.

Function Prototype

getAttendeeList(onGetAttendeeListResult?: (ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void): voidgetAttendeeList(onGetAttendeeListResult?: (ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
onGetAttendeeListResult Yes (ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void Callback of obtaining the participant list.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, attendeeList: AttendeeListInfo) => void

Table 2 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
attendeeList AttendeeListInfo Participant list.
Table 3 AttendeeListInfo
Parameter Type Description
numOfAttendee number Number of participants in the list.
attendees AttendeeInfo Basic participant information.
Table 4 AttendeeInfo
Parameter Type Description
baseInfo AttendeeBaseInfo Basic participant information.
isSelf boolean Whether you are the participant.
state ConfAttendeeState Participant status.
isAnonymous boolean Whether the participant joins the meeting anonymously.
corpId string Enterprise ID, which is used to identify whether the participant belongs to the enterprise.
Table 5 AttendeeBaseInfo
Parameter Type Description
nickName string Participant name.
number string Number. If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the Huawei Cloud Meeting app is called. If this parameter is set to a PSTN number (for example, 18700000000), the number is called through the VoIP gateway if the enterprise has enabled PSTN call. This parameter is used for account and password authentication. Either this parameter or thirdUserId must be set.
thirdUserId string Third-party user ID. This parameter is used for app ID authentication. Either this parameter or number must be set.
accountId string Huawei Cloud Meeting account.
email string Email address used for receiving email notifications.
sms string Mobile number used for receiving SMS notifications.
isAutoInvite boolean Whether to automatically invite participants.
isMute boolean Whether to mute the microphone.
role ConfRole Participant role in the meeting.
type AttendeeType Participant type.
userUuid string Participant UUID.
Table 6 Enumerated values of ConfRole
Enumeration Name Enumerated Value Description
HWM_CONF_ROLE_ATTENDEE 0 Common participant.
HWM_CONF_ROLE_HOST 1 Host.
HWM_CONF_ROLE_AUDIENCE 2 Attendee.
HWM_CONF_ROLE_COHOST 3 Co-host.
HWM_CONF_ROLE_WAITING 4 Waiting room member.
Table 7 Enumerated values of AttendeeType
Enumeration Name Enumerated Value Description
ATTENDEE_TYPE_NORMAL 0 Voice, HD, and SD participant addresses.
ATTENDEE_TYPE_TELEPRESENCE 1 Address of a telepresence participant (uni-screen or tri-screen telepresence participant).
ATTENDEE_TYPE_TERMINAL 2 Meeting room or hard terminal.
ATTENDEE_TYPE_OUTSIDE 3 External participant.
ATTENDEE_TYPE_CUSTOMNUMBER 4 Custom number.
ATTENDEE_TYPE_MOBILE 5 Soft client user's mobile phone.
ATTENDEE_TYPE_ANONYMOUS 6 Anonymous user.
ATTENDEE_TYPE_TELEPHONE 7 Phone user.
ATTENDEE_TYPE_BOARD 8 Whiteboard user.
ATTENDEE_TYPE_IDEAHUB 9 Large-screen device with HiSilicon chips.
ATTENDEE_TYPE_HWVISION 10 Smart TV.
ATTENDEE_TYPE_WELINKC 11 WeLink (public edition).
Table 8 Enumerated values of ConfAttendeeState
Enumeration Name Enumerated Value Description
CONF_ATTENDEE_STATE_IN_CONF 0 The participant is in the meeting.
CONF_ATTENDEE_STATE_CALLING 1 The participant is being called.
CONF_ATTENDEE_STATE_JOINING 2 The participant is joining the meeting.
CONF_ATTENDEE_STATE_LEAVED 3 The participant has left the meeting.
CONF_ATTENDEE_STATE_NO_EXIST 4 The user does not exist.
CONF_ATTENDEE_STATE_BUSY 5 The called user is busy.
CONF_ATTENDEE_STATE_NO_ANSWER 6 The called user does not answer the call.
CONF_ATTENDEE_STATE_REJECT 7 The called user rejects the call.
CONF_ATTENDEE_STATE_CALL_FAILED 8 Call failed.