> ## 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.

# Error codes

> Values of the code field in server API responses

A `code` of `0` in the response body means success. Any other value means failure, and `msg` holds a human-readable error message.
**Check `code`**, not the `msg` text—messages may change between versions, codes don't.

## Business error codes

| Code | Name | Description |
| - | - | - |
| `1001` | HeaderMissingAppId | Missing app\_id in request headers |
| `1002` | HeaderInvalidAppId | Invalid app\_id in request headers |
| `1003` | HeaderInvalidSignature | Invalid signature in request headers |
| `1004` | HeaderInvalidTimestamp | Invalid timestamp in request headers |
| `1005` | HeaderInvalidSid | Invalid sid in request headers |
| `1006` | HeaderMissingNonce | Missing nonce in request headers |
| `1011` | InvalidApp | Invalid app |
| `1012` | InvalidSrvGroup | Invalid server group |
| `1013` | InvalidServer | Invalid service |
| `1014` | InvalidScene | Invalid application scenario |
| `1015` | InvalidCallback | Invalid callback configuration |
| `1020` | GrantChannelTokenFailed | Failed to generate the channel token |
| `1021` | ChannelTokenUsed | Channel token has already been used |
| `1022` | SidNotInChannel | Session is not in the channel |
| `1023` | UserNotInChannel | User is not in the channel |
| `1024` | ChannelNotOpen | Channel is not open |
| `1025` | ChannelOpened | Channel is already open |
| `1027` | GrantWbTokenFailed | Failed to generate the whiteboard token |
| `1028` | InvalidChannelName | Invalid channel name |
| `1029` | InvalidUid | Invalid uid |
| `1030` | GrantImTokenFailed | Failed to generate the IM token |
| `1031` | ImTokenUsed | IM token has already been used |
| `1032` | SidNotFound | Session is not online |
| `1033` | ConcurrentLimit | Concurrency limit reached |
| `1034` | SfuNoAvailableNode | No media server node available |
| `1035` | SfuNodeOverloaded | Media server node is fully loaded |
| `1040` | McuTaskNotFound | MCU task not found |
| `1041` | McuRecordNotStop | Recording task has not ended yet |
| `1042` | McuRecordNoVod | Recording task has not produced a recording file yet |
| `1043` | McuLayoutDataErr | MCU layout data error |
| `1044` | McuTaskIsEnd | MCU task has already stopped |
| `1045` | McuRecordNotFound | Recording file not found |
| `1046` | McuRecordNotDone | Recording file has not finished uploading |
| `1050` | TalkrecTaskNotFound | Voice recording task not found |
| `1051` | TalkrecRecordNotFound | Voice segment not found |
| `1052` | TalkrecRecordNoVod | Voice segment has not produced an audio file yet |
| `1053` | TalkrecGatewayNotFound | No voice recording gateway available |

## Common framework error codes

Any API can return these. The most common is `10070`, returned when a parameter fails validation (required, length, character set, or value range); `msg` tells you which parameter.

| Code | Name | Description |
| - | - | - |
| `10000` | CodeUnSpecial | Unspecified error |
| `10001` | CodeDatabaseException | Database error |
| `10002` | CodeDataRecordNotFound | Record not found |
| `10003` | CodeDataRecordExists | Record already exists |
| `10040` | CodeUnAuthorized | Permission denied |
| `10041` | CodeAuthFailed | Not logged in |
| `10042` | CodeTokenInvalid | Invalid token |
| `10043` | CodeTokenExpired | Token has expired |
| `10051` | CodeNetError | Network error |
| `10055` | CodeRequestTimeout | Request timed out |
| `10070` | CodeInvalidParams | Invalid request parameters |