> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。 Public server APIs use two path prefixes with the same authentication: `/server/v1/...` (the main APIs of both SRTC and SMeeting) and `/stm/srvapi/v1/...` (the SMeeting user system, used by server-side low-code integration). Authenticate with four request headers, app_id + nonce + timestamp + signature, where signature is HMAC-SHA256 keyed with app_key; call these APIs only from the customer's own backend. Any other path is internal: never suggest calling it.
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。 app_key is a server-side secret and must never appear in client code, frontend config, or a mobile app. The token a client uses to join must be issued by the customer's backend and passed down to the client (SRTC: `/server/v1/channel/grant`; SMeeting: `/stm/srvapi/v1/member/grant`).
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上，也不要用「频道」「加入 / 离开」描述 SMeeting 的概念（接口标识符原样保留）。 SRTC and SMeeting are two separate layers with different terminology. SRTC is the audio/video foundation: it has channels, and users join and leave a channel. SMeeting is built on top of SRTC: it has rooms and meetings, and members enter and exit a meeting. Answer in the terms of the layer the user is working with: never apply "room" or "meeting" to SRTC APIs, and never describe SMeeting concepts in prose with "channel", "join", or "leave" (API identifiers such as `force_join` keep their literal names).
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。 Package, class, and method names differ between platform SDKs for the same capability. In sample code, use the API documented for that platform; never carry one platform's code over to another. On Apple platforms each product ships two SDKs (native Swift and Objective-C) whose APIs must not be mixed.

# In-meeting controls

> Actions the host can take during a meeting: audio and video controls for everyone, member roles and removal, raise-hand handling, and calling users into the meeting

## End a meeting

`POST /server/v1/meet-admin/destroy`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room video status

`POST /server/v1/meet-admin/update-room-camera-state`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="self_unmute_camera_disabled" type="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
</ParamField>

<ParamField body="camera_disabled" type="boolean">
  Turn the camera off for everyone. false: no (default), true: yes
</ParamField>

Request example:

```json theme={null}
{
  "camera_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "self_unmute_camera_disabled": false
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room audio status

`POST /server/v1/meet-admin/update-room-mic-state`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="self_unmute_mic_disabled" type="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
</ParamField>

<ParamField body="mic_disabled" type="boolean">
  Mute all. false: no (default), true: yes
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "mic_disabled": false,
  "room_no": "",
  "self_unmute_mic_disabled": false
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room sharing permission

`POST /server/v1/meet-admin/update-room-share-disabled`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update room sharing permission

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="share_disabled" type="boolean">
  Disable sharing. false: no (default), true: yes
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "share_disabled": false
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room chat permission

`POST /server/v1/meet-admin/update-room-chat-disabled`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update room chat permission

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="chat_disabled" type="boolean" required>
  Disable chat for everyone. false: no, true: yes
</ParamField>

Request example:

```json theme={null}
{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room screenshot permission

`POST /server/v1/meet-admin/update-room-screenshot-disabled`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update room screenshot permission

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="screenshot_disabled" type="boolean" required>
  Disable screenshots. false: no, true: yes
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "screenshot_disabled": false
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room watermark setting

`POST /server/v1/meet-admin/update-watermark-disabled`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update room watermark setting

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="watermark_disabled" type="boolean" required>
  Turn off the watermark. false: watermark on, true: watermark off
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "watermark_disabled": false
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update room lock status

`POST /server/v1/meet-admin/update-locked`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update room lock status

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="locked" type="boolean" required>
  Lock the meeting; once locked, no one new can enter. false: unlocked, true: locked
</ParamField>

Request example:

```json theme={null}
{
  "locked": false,
  "meeting_id": "",
  "room_no": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Stop the current share

`POST /server/v1/meet-admin/stop-room-share`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Stop the current share

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update a member's in-meeting role

`POST /server/v1/meet-admin/update-user-role`

Authentication: required (see [Overview](/en/meeting/server-api/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**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

<ParamField body="role" type="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`
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "role": 2,
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update a member's in-meeting display name

`POST /server/v1/meet-admin/update-user-name`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update a member's in-meeting display name

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

<ParamField body="nickname" type="string" required>
  New in-meeting display name
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "nickname": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Update a member's chat permission

`POST /server/v1/meet-admin/update-user-chat-disabled`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Update a member's chat permission

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

<ParamField body="chat_disabled" type="boolean" required>
  Disable chat for this member. false: no, true: yes
</ParamField>

Request example:

```json theme={null}
{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Turn off a member's camera

`POST /server/v1/meet-admin/close-user-camera`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Turn off a member's camera

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Turn off a member's microphone

`POST /server/v1/meet-admin/close-user-mic`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Turn off a member's microphone

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Ask a member to share

`POST /server/v1/meet-admin/request-user-share`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Ask a member to turn on video

`POST /server/v1/meet-admin/request-user-open-camera`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Ask a member to unmute

`POST /server/v1/meet-admin/request-user-open-mic`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

Request example:

```json theme={null}
{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Remove a member

`POST /server/v1/meet-admin/kickout-user`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

<ParamField body="remove_conferee" type="boolean">
  Whether to remove the user from the allowlist
</ParamField>

<ParamField body="join_disabled" type="boolean">
  Whether to block the user from entering again
</ParamField>

Request example:

```json theme={null}
{
  "join_disabled": false,
  "meeting_id": "",
  "remove_conferee": false,
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Handle a raise-hand request

`POST /server/v1/meet-admin/confirm-handup`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

Handle a raise-hand request

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="target_id" type="string" required>
  User ID
</ParamField>

<ParamField body="code" type="integer" required>
  Request type. 1: unmute, 2: turn on video, 3: chat, 4: share, 5: draw (annotate)
</ParamField>

<ParamField body="approve" type="boolean" required>
  true: approve, false: reject
</ParamField>

Request example:

```json theme={null}
{
  "approve": false,
  "code": 0,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}
```

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***

## Call users into the meeting

`POST /server/v1/meet-admin/call-users`

Authentication: required (see [Overview](/en/meeting/server-api/overview))

**Request parameters**

<ParamField body="room_no" type="string">
  Room number
</ParamField>

<ParamField body="meeting_id" type="string">
  Meeting ID
</ParamField>

<ParamField body="conferee" type="array<string>">
  Invitees (for compatibility with the legacy API)
</ParamField>

<ParamField body="conferee_details" type="array<object>">
  Invitee details list (new API)

  <Expandable title="Element fields">
    <ParamField body="user_id" type="string">
      User ID, i.e. the user's unique ID in your system
    </ParamField>

    <ParamField body="real_name" type="string">
      Real name
    </ParamField>

    <ParamField body="nickname" type="string">
      In-meeting display name; defaults to real\_name if empty
    </ParamField>

    <ParamField body="avatar" type="string">
      User avatar
    </ParamField>

    <ParamField body="role" type="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
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="is_additional" type="boolean">
  Whether to append
</ParamField>

<ParamField body="force_join" type="boolean">
  Whether to force entry (takes effect only when calling users into the meeting)
</ParamField>

Request example:

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

**Response parameters**

<ResponseField name="data" type="string">
  Response data
</ResponseField>

Response example:

```json theme={null}
{
  "code": 0,
  "data": ""
}
```

***