In-meeting controls

End a meeting

POST /server/v1/meet-admin/destroy Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room video status

POST /server/v1/meet-admin/update-room-camera-state Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

boolean

Whether members are prevented from turning their camera back on when the camera is off for everyone. false: not prevented (default), true: prevented. Reset to false as well when camera_disabled is false

boolean

Turn the camera off for everyone. false: no (default), true: yes

Request example:

{
  "camera_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "self_unmute_camera_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room audio status

POST /server/v1/meet-admin/update-room-mic-state Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

boolean

Whether members are prevented from unmuting themselves when everyone is muted. false: not prevented (default), true: prevented. Reset to false as well when mic_disabled is false

boolean

Mute all. false: no (default), true: yes

Request example:

{
  "meeting_id": "",
  "mic_disabled": false,
  "room_no": "",
  "self_unmute_mic_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

POST /server/v1/meet-admin/update-room-share-disabled Authentication: required (see Overview) Update room sharing permission Request parameters

string

Room number

string

Meeting ID

Disable sharing. false: no (default), true: yes

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "share_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room chat permission

POST /server/v1/meet-admin/update-room-chat-disabled Authentication: required (see Overview) Update room chat permission Request parameters

string

Room number

string

Meeting ID

boolean

required

Disable chat for everyone. false: no, true: yes

Request example:

{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room screenshot permission

POST /server/v1/meet-admin/update-room-screenshot-disabled Authentication: required (see Overview) Update room screenshot permission Request parameters

string

Room number

string

Meeting ID

boolean

required

Disable screenshots. false: no, true: yes

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "screenshot_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room watermark setting

POST /server/v1/meet-admin/update-watermark-disabled Authentication: required (see Overview) Update room watermark setting Request parameters

string

Room number

string

Meeting ID

boolean

required

Turn off the watermark. false: watermark on, true: watermark off

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "watermark_disabled": false
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update room lock status

POST /server/v1/meet-admin/update-locked Authentication: required (see Overview) Update room lock status Request parameters

string

Room number

string

Meeting ID

boolean

required

Lock the meeting; once locked, no one new can enter. false: unlocked, true: locked

Request example:

{
  "locked": false,
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

POST /server/v1/meet-admin/stop-room-share Authentication: required (see Overview) Stop the current share Request parameters

string

Room number

string

Meeting ID

Request example:

{
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update a member’s in-meeting role

POST /server/v1/meet-admin/update-user-role Authentication: required (see Overview) Update a member’s role By default, in-meeting roles use three built-in tiers: 0 regular member, 1 host, 2 co-host. Each SDK uses the role to decide whether meeting-control entry points are available. You can also turn off the built-in roles entirely and use your own role system (external role mode); the values and meaning of role are then defined by you, and this endpoint is how you change it during the meeting (in that mode you can also change your own role). See the “Custom roles” section of “Key concepts”. The notes below apply to the default case with built-in roles. This endpoint switches a member between “regular member ⇄ co-host”: pass 2 to promote a member to co-host, or 0 to revoke it. The change is also written to the meeting’s co_hosts list, so it still applies when the member enters the meeting again later. A meeting has exactly one host, determined by the meeting’s host_uid (set to creator when the meeting is created on the server), so you cannot use this endpoint to change a role to 1. The target user must be in the meeting, and the operator cannot change their own role. Role changes are broadcast to all members as an in-meeting custom message, and each SDK refreshes its member list accordingly. Request parameters

string

Room number

string

Meeting ID

string

required

User ID

integer

required

Target role. 0: regular member, 2: co-host. The host (1) is determined by the meeting’s host_uid and cannot be set here Example: 2

Request example:

{
  "meeting_id": "",
  "role": 2,
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update a member’s in-meeting display name

POST /server/v1/meet-admin/update-user-name Authentication: required (see Overview) Update a member’s in-meeting display name Request parameters

string

Room number

string

Meeting ID

string

required

User ID

string

required

New in-meeting display name

Request example:

{
  "meeting_id": "",
  "nickname": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Update a member’s chat permission

POST /server/v1/meet-admin/update-user-chat-disabled Authentication: required (see Overview) Update a member’s chat permission Request parameters

string

Room number

string

Meeting ID

string

required

User ID

boolean

required

Disable chat for this member. false: no, true: yes

Request example:

{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Turn off a member’s camera

POST /server/v1/meet-admin/close-user-camera Authentication: required (see Overview) Turn off a member’s camera Request parameters

string

Room number

string

Meeting ID

string

required

User ID

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Turn off a member’s microphone

POST /server/v1/meet-admin/close-user-mic Authentication: required (see Overview) Turn off a member’s microphone Request parameters

string

Room number

string

Meeting ID

string

required

User ID

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

POST /server/v1/meet-admin/request-user-share Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

string

required

User ID

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Ask a member to turn on video

POST /server/v1/meet-admin/request-user-open-camera Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

string

required

User ID

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Ask a member to unmute

POST /server/v1/meet-admin/request-user-open-mic Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

string

required

User ID

Request example:

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Remove a member

POST /server/v1/meet-admin/kickout-user Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

string

required

User ID

boolean

Whether to remove the user from the allowlist

boolean

Whether to block the user from entering again

Request example:

{
  "join_disabled": false,
  "meeting_id": "",
  "remove_conferee": false,
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Handle a raise-hand request

POST /server/v1/meet-admin/confirm-handup Authentication: required (see Overview) Handle a raise-hand request Request parameters

string

Room number

string

Meeting ID

string

required

User ID

integer

required

Request type. 1: unmute, 2: turn on video, 3: chat, 4: share, 5: draw (annotate)

boolean

required

true: approve, false: reject

Request example:

{
  "approve": false,
  "code": 0,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Call users into the meeting

POST /server/v1/meet-admin/call-users Authentication: required (see Overview) Request parameters

string

Room number

string

Meeting ID

array<string>

Invitees (for compatibility with the legacy API)

array<object>

Invitee details list (new API)

Show Element fields

string

User ID, i.e. the user’s unique ID in your system

string

Real name

string

In-meeting display name; defaults to real_name if empty

string

User avatar

integer

User role. 0: regular member, 1: host, 2: co-host. Ignored with built-in roles: use creator to set the host and co_hosts to set co-hosts. The in-meeting role takes this value only when you use your own custom roles (external role mode); see the “Custom roles” section of “Key concepts”. If omitted or 0, the role registered for this user in the user database is used; set it explicitly rather than relying on this fallback

boolean

Whether to append

boolean

Whether to force entry (takes effect only when calling users into the meeting)

Request example:

{
  "conferee": [
    ""
  ],
  "conferee_details": [
    {
      "avatar": "",
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ],
  "force_join": false,
  "is_additional": false,
  "meeting_id": "",
  "room_no": ""
}

Response parameters

string

Response data

Response example:

{
  "code": 0,
  "data": ""
}

Overview

Web SDK

Android SDK

Swift SDK (iOS/macOS)

Server API

End a meeting

Update room video status

Update room audio status

Update room chat permission

Update room screenshot permission

Update room watermark setting

Update room lock status

Update a member’s in-meeting role

Update a member’s in-meeting display name

Update a member’s chat permission

Turn off a member’s camera

Turn off a member’s microphone

Ask a member to turn on video

Ask a member to unmute

Remove a member

Handle a raise-hand request

Call users into the meeting

​End a meeting

​Update room video status

​Update room audio status

​Update room sharing permission

​Update room chat permission

​Update room screenshot permission

​Update room watermark setting

​Update room lock status

​Stop the current share

​Update a member’s in-meeting role

​Update a member’s in-meeting display name

​Update a member’s chat permission

​Turn off a member’s camera

​Turn off a member’s microphone

​Ask a member to share

​Ask a member to turn on video

​Ask a member to unmute

​Remove a member

​Handle a raise-hand request

​Call users into the meeting

End a meeting

Update room video status

Update room audio status

Update room sharing permission

Update room chat permission

Update room screenshot permission

Update room watermark setting

Update room lock status

Stop the current share

Update a member’s in-meeting role

Update a member’s in-meeting display name

Update a member’s chat permission

Turn off a member’s camera

Turn off a member’s microphone

Ask a member to share

Ask a member to turn on video

Ask a member to unmute

Remove a member

Handle a raise-hand request

Call users into the meeting