Help Center/ Meeting/ Client SDK Reference/ Web SDK/ APIs/ Meeting Control/ Leaving a Meeting
Updated on 2025-04-18 GMT+08:00
View PDF
Share

Leaving a Meeting

API Description

This API is used to leave a meeting.

Precautions

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

Method Definition

1
 
leaveConf(params) : Promise<Result>

Related Event

Meeting Leaving Result Notification

Parameter Description

Table 1 Parameter description

Parameter

Mandatory

Type

Description

params

Yes

object

Meeting leaving option. For details about the parameters, see Table 2.
Table 2 params parameter description

Parameter

Mandatory

Type

Description

isEndConf

No

boolean

Whether to end a meeting when you leave the meeting. true: yes; false: no.

Only the host can set this parameter to true to end a meeting when the host leaves the meeting.

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

/**
 * Leave a meeting.
*/
HWMeeting.leaveConf({isEndConf:false}).then(() => {
      // API called.
      ...
    }).catch((e) => {
      // API calling failed.
      ...
    })
Parent topic: Meeting Control