Platform APIEnterprise
End or cancel a meeting
Cancel a scheduled meeting or end an active meeting for all participants.
HTTP request
POST {API_ADDRESS}/rtc-meeting/end_meetingRequest example
curl --request POST "${API_ADDRESS}/rtc-meeting/end_meeting" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"meetingID":"meeting_001","userID":"user_001","endType":1}'Request body
| Parameter | Required | Type | Description |
|---|---|---|---|
| meetingID | Yes | string | Meeting ID. |
| userID | Yes | string | User performing the operation. |
| endType | Yes | MeetingEndType | 0 (CancelType) cancels a scheduled meeting; 1 (EndType) ends an active meeting. |
Response
The common response has errCode: 0 when the requested state transition completed.
Errors
See Error codes.
Permissions and limits
- Available only in OpenIM Enterprise.
- Require host or equivalent business permission before ending a meeting for all participants.
Related pages
Was this page helpful?