# Alibaba Cloud Real-Time Communication API

> Alibaba Cloud Real-Time Communication API on Apizie: 132 endpoints (Calls AddRecordTemplate to add a recording configuration template, Create an application agent template, Create a custom app layout, Adds an application recording template, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-rtc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-rtc`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/rtc
- Page: https://apizie.tech/api/cloud/aliyun-rtc
- OpenAPI: https://apizie.tech/api/cloud/aliyun-rtc/openapi.json

Alibaba Cloud OpenAPI for Real-Time Communication (rtc, version 2018-01-11). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Calls AddRecordTemplate to add a recording configuration template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/add-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| LayoutIds | string | yes | List of layout ID data (JSON-encoded) |
| Formats | string | yes | List of recording file formats (JSON-encoded) |
| Backgrounds | string | no | List of background images (JSON-encoded) |
| Watermarks | string | no | List of watermarks (JSON-encoded) |
| ClockWidgets | string | no | List of clocks (JSON-encoded) |
| AppId | string | yes | Application ID. Created and queried via the console. Only a single ID is supported |
| Name | string | yes | Recording configuration template name |
| TaskProfile | string | yes | Task billing configuration. Charges vary based on your settings. See the TaskProfile enumeration values below. The resolution of the… |
| MediaEncode | integer | yes | Encoding option. See the MediaEncode enumeration values below |
| BackgroundColor | integer | no | Background color RGB. The default is 0 (black). The calculation formula is R + G × 256 + B × 65536. R (red), G (green), and B (blue) each… |
| OssBucket | string | yes | OSS bucket where the recording files are stored. Currently, only OSS buckets in the Shanghai region are supported |
| OssFilePrefix | string | yes | Naming rule for recording files. To ensure that recording file names are unique, the current naming rule is… |
| FileSplitInterval | integer | yes | Recording file split duration (greater than or equal to 1800). Unit: seconds |
| DelayStopTime | integer | no | Delay time before stopping recording. Unit: seconds. Default value: 180 seconds |
| MnsQueue | string | no | Message queue for recording event callbacks. One and only one of this parameter and HttpCallbackUrl must be provided; you cannot provide… |
| HttpCallbackUrl | string | no | HTTP callback URL for recording events. One and only one of this parameter and MnsQueue must be provided; you cannot provide both or neither |
| EnableM3u8DateTime | string | no | Whether the recorded m3u8 file needs to include the timestamp of the ts file |
| OssEndpoint | string | no | The OssEndpoint |

### Create an application agent template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-app-agent-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can find this ID in the console. Only a single ID is supported |
| Name | string | yes | The template name |
| Type | integer | no | The agent type. `1`: Voice call (default) |
| ChatMode | integer | no | The chat mode. `1`: Natural Conversation Mode (default) `2`: Walkie-talkie Mode |
| InterruptMode | integer | no | The interrupt mode. `1`: Allows interruption (default) `2`: Disallows interruption |
| Greeting | string | no | The greeting message. Maximum length: 500 characters |
| AsrConfig | string | no | The speech-to-text settings (JSON-encoded) |
| LlmConfig | string | no | The large language model (LLM) settings (JSON-encoded) |
| TtsConfig | string | no | The text-to-speech settings (JSON-encoded) |
| AgentSilenceConfig | string | no | The configuration for handling agent silence (JSON-encoded) |
| AmbientSoundConfig | string | no | The configuration for ambient sound. This feature is disabled by default (JSON-encoded) |
| InterruptConfig | string | no | The configuration for agent interruption (JSON-encoded) |
| BackChannelConfig | string | no | The configuration for agent backchannel (JSON-encoded) |
| EnableVideoUnderstanding | string | no | Specifies whether to enable video understanding. If enabled, the LLM must support multimodal input |
| PreferVideo | integer | no | If video understanding is enabled, this parameter specifies which video stream the agent processes. Since the agent can only process one… |

### Create a custom app layout
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-app-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency token |
| AppId | string | yes | Application ID. Find or create this ID in the console. You can specify only one ID |
| Layout | string | yes | Layout configuration (JSON-encoded) |

### Adds an application recording template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-app-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency token |
| RecordTemplate | string | yes | Recording template (JSON-encoded) |
| AppId | string | yes | Application ID. Create and view this ID in the console. Only one ID is supported |

### Create an RTC 3.0 application stream ingest template.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-app-streaming-out-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported |
| StreamingOutTemplate | string | yes | Template (JSON-encoded) |

### Create an application composite streaming template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-app-view-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and view this ID in the console. Only one ID is supported |
| Template | string | yes | The template (JSON-encoded) |

### Calls CreateAutoLiveStreamRule to create an automatic single-stream relay rule
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-auto-live-stream-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ChannelIds | string | no | The list of channel IDs that are exactly matched (JSON-encoded) |
| ChannelIdPrefixes | string | no | The list of channel ID prefixes that are fuzzy matched (JSON-encoded) |
| AppId | string | yes | The application ID, which can be created and queried in the console |
| PlayDomain | string | yes | The streaming domain name for automatic relay. The streaming URL of an automatic relay task is in the format… |
| RuleName | string | no | The name of the relay rule |
| CallBack | string | no | The callback URL used to notify the start and end of the relay. For details about the callback content, see the CallBack callback example… |
| MediaEncode | integer | no | The encoding option. For more information, see the MediaEncode enumeration values below |

### Add a keyword list to the meeting minutes
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-cloud-note-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and view this ID in the console. Only one ID is supported |
| Phrase | string | yes | The hotword parameters (JSON-encoded) |

### Calls CreateEventSubscribe to create a callback for subscribing to room messages
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-event-subscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| Users | string | no | The subscribed users (JSON-encoded) |
| Events | string | yes | The subscribed events (JSON-encoded) |
| AppId | string | yes | The ID of the subscribed application |
| ChannelId | string | no | The ID of the subscribed channel. This parameter is required if the Users.N parameter is not empty |
| CallbackUrl | string | yes | The callback URL. For information about the callback content, see the following callback content example |
| ClientToken | string | yes | The idempotence identifier used by the client to create the subscription |
| NeedCallbackAuth | string | no | Specifies whether to enable callback authentication. Valid values: true: enables callback authentication. fasle (default): disables… |
| Role | integer | no | The user role. Valid values: 1: subscribes to host messages in the channel. 2: subscribes to audience messages in the channel. Empty or… |

### Calls CreateMPULayout to create a stream relay layout
`POST https://apizie.tech/v1/cloud:aliyun-rtc/create-mpulayout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| Panes | string | yes | The list of panes in the layout (JSON-encoded) |
| AppId | string | yes | The application ID. Only a single ID can be passed. You can create and query the application ID in the console |
| Name | string | no | The name of the layout |
| AudioMixCount | integer | yes | The maximum number of audio mixes. Valid values: 0 to 6 |

### Deletes an application agent template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-app-agent-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and query using the console. Pass only a single ID |
| Id | string | yes | Template ID |

### Delete a custom application layout
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-app-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | An idempotency token |
| AppId | string | yes | The application ID. Create and query this ID in the console. Only one ID is supported per request |
| Layout | string | no | Layout information (JSON-encoded) |

### Delete an application recording template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-app-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency token |
| AppId | string | yes | Application ID. Create and view this ID in the console. Only one ID is supported |
| Template | string | yes | Template information (JSON-encoded) |

### Delete an RTC 3.0 application stream ingest template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-app-streaming-out-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported |
| StreamingOutTemplate | string | yes | Template information (JSON-encoded) |

### Deletes an application's composite stream template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-app-view-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query the ID in the console. Only a single ID can be specified |
| Template | string | yes | The template information (JSON-encoded) |

### Calls DeleteAutoLiveStreamRule to delete an automatic single-stream relay rule
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-auto-live-stream-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, which can be created and queried in the console |
| RuleId | integer | yes | The bypass rule ID. You can query it in the console or obtain it by calling the https://help.aliyun.com/document_detail/353198.html… |

### Calls DeleteChannel to delete a channel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, which is created and queried in the console. Only a single ID is supported |
| ChannelId | string | yes | The ID of the channel that has been joined. Only a single ID is supported |

### Delete the hot words list for meeting minutes
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-cloud-note-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and view it in the console. You can specify only one ID |
| Phrase | string | yes | The keywords list parameters (JSON-encoded) |

### Deletes a callback for subscribing to room messages by calling DeleteEventSubscribe
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-event-subscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query applications in the console |
| SubscribeId | string | yes | The subscription ID. For more information, see https://help.aliyun.com/document_detail/274447.html |

### Calls DeleteMPULayout to delete an MPU (Mixed Push Unit) layout for stream relay to CDN
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-mpulayout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Only a single ID can be passed. You can create and query the ID in the console |
| LayoutId | integer | yes | The layout ID. Only a single ID can be passed. To obtain the layout ID, see https://help.aliyun.com/document_detail/162192.html |

### Calls the DeleteRecordTemplate operation to delete a recording configuration template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/delete-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, which is created and queried in the console. Only a single ID can be specified |
| TemplateId | string | yes | The configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html |

### Lists the event callbacks supported by the system
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-all-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |

### Query the status of the application agent feature
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-agent-function-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and query it in the console. Only a single ID is supported |

### Application agent templates
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-agent-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can find this ID in the console. Only a single ID is supported |
| Name | string | no | The template name |
| Id | string | no | The template ID |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The page size |

### View application callback toggle
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-call-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID |

### Obtain the application callback key
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-callback-secret-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |

### Invoke DescribeAppKey to query the AppKey of a specified application.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query this ID in the console. Only a single ID is supported. |

### Query custom application layouts
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-layouts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and query it using the console. Only a single ID is supported |
| PageNum | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| Condition | string | no | The query conditions (JSON-encoded) |

### View the application bypass switch
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-live-stream-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | A parameter that ensures the idempotence of the request |
| AppId | string | yes | The ID of the application. You can create and query the application ID in the console. You can specify only one application ID |

### Queries the recording status of an application
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-record-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency token |
| AppId | string | yes | Application ID. You can create and view this ID in the console. Only one ID is supported |

### Lists application recording templates
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-record-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency token |
| AppId | string | yes | Application ID. Find or create this ID in the console. You can specify only one ID |
| PageNum | integer | no | Page number. Default is 1 |
| PageSize | integer | no | Number of items per page. Default is 10 |
| Condition | string | no | Query conditions (JSON-encoded) |

### Lists recording files
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-recording-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | App ID |
| ChannelId | string | no | Channel ID |
| PageNo | integer | no | Page number |
| PageSize | integer | no | Number of entries per page |
| StartTs | integer | no | Query range start time (open interval) for recording tasks, in milliseconds. If not specified, defaults to the past 3 days. You can query… |
| EndTs | integer | no | The query range specifies the start time of the recording task. It is defined as a closed interval and measured in milliseconds (ms) |
| TaskIds | string | no | List of recording task IDs (JSON-encoded) |

### Query the list of stream ingest templates under an RTC 3.0 application.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-streaming-out-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID, created and queried through the console. Only a single ID is supported |
| PageNum | integer | no | Page number. By default, page 1 is queried |
| PageSize | integer | no | Number of entries per page. The default value is 10 |
| Condition | string | no | Search condition (JSON-encoded) |

### View the stream merging switch
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-view-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The ID of the application. You can create and find the application ID in the console. Only one ID can be specified |

### Lists application compositing templates
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-app-view-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and view it in the console. You can specify only one ID |
| PageNum | integer | no | Page number. Default value: 1 |
| PageSize | integer | no | Number of entries per page. Default value: 10 |
| Condition | string | no | Search condition (JSON-encoded) |

### Invoke DescribeApps to query the application list
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | no | Application ID, created and queried via the console. Only a single ID is supported. An empty parameter indicates querying all application… |
| Status | string | no | Application status. An empty parameter indicates querying applications in all statuses. Valid values: 1: Active. 2: Disabled. 3: Disabled… |
| Order | string | no | Sorting method. Valid values: asc: Increment. desc (default): Decrement |
| PageNum | integer | no | Page number. By default, page 1 is queried |
| PageSize | integer | no | Number of entries per page. Default value is 10 |
| AppVersion | string | no | Application Version |

### Calls the DescribeAutoLiveStreamRule operation to query an automatic live stream relay rule
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-auto-live-stream-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query it in the console |

### This API is used to query the details of a single communication session. For example, you can query the…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | Channel creation time. Supports querying data from the last 30 days, represented as a UNIX timestamp, in seconds. The channel creation… |
| DestroyedTs | integer | no | Channel release time, represented as a UNIX timestamp, in seconds. If the parameter is empty, the current time is used. If the provided… |
| ExtDataType | string | no | The extension to query. Valid value: USER_DURATION_STAT: user duration statistics data type |
| QueryExpInfo | string | no | Specifies whether to query communication experience information. If this parameter is not specified, the default value is true. |

### Invoke DescribeCallList to perform a paged query of communication records created within a specified time…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-call-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| StartTs | integer | yes | Start Time of the query, represented as a UNIX timestamp in seconds |
| EndTs | integer | yes | The end time of the query, expressed as a UNIX timestamp. Unit: seconds |
| ChannelId | string | no | Channel ID |
| UserId | string | no | User ID |
| CallStatus | string | no | Call status. Valid values: IN: In progress. OUT: Ended |
| OrderBy | string | no | Sorting field. Valid values: BAD_EXP_USER_COUNT_DESC: Sort by the number of users with poor experience in descending order.… |
| QueryMode | string | no | Query mode. Valid values: ALL: All calls. FOLLOW: Followed calls |
| PageNo | integer | yes | Page number. Minimum value: 1. Maximum value: 200 |
| PageSize | integer | yes | Quantity per page, minimum value is 1, maximum value is 200 |

### Lists the event callbacks configured for an application
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-callbacks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |

### DescribeChannel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query this ID in the console. Only a single ID is supported |
| ChannelId | string | yes | The channel ID to query. Only a single ID is supported |

### This API is used to query the user list in a channel.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-all-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query this ID in the console. Only a single ID is supported. |
| ChannelId | string | yes | Channel ID to query. Only a single ID is supported. |

### This API is used to obtain the statistics on the regional distribution of channels
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-area-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | channel ID |
| CreatedTs | integer | yes | Timestamp of channel creation. Supports querying data from the last 30 days. Represented as a UNIX timestamp in seconds. |
| DestroyedTs | integer | no | Channel release time, represented as a UNIX timestamp in seconds. If the parameter is empty, the current time is used. If the provided… |
| ParentArea | string | no | Parent region name. For example, the parent of Shenzhen City is Guangdong Province. If the parameter is empty, statistics are returned at… |

### This API is used to obtain channel distribution statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | channel ID |
| CreatedTs | integer | yes | The UNIX timestamp indicating when the channel was created. Data from the last 30 days can be queried. The value is expressed as a UNIX… |
| DestroyedTs | integer | no | Channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the provided… |
| StatDim | string | yes | Statistical dimension. Valid values: OS: Statistics by operating system. SDK_VERSION: Statistics by SDK version |

### This API is used to query channel overview data
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-overall-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | UNIX timestamp indicating the channel creation time. Supports querying data from the last 30 days. Expressed as a UNIX timestamp in seconds |
| DestroyedTs | integer | no | Channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the provided… |

### Queries the list of online users in a channel. The response does not include detailed user information
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and view this ID in the Alibaba Cloud console. Only one ID is supported |
| ChannelId | string | yes | The channel ID. Only one ID is supported |
| Order | string | no | The sort order. Valid values: asc: ascending. desc (default): descending |
| PageNum | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of users per page. Default value: 10 |

### This API is used to retrieve the list of publishing users in a channel, sorted in descending order by their…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-top-pub-user-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | The UNIX timestamp of channel creation. Supports querying data from the last 30 days, expressed as a UNIX timestamp in seconds |
| DestroyedTs | integer | no | The UNIX timestamp indicating when the channel was released, in seconds. If this parameter is empty, data up to the current time will be… |

### DescribeChannelUser
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query this ID in the console. Only a single ID is supported |
| ChannelId | string | yes | Channel ID to query. Only a single ID is supported |
| UserId | string | yes | User ID |

### [responses_200_schema_properties_MetricDatas_description]List of metric data
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-user-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID. |
| CreatedTs | integer | yes | The UNIX timestamp indicating when the channel was created. Data from the last 30 days is supported. The timestamp is expressed in seconds. |
| DestroyedTs | integer | no | The UNIX timestamp indicating when the channel was released, in seconds. If this parameter is empty, the current time is used. If the… |

### Queries the list of real-time online users in a channel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channel-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query the ID in the console. Only a single ID is supported |
| ChannelId | string | yes | The ID of the channel to query. Only a single ID is supported |

### This operation retrieves a list of all active channels for a single AppId
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You create and view this ID in the console. Only one ID is supported |
| PageNo | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Summary of trending terms
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-cloud-note-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Obtain the ID from the console. Only a single ID can be specified |
| PageNum | integer | no | The page number. The default value is 1 |
| PageSize | integer | no | The number of entries to return on each page. The default value is 10 |
| Condition | string | no | The query condition (JSON-encoded) |

### Meeting Summary List
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-cloud-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | no | Channel ID |
| PageNo | integer | no | Page number. |
| PageSize | integer | no | Number of items per page. |
| StartTs | integer | no | Query range, open interval of job start time, in milliseconds. If not specified, defaults to querying recordings from the last 3 days,… |
| EndTs | integer | no | Query range, closed interval of job start time, in milliseconds. |
| TaskIds | string | no | List of job TaskIds. (JSON-encoded) |

### Query the status of a recording task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-cloud-record-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |
| ChannelId | string | yes | The channel name |
| TaskId | string | yes | The task ID |

### This API is used to retrieve the end-to-end user management event List
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-end-point-event-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | channel ID |
| CreatedTs | integer | yes | Start Time of the event query time range. This time must not be earlier than the actual channel Creation Time and must not be earlier than… |
| DestroyedTs | integer | no | End time of the event query time range. This time must not be later than the channel release time. It is represented as a UNIX timestamp… |
| UserIdList | string | yes | List of User IDs, separated by commas (,) |

### This API is used to obtain end-to-end metric data.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-end-point-metric-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | Start Time of the query time range. This time must not be earlier than the actual Creation Time of the channel and must not be more than… |
| DestroyedTs | integer | no | End Time of the query time range. This time must not be later than the channel release time. It is represented as a UNIX timestamp, in… |
| SubUserId | string | no | Subscriber User ID |
| PubUserId | string | no | User ID of the publisher. You can specify either the PubUserId parameter or the PubCallIdList parameter, but not both |
| PubCallIdList | string | no | Call IDs of the publisher's communication streams, separated by English commas (,). You must specify either PubUserId or PubCallIdList,… |
| Metrics | string | yes | Enumeration list of Metrics, separated by commas (,) |

### Invoke the DescribeFaultDiagnosisFactorDistributionStat API to obtain the distribution of factors impacting…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-fault-diagnosis-factor-distribution-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| StartTs | integer | yes | Start Time of the query, expressed as a UNIX timestamp. Unit: seconds |
| EndTs | integer | yes | End Time of the query, expressed as a UNIX timestamp. Unit: seconds |

### Invoke DescribeFaultDiagnosisOverallData to obtain the overview data for abnormal diagnosis.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-fault-diagnosis-overall-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| StartTs | integer | yes | Start Time of the query, represented as a UNIX timestamp in seconds |
| EndTs | integer | yes | End Time of the query, represented as a UNIX timestamp in seconds |
| StatDim | string | yes | Dimension for Data Statistics. Valid values: JOIN_SLOW_USER: User Count with slow channel joining. AUDIO_STUCK_USER: User Count… |

### [responses_200_schema_properties_UserDetail_properties_Duration_type]integer
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-fault-diagnosis-user-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | 频道ID |
| CreatedTs | integer | yes | 频道创建时间，使用UNIX时间戳表示，单位：秒 |
| UserId | string | yes | 用户ID |
| FaultType | string | yes | 异常类型。取值： JOIN_SLOW：进频道慢 。 AUDIO_STUCK：音频卡顿。 VIDEO_STUCK：视频卡顿。 VIDEO_VAGUE：视频模糊。 HIGH_DELAY：通话延迟高 。 FIRST_FRAME_SLOW：接收首屏慢 |
| QueryCallUserInfo | string | no | 是否查询通话用户信息，为空默认是false |

### Invoke DescribeFaultDiagnosisUserList to obtain the list of user details for abnormal diagnosis
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-fault-diagnosis-user-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| StartTs | integer | yes | The query start time, represented as a UNIX timestamp in seconds. |
| EndTs | integer | yes | The query end time, represented as a UNIX timestamp in seconds |
| ChannelId | string | no | Channel ID to search for |
| UserId | string | no | User ID to search for |
| FaultTypes | string | no | Abnormal types to filter. Separate multiple values with English commas (,). Valid values: JOIN_SLOW: Slow channel joining. AUDIO_STUCK:… |
| PageNo | integer | yes | Page number |
| PageSize | integer | yes | Number of entries per page. |

### Call DescribeMPULayoutInfoList to retrieve layout parameters for a bypass live streaming task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-mpulayout-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can specify only one ID. Create or view IDs in the console |
| LayoutId | integer | no | Layout ID. To get a layout ID, see https://help.aliyun.com/document_detail/162192.html |
| Name | string | no | Layout name |
| PageNum | integer | no | Page number. Default value: 1 |
| PageSize | integer | no | Number of entries per page. Default value: 10 |

### This API is used to obtain the list of publishing users in a communication session based on the subscriber
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-pub-user-list-by-sub-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | The channel creation time. You can query data from the last 30 days. The value is represented as a UNIX timestamp in seconds |
| DestroyedTs | integer | no | The channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the… |
| SubUserId | string | yes | Subscriber User ID |

### This API is used to obtain the downlink experience quality metrics of a user in a single communication…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-qoe-metric-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | APP ID |
| ChannelId | string | yes | Channel ID |
| CreatedTs | integer | yes | Channel Creation Time. Supports querying data from the last 30 days. Represented as a UNIX timestamp in seconds |
| DestroyedTs | integer | no | Channel release time, represented as a UNIX timestamp in seconds. An empty parameter indicates retrieving data up to the current time. If… |
| UserId | string | yes | User ID |

### This API is used to obtain the regional distribution data of quality statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-quality-area-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | Start Time of the query, represented as a UNIX timestamp in seconds. |
| EndDate | integer | yes | End Time of the query, represented as a UNIX timestamp in seconds. |
| ParentArea | string | no | Parent area name. For example, the parent of Hangzhou City is Zhejiang Province, and the parameter value should be China_Zhejiang… |
| AppId | string | yes | APP ID |

### This API is used to obtain the distribution data of quality statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-quality-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | Start Time of the query, expressed as a UNIX timestamp in seconds. |
| EndDate | integer | yes | End Time of the query, expressed as a UNIX timestamp in seconds. |
| StatDim | string | yes | Statistical dimension. Valid values: CHANNEL_ONLINE: Statistics by channel online participant count. NETWORK: Statistics by network type.… |
| AppId | string | yes | APP ID |

### This API is used to obtain the distribution data of operating systems and SDK versions in quality statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-quality-os-sdk-version-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | Start Time of the query, represented as a UNIX timestamp, in seconds. |
| EndDate | integer | yes | End Time of the query, represented as a UNIX timestamp, in seconds. |
| AppId | string | yes | APP ID |

### This API is used to obtain overview data of quality statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-quality-overall-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | The Start Time of the query, represented as a UNIX timestamp in seconds |
| EndDate | integer | yes | The End Time of the query, represented as a UNIX timestamp in seconds |
| Types | string | yes | The Metric Types to query, separated by commas (,). Valid values: JOIN_CHANNEL_SUC_RATE: Channel Join Success Rate.… |
| AppId | string | yes | APP ID |

### Calls DescribeRecordFiles to query the list of files generated by recording
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-record-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| TaskIds | string | no | Recording task ID (JSON-encoded) |
| AppId | string | yes | The application ID. Only a single ID can be passed. You can create and query it in the console |
| ChannelId | string | no | The channel ID. Only a single ID can be passed |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 100 |
| PageNum | integer | no | The page number. By default, the first page is queried |
| StartTime | string | no | The start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC time) |
| EndTime | string | no | The end time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC time) |

### Queries a list of recording template configurations by calling the DescribeRecordTemplates operation
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-record-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| TemplateIds | string | no | The list of template IDs to query. The format is as follows: ``` TemplateIds.1=**** TemplateIds.2=**** ...... ``` To obtain a template ID,… |
| AppId | string | yes | The application ID. You can create and query the application ID in the console. Only a single ID can be passed |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| PageNum | integer | no | The page number. By default, the first page (1) is queried |

### Call DescribeRtcChannelList to retrieve a list of channel communication records
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-rtc-channel-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | no | Application ID. You can create and view this ID in the console. Only one ID is supported |
| TimePoint | string | yes | Query time point in UTC format, yyyy-MM-ddTHH:mm:ssZ. Time granularity is day |
| SortType | string | no | Sort order. Default is descending by StartTime |
| ServiceArea | string | no | Service area. Default is all areas. cn: China. us: United States |
| UserId | string | no | User ID. Only one ID is supported |
| ChannelId | string | no | Channel ID. Only one ID is supported |
| PageNo | integer | yes | Page number. Value must be greater than 0. Default is 1 |
| PageSize | integer | yes | Number of items to return. Value must be greater than 0. Default is 10 |

### Queries the details of communication records in a channel. You can query data within the last 180 days
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-rtc-channel-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| TimePoint | string | yes | The time when the record is queried, in UTC. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time granularity is day |
| AppId | string | yes | The application ID. You can create and query the application ID in the console. Only a single ID is supported |
| ChannelId | string | yes | The channel ID. Only a single ID is supported |

### Retrieves the total communication duration for an application within a specified time range. Data is…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-rtc-duration-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartTime | string | no | The start of the time range to query. Specify the time in UTC format: yyyy-MM-ddTHH:mm:ssZ |
| EndTime | string | no | The end of the time range to query. Specify the time in UTC format: yyyy-MM-ddTHH:mm:ssZ. The end time must be later than the start time |
| AppId | string | no | The ID of the application. You can specify only one ID. If you leave this parameter empty, data for all your applications is returned |
| ServiceArea | string | no | The area where the service is deployed. The default value is CN, which indicates China |
| Interval | string | no | The time granularity of the query, in seconds. Valid values are 3600 (1 hour) and 86400 (1 day). The default value is 3600 |

### Queries the peak number of concurrent channels of an application in a specified time range
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-rtc-peak-channel-cnt-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartTime | string | no | The start time for the data query. Specify the time in the UTC format: yyyy-MM-ddTHH:mm:ssZ |
| EndTime | string | no | The end time for the data query. Specify the time in the UTC format: yyyy-MM-ddTHH:mm:ssZ. The end time must be later than the start time |
| AppId | string | no | The application ID. Only a single ID can be specified. By default, all application IDs are queried. |
| ServiceArea | string | no | The service area. CN: China (default value) |
| Interval | string | no | The time granularity for the data query, in seconds. Valid values: 3600 (1 hour) or 86400 (1 day). Default value: 3600. |

### Queries the number of active users of an application within a specified time range, that is, the number of…
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-rtc-user-cnt-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartTime | string | no | The start time of the queried data. The time is displayed in UTC. The format is yyyy-MM-ddTHH:mm:ssZ |
| EndTime | string | no | The end time of the queried data. The time is displayed in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. The end time must be later than the… |
| AppId | string | no | The application ID. You can specify only one ID. By default, all application IDs are queried. |
| ServiceArea | string | no | The service area. CN: China (default value) |
| Interval | string | no | The time granularity at which the data is queried. Unit: seconds. Valid values: 3600 (one hour) or 86400 (one day). Default value: 3600. |

### Queries the status of a streaming-out task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-streaming-out-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |
| ChannelId | string | yes | The name of the channel |
| TaskId | string | yes | The task ID |

### Built-in system layouts
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-system-layout-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| PageNum | integer | no | Page number |
| PageSize | integer | no | Number of entries per page |

### This API is used to retrieve the regional distribution data of usage statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-usage-area-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | string | yes | The start time of the query, expressed as a UNIX timestamp in seconds |
| EndDate | string | yes | The end time of the query, expressed as a UNIX timestamp in seconds |
| ParentArea | string | no | The parent region name. For example, the parent of Hangzhou City is Zhejiang Province, and the parameter should be set to China_Zhejiang… |
| AppId | string | yes | APP ID |

### This API is used to retrieve the distribution data of usage statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-usage-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | The start time of the query, expressed as a UNIX timestamp in seconds |
| EndDate | integer | yes | The end time of the query, expressed as a UNIX timestamp in seconds |
| StatDim | string | yes | The statistics dimension. Valid values: CHANNEL_ONLINE: Statistics by channel online user count. NETWORK: Statistics by network type. OS:… |
| AppId | string | yes | APP ID |

### This API is used to obtain the distribution data of operating systems and SDK versions in usage statistics.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-usage-os-sdk-version-distribution-stat-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | Start Time of the query, represented as a UNIX timestamp in seconds |
| EndDate | integer | yes | End Time of the query, represented as a UNIX timestamp in seconds |
| AppId | string | yes | APP ID |

### This API is used to retrieve overview data of usage statistics
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-usage-overall-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| StartDate | integer | yes | The Start Time of the query, represented as a UNIX timestamp in seconds |
| EndDate | integer | yes | The End Time of the query, represented as a UNIX timestamp in seconds |
| Types | string | yes | The Metric Type of the query. Separate multiple values with English commas (,). Valid values: TOTAL_CALL_DURATION: Total duration.… |
| AppId | string | yes | APP ID |

### Calls DescribeUserInfoInChannel to query the real-time information of a user in a channel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/describe-user-info-in-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, which is created and queried through the console. Only a single ID is supported |
| ChannelId | string | yes | The channel ID. Only a single ID is supported |
| UserId | string | yes | The user ID. Only a single ID is supported |

### Calls the DisableAutoLiveStreamRule operation to disable an automatic single-stream relay rule
`POST https://apizie.tech/v1/cloud:aliyun-rtc/disable-auto-live-stream-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, which can be created and queried in the console |
| RuleId | integer | yes | The ID of the relay rule. You can obtain the relay rule ID by querying it in the console or by calling the… |

### Calls the EnableAutoLiveStreamRule operation to enable an automatic single-stream relay rule
`POST https://apizie.tech/v1/cloud:aliyun-rtc/enable-auto-live-stream-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query the application ID in the console |
| RuleId | integer | yes | The ID of the relay rule. You can query the ID of the relay rule in the console or by calling the… |

### GetAgent
`POST https://apizie.tech/v1/cloud:aliyun-rtc/get-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | no | Application ID. You can create and view this ID in the console. Only one ID is supported |
| ChannelId | string | no | Channel ID |
| TaskId | string | no | Task ID |

### Calls GetMPUTaskStatus to query the status of a stream relay task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/get-mputask-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Only a single ID is supported |
| TaskId | string | yes | The task ID. Only a single ID is supported. The value must be the same as the TaskId parameter of… |

### Invoke ModifyApp to modify the name of a specified application.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |
| AppName | string | yes | Application name. Only a single name is supported. |

### Toggle the application agent feature
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-agent-function-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and query it in the console. Only a single ID is supported |

### Updating an application agent template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-agent-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can obtain this ID from the console. Only one ID can be specified |
| Id | string | yes | The template ID |
| Name | string | yes | The template name |
| Type | integer | no | The agent type: `1`: Voice call (default) |
| ChatMode | integer | no | The chat mode: `1`: Natural conversation mode (default) `2`: Walkie-talkie mode |
| InterruptMode | integer | no | The interrupt mode: `1`: Allow interrupt (default) `2`: Disable interrupt |
| Greeting | string | no | The greeting message. The maximum length is 500 characters |
| AsrConfig | string | no | ASR (Automatic Speech Recognition) configuration (JSON-encoded) |
| LlmConfig | string | no | LLM (Large Language Model) configuration (JSON-encoded) |
| TtsConfig | string | no | TTS (Text-to-Speech) configuration (JSON-encoded) |
| AgentSilenceConfig | string | no | The agent silence configuration (JSON-encoded) |
| AmbientSoundConfig | string | no | Configuration for the agent's ambient sound. If this parameter is not specified, ambient sound is disabled (JSON-encoded) |
| InterruptConfig | string | no | The agent interrupt configuration (JSON-encoded) |
| BackChannelConfig | string | no | The agent backchannel configuration (JSON-encoded) |
| EnableVideoUnderstanding | string | no | Specifies whether to enable video understanding. If enabled, the specified LLM must support multimodal data |
| PreferVideo | integer | no | When `EnableVideoUnderstanding` is `true`, this parameter specifies which video stream to prioritize if both a camera stream and a screen… |

### Update the application callback management event toggle
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-callback-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID |

### Modify a custom application layout
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotent parameter |
| AppId | string | yes | Application ID. Create and query through the console. Only a single ID is supported |
| Layout | string | yes | Layout (JSON-encoded) |

### Modify the bypass toggle of an application
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-live-stream-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency parameter |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |

### Modify the application recording toggle
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-record-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency parameter |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |

### Modify an application recording template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-record-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency parameter |
| RecordTemplate | string | yes | Recording template (JSON-encoded) |
| AppId | string | yes | Application ID. Create and query through the console. Only a single ID is supported |

### Modify the stream ingest template for an RTC 3.0 application.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-streaming-out-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported |
| StreamingOutTemplate | string | yes | Template (JSON-encoded) |

### Modify the stream mixing switch
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-view-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and query it in the console. Only a single ID is supported |

### Update an application view template
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-app-view-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and view it in the console. Only one ID is supported |
| Template | string | yes | The template (JSON-encoded) |

### Update application callback
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-callback-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID |
| Callback | string | yes | Callback configuration. (JSON-encoded) |

### You can update the hotword list for meeting minutes
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-cloud-note-phrases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and view it in the console. You can specify only one ID |
| Phrase | string | yes | Hotword parameters (JSON-encoded) |

### Modifies the layout of bypass live streaming
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-mpulayout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| Panes | string | no | The list of panes in the layout (JSON-encoded) |
| AppId | string | yes | The application ID. Only a single ID is supported. You can create and query applications in the console |
| Name | string | no | The layout name |
| LayoutId | integer | yes | The layout ID. To obtain the layout ID, see https://help.aliyun.com/document_detail/162192.html |
| AudioMixCount | integer | no | The maximum number of audio mixing streams. Valid values: 0 to 6 |

### Set stream properties
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-streaming-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and query it in the console. Pass only one ID |
| ChannelId | string | yes | Existing channel ID. Pass only one ID |
| TaskId | string | yes | Mixing task ID |
| ViewSubscribers | string | no | ViewSubscribers (JSON-encoded) |
| ViewContent | string | no | Mixing content type |

### Configures the stream mixing layout
`POST https://apizie.tech/v1/cloud:aliyun-rtc/modify-view-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and find this ID in the console. Only a single ID is supported |
| ChannelId | string | yes | The ID of an existing channel. Only a single ID is supported |
| TemplateId | string | yes | The template ID |
| TaskId | string | yes | The task ID. Only a single ID is supported. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens… |
| Panes | string | no | The cell settings. You can set a maximum of 16 cells (JSON-encoded) |
| Backgrounds | string | no | The background images (JSON-encoded) |
| Images | string | no | The global image watermarks (JSON-encoded) |
| Texts | string | no | The global text watermarks (JSON-encoded) |
| ClockWidgets | string | no | The global clock watermarks (JSON-encoded) |
| LayoutSpecifiedUsers | string | no | The settings for blacklists and whitelists (JSON-encoded) |

### NotifyAgent
`POST https://apizie.tech/v1/cloud:aliyun-rtc/notify-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | no | The application ID. Create and query it in the console. Only a single ID is supported |
| ChannelId | string | no | The channel to join. Only a single ID is supported |
| TaskId | string | no | The task ID |
| Message | string | no | The text content to announce |
| Priority | integer | no | The priority level for inserting the announcement: 1 — Interrupt the current interaction and announce immediately. 2 — Announce after the… |
| Interruptable | string | no | Indicates whether the announcement can be interrupted. If false, the message cannot be interrupted by voice input, key presses, or other… |
| CustomAttribute | string | no | Custom parameters passed through to the client |
| BackgroundMusic | string | no | Background audio (JSON-encoded) |

### Call the RemoveTerminals operation to remove specified end users from a channel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/remove-terminals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| TerminalIds | string | yes | A list of user IDs (JSON-encoded) |
| AppId | string | yes | The application ID. Only one ID is supported. You can create and query application IDs in the console |
| ChannelId | string | yes | The ID of the channel that the user has joined. Only one ID is supported |

### RemoveUsers
`POST https://apizie.tech/v1/cloud:aliyun-rtc/remove-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |
| ChannelId | string | yes | The ID of the joined channel. Only a single ID is supported |
| Users | string | yes | User List. Valid values of N: 1 to 30. (JSON-encoded) |

### Cancels a SIP invite
`POST https://apizie.tech/v1/cloud:aliyun-rtc/rtc-cancel-sip-invite` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Create and find this ID in the console. Specify only one ID |
| ChannelId | string | yes | The ID of an existing channel. Specify only one ID |
| UserId | string | yes | The user ID |
| DeviceType | string | yes | The type of the third-party SIP device: sip_device mcu phone Note: Only the phone type is supported at this stage |

### Invite a SIP device to join a channel
`POST https://apizie.tech/v1/cloud:aliyun-rtc/rtc-sip-invite-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Get it from the console. Pass one ID only |
| ChannelId | string | yes | Channel ID. Pass one ID only |
| Uid | string | yes | User ID |
| DeviceType | string | yes | Device type of the third-party SIP system: sip_device mcu phone Note: Only phone is supported at this time |
| ServerAddress | string | no | IP address of the nearest RTC SIP server. Resolve the domain name rtcsip.dingtalk.com locally to get the nearest address. For example, run… |
| AppToken | string | no | Token required to join the meeting. For sample code, see the referenced document |
| Registered | string | yes | Whether the third-party conferencing system must register before receiving the call |
| SipDisplayName | string | yes | Name displayed for the user on the third-party system |
| SipUserId | string | yes | If DeviceType is mcu, this is the third-party conferencing system. If DeviceType is sip_device, this is the registered device. If the… |
| SipUserPassword | string | no | The registration password for the SipUserId. This parameter is required when a third party registers to receive incoming calls |
| SipRoomId | string | yes | If the device is an MCU, this is the channel number of the third-party conferencing system. If the device is a SIP device, this is the… |
| SipUri | string | no | If the device is an MCU, this is the IP address and port of the third-party conferencing system in the format… |
| SipUserAgent | string | no | Brand or model of the third-party SIP device. Examples: polycom, cisco, tencent, zoom, pstn |
| CallNumber | string | no | Custom line number for PSTN calls |
| TaskId | string | no | Task ID |

### Mute operation
`POST https://apizie.tech/v1/cloud:aliyun-rtc/rtc-sip-mute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and view it in the console. You can specify only one ID |
| ChannelId | string | yes | Existing channel ID. You can specify only one ID |
| Operations | string | yes | Operations to perform (JSON-encoded) |

### Start AI Agent
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and query this ID in the console. Only one application ID is supported |
| ChannelId | string | yes | The ID of the channel to join. Only one channel ID is supported |
| TaskId | string | yes | The task ID |
| TemplateId | string | yes | The template ID |
| RtcConfig | string | yes | The configuration for the agent to join an RTC channel (JSON-encoded) |
| VoiceChatConfig | string | no | The configuration for AI voice chat (JSON-encoded) |

### Starts an event callback
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-category-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |
| Callback | string | yes | The callback (JSON-encoded) |

### Enable intelligent summary
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-cloud-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |
| ChannelId | string | yes | The channel ID |
| TaskId | string | yes | The task ID |
| StorageConfig | string | yes | The storage configuration (JSON-encoded) |
| SourceLanguage | string | no | The source language model for the channel. `cn`: Chinese `yue`: Cantonese `en`: English `multilingual`: Multilingual `ja`: Japanese `ko`:… |
| LanguageHints | string | no | Deprecated. This parameter is no longer used (JSON-encoded) |
| Transcription | string | no | The transcription feature. This feature is enabled by default (JSON-encoded) |
| AutoChapters | string | no | The auto-chapters feature. If enabled, the service generates chapter titles and summaries (JSON-encoded) |
| MeetingAssistance | string | no | The meeting assistance feature. If enabled, the service generates outputs such as keywords, key information, and action items (JSON-encoded) |
| Summarization | string | no | The summarization feature. If enabled, the service generates outputs such as full-text summaries and speaker summaries (JSON-encoded) |
| TextPolish | string | no | The text polishing feature (JSON-encoded) |
| ServiceInspection | string | no | The service quality inspection feature (JSON-encoded) |
| CustomPrompt | string | no | The configuration for custom prompts (JSON-encoded) |
| RealtimeSubtitle | string | no | The configuration for real-time subtitles (JSON-encoded) |

### Start a cloud recording task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-cloud-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. You can create and view the application ID in the console. Only one application ID is supported |
| ChannelId | string | yes | The existing channel ID. Only one channel ID is supported |
| TemplateId | string | yes | The template ID |
| TaskId | string | no | The task ID of this cloud recording task. Only one task ID is supported. The task ID can contain letters, digits, underscores (_), and… |
| CropMode | integer | no | The cropping mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Pad while maintaining the aspect ratio. Default value. 3:… |
| ReservePaneForNoCameraUser | string | no | A placeholder for user panes when no camera stream is pushed. The default value is true, which reserves a pane for users who do not push a… |
| ShowDefaultBackgroundOnMute | string | no | Show the default background image for muted users. true: Show the default background image. Default value. false: Do not show the default… |
| SubHighResolutionStream | string | no | Subscribe to high-resolution streams. false: Subscribe to streams of different resolutions based on the pane area. Default value. true:… |
| StartWithoutChannel | string | no | Start the recording task even if the channel does not exist. true: Yes. false: No. Default value |
| StartWithoutChannelWaitTime | integer | no | The wait time before starting the recording task if the channel does not exist. This parameter takes effect only when StartWithoutChannel… |
| Annotation | string | no | Enable or disable annotation |
| StorageConfig | string | yes | Storage configuration (JSON-encoded) |
| Panes | string | no | Cell configuration settings (JSON-encoded) |
| Images | string | no | Global image watermarks (JSON-encoded) |
| Backgrounds | string | no | Background images (JSON-encoded) |
| Texts | string | no | Global text watermarks (JSON-encoded) |
| ClockWidgets | string | no | Global clock watermarks (JSON-encoded) |
| RegionColor | string | no | The global pane background color (JSON-encoded) |
| BgColor | string | no | The global background color (JSON-encoded) |
| LayoutSpecifiedUsers | string | no | The list of specified users for layout generation. This includes blacklists and whitelists. Whitelist: Subscribes to the video streams of… |
| RecordMode | integer | no | 0: Composite recording. Default value. 1: Individual recording. Individual recording does not support updates |
| SingleStreamingRecord | string | no | Parameters for individual recording (JSON-encoded) |

### Starts a bypass live streaming task by calling StartMPUTask
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-mputask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| SubSpecUsers | string | no | The list of users that this task subscribes to (JSON-encoded) |
| SubSpecAudioUsers | string | no | Specifies which users' audio streams to subscribe to in the room (JSON-encoded) |
| SubSpecShareScreenUsers | string | no | Specifies which users' screen sharing video streams to subscribe to in the room (JSON-encoded) |
| SubSpecCameraUsers | string | no | Specifies which users' camera video streams to subscribe to in the room (JSON-encoded) |
| UnsubSpecAudioUsers | string | no | Specifies which users' audio streams to unsubscribe from in the room (JSON-encoded) |
| UnsubSpecShareScreenUsers | string | no | Specifies which users' screen sharing video streams to unsubscribe from in the room (JSON-encoded) |
| UnsubSpecCameraUsers | string | no | Specifies which users' camera video streams to unsubscribe from in the room (JSON-encoded) |
| LayoutIds | string | no | The layout ID data (JSON-encoded) |
| UserPanes | string | no | The list of layout parameters (JSON-encoded) |
| Backgrounds | string | no | The list of canvas background image placeholders (JSON-encoded) |
| Watermarks | string | no | The list of watermark image placeholders (JSON-encoded) |
| ClockWidgets | string | no | The clock widgets (JSON-encoded) |
| AppId | string | yes | The application ID. Only a single ID is supported. You can create and query applications in the console |
| ChannelId | string | yes | The channel ID. Only a single ID is supported |
| TaskId | string | yes | The task ID. Only a single ID is supported. The ID can contain uppercase and lowercase letters, digits, underscores (_), and hyphens (-),… |
| MixMode | integer | no | The stream mixing mode. Valid values: 0: single-stream relay. The original single stream is relayed without mixing or transcoding. You do… |
| CropMode | integer | no | The video cropping mode. Valid values: 1: crops the video while maintaining the aspect ratio. 2: adds padding while maintaining the aspect… |
| MediaEncode | integer | no | The encoding option. For more information, see the MediaEncode enumeration values below |
| SourceType | string | no | The video input stream of the user in single-stream relay mode. Valid values: camera: camera. shareScreen: screen sharing |
| StreamType | integer | no | The audio stream relay type in single-stream relay mode. Valid values: 0: relays the original stream. 1: relays only the audio stream. 2:… |
| BackgroundColor | integer | no | The background color in RGB. Default value: 0 (black). The formula is `R + G × 256 + B × 65536`, where R (red), G (green), and B (blue)… |
| StreamURL | string | no | The live stream ingest URL. Only a single URL is supported. For information about how to generate the URL, see… |
| PayloadType | integer | no | The payload type. Valid values: 0: no payload. 1: VideoSEI |
| ReportVad | integer | no | The voice activity detection (VAD) flag. Valid values: 0: does not transmit VAD information. 1: transmits VAD information |
| RtpExtInfo | integer | no | The RTP extension header information. Valid values: 0: does not transmit. 1: transmits |
| TimeStampRef | integer | no | The timestamp |
| VadInterval | integer | no | The callback interval for voice activity detection |
| TaskType | integer | no | The media processing type. Valid values: 0: bypass live streaming task. 1: MCU stream mixing low-latency distribution task |
| EnhancedParam | string | no | The enhanced parameter (JSON-encoded) |

### Call StartRecordTask to record a video task
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-record-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| SubSpecUsers | string | no | Specifies the list of users to which this task is subscribed (JSON-encoded) |
| SubSpecAudioUsers | string | no | Specifies the audio streams of which users in the room to subscribe to (JSON-encoded) |
| SubSpecShareScreenUsers | string | no | Specifies the screen-sharing streams of which users in the room to subscribe to (JSON-encoded) |
| SubSpecCameraUsers | string | no | Specifies the camera streams of which users in the room to subscribe to (JSON-encoded) |
| UnsubSpecAudioUsers | string | no | Specifies the audio streams of which users in the room not to subscribe to (JSON-encoded) |
| UnsubSpecShareScreenUsers | string | no | Specifies the screen-sharing streams of which users in the room not to subscribe to (JSON-encoded) |
| UnsubSpecCameraUsers | string | no | Specifies the camera streams of which users in the room not to subscribe to (JSON-encoded) |
| UserPanes | string | no | The list of layout parameters (JSON-encoded) |
| LayoutIds | string | no | The layout ID group (JSON-encoded) |
| AppId | string | yes | The application ID. It is created and queried in the console. Only a single ID can be passed in |
| ChannelId | string | yes | The channel ID. Only a single ID can be passed in |
| TaskId | string | yes | The task ID. Only a single ID can be passed in. It must be unique. It consists of 1 to 55 characters, including uppercase letters,… |
| TaskProfile | string | no | The task billing configuration. Fees are charged based on your different settings. See the TaskProfile enumeration values below. The… |
| MediaEncode | integer | no | The encoding option. See the MediaEncode enumeration values below |
| TemplateId | string | yes | The configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html |
| SourceType | string | no | The video source in single-stream recording mode. Valid values: camera: The camera. shareScreen: The screen sharing. If the video source… |
| StreamType | integer | no | The single-stream recording mode. Valid values: 0 (default): Record the original stream. 1: Record only the audio stream |
| MixMode | integer | no | The recording mode. Valid values: 0: Single-stream recording. The task parameters cannot be modified in the middle of recording (the… |
| CropMode | integer | no | The video cropping mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Add borders while maintaining the aspect ratio… |

### StartStreamingOut
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-streaming-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID, created and queried via the console. Only a single ID is supported |
| ChannelId | string | yes | An existing channel ID. Only a single ID is supported |
| TemplateId | string | yes | Template ID. |
| Url | string | yes | Live ingest URL. Only a single URL is supported. This URL cannot be used by multiple jobs simultaneously |
| TaskId | string | no | The task ID of this bypass stream ingest job. Only a single ID is supported. It can contain uppercase and lowercase letters, digits,… |
| CropMode | integer | no | Crop mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Maintain aspect ratio with padding (Default Value). 3: Stretch to… |
| ReservePaneForNoCameraUser | string | no | Reserve pane for users who do not publish camera streams. The default value is true, which means a pane is reserved for users who do not… |
| ShowDefaultBackgroundOnMute | string | no | Whether to display the default pane background when muted. true: Display (default value) false: Do not display (the configured local pane… |
| SubHighResolutionStream | string | no | Subscribe to a high resolution stream. false: Subscribe to streams with different resolutions based on the pane area. (Default Value)… |
| StartWithoutChannel | string | no | Whether to allow starting a job when the channel does not exist. true: Yes false: No (default value) |
| StartWithoutChannelWaitTime | integer | no | This value is valid only when the StartWithoutChannel parameter is true. It specifies the maximum time, in seconds, that a job waits if… |
| Annotation | string | no | Toggle for annotation |
| Panes | string | no | Cell settings. (JSON-encoded) |
| Backgrounds | string | no | Background image (JSON-encoded) |
| Images | string | no | Global image watermark. (JSON-encoded) |
| Texts | string | no | Global text watermark (JSON-encoded) |
| ClockWidgets | string | no | Global clock watermark (JSON-encoded) |
| RegionColor | string | no | Global grid background color (JSON-encoded) |
| BgColor | string | no | Global background color (JSON-encoded) |
| LayoutSpecifiedUsers | string | no | The layout generation uses a user-specified list, which includes both blacklist and whitelist. Whitelist: specifies which users' video… |
| SpecMixedUserList | string | no | List of users specified to be included in audio mixing (JSON-encoded) |

### Start stream composition
`POST https://apizie.tech/v1/cloud:aliyun-rtc/start-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. Create and view it in the console. Pass only one ID |
| ChannelId | string | yes | Existing channel ID. Pass only one ID |
| TemplateId | string | yes | Template ID |
| TaskId | string | yes | Task ID for this request. Pass only one ID. Use uppercase letters, lowercase letters, digits, underscores (_), or hyphens (-). Maximum… |
| CropMode | integer | no | Cropping mode. Valid values: 1: Crop while preserving aspect ratio. 2: Pad while preserving aspect ratio (default). 3: Stretch to fill |
| StartWithoutChannel | string | no | Whether to start the task even if the channel does not exist. true: Yes false: No (default) |
| StartWithoutChannelWaitTime | integer | no | Time to wait for the channel to become available, in seconds. This parameter applies only when StartWithoutChannel is true. Valid range:… |
| RegionColor | string | no | Background color of the global frame (JSON-encoded) |
| BgColor | string | no | Global background color (JSON-encoded) |
| ViewSubscribers | string | no | List of user IDs for SIP devices that can view the main stream or screen-sharing stream (JSON-encoded) |
| ViewContent | string | no | Stream type. main: Main stream screen-cast: Screen-sharing stream |

### Stops an AI Agent
`POST https://apizie.tech/v1/cloud:aliyun-rtc/stop-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID. Only a single ID is supported. You can create and query applications in the console |
| ChannelId | string | yes | The channel to join. Only a single ID is supported |
| TaskId | string | yes | The task ID. Only a single ID is supported |

### Shuts down an event callback
`POST https://apizie.tech/v1/cloud:aliyun-rtc/stop-category-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID |
| Callback | string | yes | The callback (JSON-encoded) |

### This API is used by the server to actively shut down a channel.
`POST https://apizie.tech/v1/cloud:aliyun-rtc/stop-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | Application ID. You can create and query it in the console. Only a single ID is supported. |
| ChannelId | string | yes | An existing channel ID. Only a single ID is supported. |

### Stop Intelligent Summary
`POST https://apizie.tech/v1/cloud:aliyun-rtc/stop-cloud-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| ClientToken | string | no | Idempotency parameter |
| AppId | string | yes | The application ID. |
| ChannelId | string | yes | The channel name. |
| TaskId | string | yes | The job ID. |

### StopCloudRecord
`POST https://apizie.tech/v1/cloud:aliyun-rtc/stop-cloud-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rtc.aliyuncs.com |
| AppId | string | yes | The application ID, created and queried via the console. Only a single ID is supported |
| ChannelId | string | yes | The existing channel ID. Only a single ID is supported |
| TaskId | string | yes | The existing cloud recording job ID. Only a single ID is supported |

…and 12 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-rtc/add-record-template" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Real-Time Communication API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-rtc/add-record-template with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Real-Time Communication API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Real-Time Communication itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Real-Time Communication API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-rtc.

### What is the status of the Alibaba Cloud Real-Time Communication API?
Needs your own provider key (bring your own key)