Help Center/ Meeting/ Client SDK Reference/ Web SDK/ APIs/ Meeting Control/ Inviting Users to a Meeting

Updated on 2025-06-18 GMT+08:00

View PDF

Inviting Users to a Meeting

handleInviteUserResult

API Description

This API can be used to invite client users and Polycom device users.

Precautions

Call this API after calling the API for joining a meeting.
Call this API only after you receive the event of the meeting joining result notification.

Method Definition

    
         handleInviteUserResult(userInfo):Promise<Result>

Parameter Description

**Table 1** Description
Parameter	Mandatory	Type	Description
userInfo	Yes	array	Information about inviting users to a meeting. For details about the array members, see Table 2.

**Table 2** userInfo member description
Type	Mandatory	Type	Description
userUUID	No	string	Participant UUID. This parameter is required when a client user is called.
name	No	string	Participant name or display name. The value can contain up to 96 characters.
phone	Yes	string	Number. The value can contain up to 127 characters. The value is a PSTN number in the PSTN call scenario. The value is a SIP number when a client user is called. The value is the meeting ID when a Polycom device user is called.
type	No	String	Terminal type. Default value: normal. Range: normal: soft client. terminal: hard terminal. mobile: mobile number.

Sample Code

   
        // Invite a user to a meeting.
HWMeeting.handleInviteUserResult([{"type":"normal","userUUID": "User ID","name":"Username","phone":"Called number"}]).then(() => { 
   // API called.
 }).catch((e) => { 
   // API calling failed.
   ...   
 });