Adding Participants
Function
This API is used to add participants to a meeting or call. 1. If you are not in the meeting or call, calling this API will fail. 2. If you call this API during a call, the call is converted to a meeting.
Function Prototype
addAttendee(addAttendeeInfo: AddAttendeeInfo, onAddAttendeeResult?: (ret: SDKERR, reason: string) => void): voidaddAttendee(addAttendeeInfo: AddAttendeeInfo, onAddAttendeeResult?: (ret: SDKERR, reason: string) => void): void
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
addAttendeeInfo | Yes | AddAttendeeInfo | Information about participants to be added. |
onAddAttendeeResult | Yes | (ret: SDKERR, reason: string) => void | Callback of adding participants. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
attendees | Yes | Array<AttendeeBaseInfo> | List of participants to be added. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
nickName | Yes | string | Participant name. |
number | Yes | string | Number. If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the call is made via the Huawei Cloud Meeting app. 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 | Yes | string | Third-party user ID. This parameter is used for app ID authentication. Either this parameter or number must be set. |
accountId | No | string | Huawei Cloud Meeting account. |
No | string | Email address used for receiving email notifications. | |
sms | No | string | Mobile number used for receiving SMS notifications. |
isAutoInvite | No | boolean | Whether the participant is automatically invited. |
isMute | No | boolean | Whether the microphone is muted. |
role | No | ConfRole | Participant role in the meeting. |
type | No | AttendeeType | Participant type. |
userUuid | No | string | Participant UUID. |
corpId | No | string | Enterprise ID. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_CONF_ROLE_ATTENDEE | 0 | Guest. |
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. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
ATTENDEE_TYPE_NORMAL | 0 | Voice, HD, or SD participant address. |
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 | Telephone 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). |
Return Values
void
Callback Method Parameters
(ret: SDKERR, reason: string) => void
Parameter | Type | Description |
---|---|---|
ret | For details about SDKERR, see Error Code Reference. | Error code. |
reason | string | Error description. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot