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

Joining a Meeting

API Description

This API is used to join a meeting.

Precautions

This API can be used to join a meeting regardless of whether you have logged in or not. You can join a meeting in either of the following ways:

  • If you have not logged in, enter the meeting ID and password (or random code) to join the meeting. The token field does not need to be passed.
  • If you have logged in, enter the meeting ID, password, and token.

If you click the meeting link, for example, https://intl.meeting.huaweicloud.com/#/j/981924330/e11ddec62ee760734fcf2ba55b79937eac2aa68677caf659, in the meeting notification email to join the meeting:

  • 981924330 is the meeting ID.
  • e11ddec62ee760734fcf2ba55b79937eac2aa68677caf659 is the random code of the meeting.

Method Definition

1
joinConf(params): Promise<Result>

Related Event

Meeting Joining Result Notification

Parameter Description

Table 1 Parameter description

Parameter

Mandatory

Type

Description

params

Yes

object

Meeting joining option. For details about the parameters, see the following table.

Table 2 params parameter description

Key

Mandatory

Type

Description

id

Yes

string

Meeting ID.

The value contains 1 to 64 characters.

password

No

string

Meeting password or random code.

The value contains up to 64 characters.

nickName

No

string

Name in the meeting.

The value contains up to 64 characters.

token

No

string

User token, which is required when you join a meeting after login.

The value contains up to 64 characters.

NOTE:

The token can be obtained by calling the RESTful API for Authenticating an App ID.

Return Values

For details about the result structure, see Table 1. For details about the result data, see the following table.

Table 3 Return value data

Type

Description

null

The value of data returned by this API is null.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
/**
* Join a meeting.
*/
HWMeeting.joinConf({confId, pwd, nickName, token}).then(() => {
    // API called.
    ...    
   }).catch((e) => {
    // API calling failed.
    ...    
})