{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-rtc/add-record-template":{"post":{"operationId":"cloud_aliyun_rtc_add_record_template","summary":"Calls AddRecordTemplate to add a recording configuration template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LayoutIds","Formats","AppId","Name","TaskProfile","MediaEncode","OssBucket","OssFilePrefix","FileSplitInterval"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"LayoutIds":{"type":"string","description":"List of layout ID data (JSON-encoded)"},"Formats":{"type":"string","description":"List of recording file formats (JSON-encoded)"},"Backgrounds":{"type":"string","description":"List of background images (JSON-encoded)"},"Watermarks":{"type":"string","description":"List of watermarks (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"List of clocks (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Created and queried via the console. Only a single ID is supported"},"Name":{"type":"string","description":"Recording configuration template name"},"TaskProfile":{"type":"string","description":"Task billing configuration. Charges vary based on your settings. See the TaskProfile enumeration values below. The resolution of the…"},"MediaEncode":{"type":"integer","description":"Encoding option. See the MediaEncode enumeration values below"},"BackgroundColor":{"type":"integer","description":"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":{"type":"string","description":"OSS bucket where the recording files are stored. Currently, only OSS buckets in the Shanghai region are supported"},"OssFilePrefix":{"type":"string","description":"Naming rule for recording files. To ensure that recording file names are unique, the current naming rule is…"},"FileSplitInterval":{"type":"integer","description":"Recording file split duration (greater than or equal to 1800). Unit: seconds"},"DelayStopTime":{"type":"integer","description":"Delay time before stopping recording. Unit: seconds. Default value: 180 seconds"},"MnsQueue":{"type":"string","description":"Message queue for recording event callbacks. One and only one of this parameter and HttpCallbackUrl must be provided; you cannot provide…"},"HttpCallbackUrl":{"type":"string","description":"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":{"type":"string","description":"Whether the recorded m3u8 file needs to include the timestamp of the ts file"},"OssEndpoint":{"type":"string","description":"The OssEndpoint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-app-agent-template":{"post":{"operationId":"cloud_aliyun_rtc_create_app_agent_template","summary":"Create an application agent template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Name"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can find this ID in the console. Only a single ID is supported"},"Name":{"type":"string","description":"The template name"},"Type":{"type":"integer","enum":["1"],"description":"The agent type. `1`: Voice call (default)"},"ChatMode":{"type":"integer","enum":["1","2"],"description":"The chat mode. `1`: Natural Conversation Mode (default) `2`: Walkie-talkie Mode"},"InterruptMode":{"type":"integer","enum":["1","2"],"description":"The interrupt mode. `1`: Allows interruption (default) `2`: Disallows interruption"},"Greeting":{"type":"string","description":"The greeting message. Maximum length: 500 characters"},"AsrConfig":{"type":"string","description":"The speech-to-text settings (JSON-encoded)"},"LlmConfig":{"type":"string","description":"The large language model (LLM) settings (JSON-encoded)"},"TtsConfig":{"type":"string","description":"The text-to-speech settings (JSON-encoded)"},"AgentSilenceConfig":{"type":"string","description":"The configuration for handling agent silence (JSON-encoded)"},"AmbientSoundConfig":{"type":"string","description":"The configuration for ambient sound. This feature is disabled by default (JSON-encoded)"},"InterruptConfig":{"type":"string","description":"The configuration for agent interruption (JSON-encoded)"},"BackChannelConfig":{"type":"string","description":"The configuration for agent backchannel (JSON-encoded)"},"EnableVideoUnderstanding":{"type":"string","description":"Specifies whether to enable video understanding. If enabled, the LLM must support multimodal input"},"PreferVideo":{"type":"integer","description":"If video understanding is enabled, this parameter specifies which video stream the agent processes. Since the agent can only process one…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-app-layout":{"post":{"operationId":"cloud_aliyun_rtc_create_app_layout","summary":"Create a custom app layout","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Layout"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency token"},"AppId":{"type":"string","description":"Application ID. Find or create this ID in the console. You can specify only one ID"},"Layout":{"type":"string","description":"Layout configuration (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-app-record-template":{"post":{"operationId":"cloud_aliyun_rtc_create_app_record_template","summary":"Adds an application recording template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RecordTemplate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency token"},"RecordTemplate":{"type":"string","description":"Recording template (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Create and view this ID in the console. Only one ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-app-streaming-out-template":{"post":{"operationId":"cloud_aliyun_rtc_create_app_streaming_out_template","summary":"Create an RTC 3.0 application stream ingest template.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StreamingOutTemplate"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported"},"StreamingOutTemplate":{"type":"string","description":"Template (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-app-view-template":{"post":{"operationId":"cloud_aliyun_rtc_create_app_view_template","summary":"Create an application composite streaming template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Template"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and view this ID in the console. Only one ID is supported"},"Template":{"type":"string","description":"The template (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_create_auto_live_stream_rule","summary":"Calls CreateAutoLiveStreamRule to create an automatic single-stream relay rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","PlayDomain"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ChannelIds":{"type":"string","description":"The list of channel IDs that are exactly matched (JSON-encoded)"},"ChannelIdPrefixes":{"type":"string","description":"The list of channel ID prefixes that are fuzzy matched (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID, which can be created and queried in the console"},"PlayDomain":{"type":"string","description":"The streaming domain name for automatic relay. The streaming URL of an automatic relay task is in the format…"},"RuleName":{"type":"string","description":"The name of the relay rule"},"CallBack":{"type":"string","description":"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":{"type":"integer","description":"The encoding option. For more information, see the MediaEncode enumeration values below"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-cloud-note-phrases":{"post":{"operationId":"cloud_aliyun_rtc_create_cloud_note_phrases","summary":"Add a keyword list to the meeting minutes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Phrase"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and view this ID in the console. Only one ID is supported"},"Phrase":{"type":"string","description":"The hotword parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-event-subscribe":{"post":{"operationId":"cloud_aliyun_rtc_create_event_subscribe","summary":"Calls CreateEventSubscribe to create a callback for subscribing to room messages","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Events","AppId","CallbackUrl","ClientToken"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"Users":{"type":"string","description":"The subscribed users (JSON-encoded)"},"Events":{"type":"string","description":"The subscribed events (JSON-encoded)"},"AppId":{"type":"string","description":"The ID of the subscribed application"},"ChannelId":{"type":"string","description":"The ID of the subscribed channel. This parameter is required if the Users.N parameter is not empty"},"CallbackUrl":{"type":"string","description":"The callback URL. For information about the callback content, see the following callback content example"},"ClientToken":{"type":"string","description":"The idempotence identifier used by the client to create the subscription"},"NeedCallbackAuth":{"type":"string","description":"Specifies whether to enable callback authentication. Valid values: true: enables callback authentication. fasle (default): disables…"},"Role":{"type":"integer","description":"The user role. Valid values: 1: subscribes to host messages in the channel. 2: subscribes to audience messages in the channel. Empty or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/create-mpulayout":{"post":{"operationId":"cloud_aliyun_rtc_create_mpulayout","summary":"Calls CreateMPULayout to create a stream relay layout","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Panes","AppId","AudioMixCount"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"Panes":{"type":"string","description":"The list of panes in the layout (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. Only a single ID can be passed. You can create and query the application ID in the console"},"Name":{"type":"string","description":"The name of the layout"},"AudioMixCount":{"type":"integer","description":"The maximum number of audio mixes. Valid values: 0 to 6"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-app-agent-template":{"post":{"operationId":"cloud_aliyun_rtc_delete_app_agent_template","summary":"Deletes an application agent template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Id"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and query using the console. Pass only a single ID"},"Id":{"type":"string","description":"Template ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-app-layout":{"post":{"operationId":"cloud_aliyun_rtc_delete_app_layout","summary":"Delete a custom application layout","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"An idempotency token"},"AppId":{"type":"string","description":"The application ID. Create and query this ID in the console. Only one ID is supported per request"},"Layout":{"type":"string","description":"Layout information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-app-record-template":{"post":{"operationId":"cloud_aliyun_rtc_delete_app_record_template","summary":"Delete an application recording template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Template"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency token"},"AppId":{"type":"string","description":"Application ID. Create and view this ID in the console. Only one ID is supported"},"Template":{"type":"string","description":"Template information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-app-streaming-out-template":{"post":{"operationId":"cloud_aliyun_rtc_delete_app_streaming_out_template","summary":"Delete an RTC 3.0 application stream ingest template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StreamingOutTemplate"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported"},"StreamingOutTemplate":{"type":"string","description":"Template information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-app-view-template":{"post":{"operationId":"cloud_aliyun_rtc_delete_app_view_template","summary":"Deletes an application's composite stream template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Template"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query the ID in the console. Only a single ID can be specified"},"Template":{"type":"string","description":"The template information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_delete_auto_live_stream_rule","summary":"Calls DeleteAutoLiveStreamRule to delete an automatic single-stream relay rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RuleId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which can be created and queried in the console"},"RuleId":{"type":"integer","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-channel":{"post":{"operationId":"cloud_aliyun_rtc_delete_channel","summary":"Calls DeleteChannel to delete a channel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is created and queried in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The ID of the channel that has been joined. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-cloud-note-phrases":{"post":{"operationId":"cloud_aliyun_rtc_delete_cloud_note_phrases","summary":"Delete the hot words list for meeting minutes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Phrase"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and view it in the console. You can specify only one ID"},"Phrase":{"type":"string","description":"The keywords list parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-event-subscribe":{"post":{"operationId":"cloud_aliyun_rtc_delete_event_subscribe","summary":"Deletes a callback for subscribing to room messages by calling DeleteEventSubscribe","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","SubscribeId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query applications in the console"},"SubscribeId":{"type":"string","description":"The subscription ID. For more information, see https://help.aliyun.com/document_detail/274447.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-mpulayout":{"post":{"operationId":"cloud_aliyun_rtc_delete_mpulayout","summary":"Calls DeleteMPULayout to delete an MPU (Mixed Push Unit) layout for stream relay to CDN","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LayoutId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Only a single ID can be passed. You can create and query the ID in the console"},"LayoutId":{"type":"integer","description":"The layout ID. Only a single ID can be passed. To obtain the layout ID, see https://help.aliyun.com/document_detail/162192.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/delete-record-template":{"post":{"operationId":"cloud_aliyun_rtc_delete_record_template","summary":"Calls the DeleteRecordTemplate operation to delete a recording configuration template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is created and queried in the console. Only a single ID can be specified"},"TemplateId":{"type":"string","description":"The configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-all-callback":{"post":{"operationId":"cloud_aliyun_rtc_describe_all_callback","summary":"Lists the event callbacks supported by the system","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-agent-function-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_agent_function_status","summary":"Query the status of the application agent feature","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it in the console. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-agent-templates":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_agent_templates","summary":"Application agent templates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can find this ID in the console. Only a single ID is supported"},"Name":{"type":"string","description":"The template name"},"Id":{"type":"string","description":"The template ID"},"PageNum":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The page size"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-call-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_call_status","summary":"View application callback toggle","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-callback-secret-key":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_callback_secret_key","summary":"Obtain the application callback key","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-key":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_key","summary":"Invoke DescribeAppKey to query the AppKey of a specified application.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query this ID in the console. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-layouts":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_layouts","summary":"Query custom application layouts","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it using the console. Only a single ID is supported"},"PageNum":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"Condition":{"type":"string","description":"The query conditions (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-live-stream-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_live_stream_status","summary":"View the application bypass switch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"A parameter that ensures the idempotence of the request"},"AppId":{"type":"string","description":"The ID of the application. You can create and query the application ID in the console. You can specify only one application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-record-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_record_status","summary":"Queries the recording status of an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency token"},"AppId":{"type":"string","description":"Application ID. You can create and view this ID in the console. Only one ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-record-templates":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_record_templates","summary":"Lists application recording templates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency token"},"AppId":{"type":"string","description":"Application ID. Find or create this ID in the console. You can specify only one ID"},"PageNum":{"type":"integer","description":"Page number. Default is 1"},"PageSize":{"type":"integer","description":"Number of items per page. Default is 10"},"Condition":{"type":"string","description":"Query conditions (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-recording-files":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_recording_files","summary":"Lists recording files","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"App ID"},"ChannelId":{"type":"string","description":"Channel ID"},"PageNo":{"type":"integer","description":"Page number"},"PageSize":{"type":"integer","description":"Number of entries per page"},"StartTs":{"type":"integer","description":"Query range start time (open interval) for recording tasks, in milliseconds. If not specified, defaults to the past 3 days. You can query…"},"EndTs":{"type":"integer","description":"The query range specifies the start time of the recording task. It is defined as a closed interval and measured in milliseconds (ms)"},"TaskIds":{"type":"string","description":"List of recording task IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-streaming-out-templates":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_streaming_out_templates","summary":"Query the list of stream ingest templates under an RTC 3.0 application.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID, created and queried through the console. Only a single ID is supported"},"PageNum":{"type":"integer","description":"Page number. By default, page 1 is queried"},"PageSize":{"type":"integer","description":"Number of entries per page. The default value is 10"},"Condition":{"type":"string","description":"Search condition (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-view-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_view_status","summary":"View the stream merging switch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. You can create and find the application ID in the console. Only one ID can be specified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-app-view-templates":{"post":{"operationId":"cloud_aliyun_rtc_describe_app_view_templates","summary":"Lists application compositing templates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and view it in the console. You can specify only one ID"},"PageNum":{"type":"integer","description":"Page number. Default value: 1"},"PageSize":{"type":"integer","description":"Number of entries per page. Default value: 10"},"Condition":{"type":"string","description":"Search condition (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-apps":{"post":{"operationId":"cloud_aliyun_rtc_describe_apps","summary":"Invoke DescribeApps to query the application list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID, created and queried via the console. Only a single ID is supported. An empty parameter indicates querying all application…"},"Status":{"type":"string","description":"Application status. An empty parameter indicates querying applications in all statuses. Valid values: 1: Active. 2: Disabled. 3: Disabled…"},"Order":{"type":"string","description":"Sorting method. Valid values: asc: Increment. desc (default): Decrement"},"PageNum":{"type":"integer","description":"Page number. By default, page 1 is queried"},"PageSize":{"type":"integer","description":"Number of entries per page. Default value is 10"},"AppVersion":{"type":"string","enum":["2.0","3.0"],"description":"Application Version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_describe_auto_live_stream_rule","summary":"Calls the DescribeAutoLiveStreamRule operation to query an automatic live stream relay rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query it in the console"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-call":{"post":{"operationId":"cloud_aliyun_rtc_describe_call","summary":"This API is used to query the details of a single communication session. For example, you can query the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"Channel creation time. Supports querying data from the last 30 days, represented as a UNIX timestamp, in seconds. The channel creation…"},"DestroyedTs":{"type":"integer","description":"Channel release time, represented as a UNIX timestamp, in seconds. If the parameter is empty, the current time is used. If the provided…"},"ExtDataType":{"type":"string","description":"The extension to query. Valid value: USER_DURATION_STAT: user duration statistics data type"},"QueryExpInfo":{"type":"string","description":"Specifies whether to query communication experience information. If this parameter is not specified, the default value is true."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-call-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_call_list","summary":"Invoke DescribeCallList to perform a paged query of communication records created within a specified time…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StartTs","EndTs","PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"StartTs":{"type":"integer","description":"Start Time of the query, represented as a UNIX timestamp in seconds"},"EndTs":{"type":"integer","description":"The end time of the query, expressed as a UNIX timestamp. Unit: seconds"},"ChannelId":{"type":"string","description":"Channel ID"},"UserId":{"type":"string","description":"User ID"},"CallStatus":{"type":"string","description":"Call status. Valid values: IN: In progress. OUT: Ended"},"OrderBy":{"type":"string","description":"Sorting field. Valid values: BAD_EXP_USER_COUNT_DESC: Sort by the number of users with poor experience in descending order.…"},"QueryMode":{"type":"string","description":"Query mode. Valid values: ALL: All calls. FOLLOW: Followed calls"},"PageNo":{"type":"integer","description":"Page number. Minimum value: 1. Maximum value: 200"},"PageSize":{"type":"integer","description":"Quantity per page, minimum value is 1, maximum value is 200"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-callbacks":{"post":{"operationId":"cloud_aliyun_rtc_describe_callbacks","summary":"Lists the event callbacks configured for an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel","summary":"DescribeChannel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query this ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The channel ID to query. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-all-users":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_all_users","summary":"This API is used to query the user list in a channel.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query this ID in the console. Only a single ID is supported."},"ChannelId":{"type":"string","description":"Channel ID to query. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-area-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_area_distribution_stat_data","summary":"This API is used to obtain the statistics on the regional distribution of channels","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"channel ID"},"CreatedTs":{"type":"integer","description":"Timestamp of channel creation. Supports querying data from the last 30 days. Represented as a UNIX timestamp in seconds."},"DestroyedTs":{"type":"integer","description":"Channel release time, represented as a UNIX timestamp in seconds. If the parameter is empty, the current time is used. If the provided…"},"ParentArea":{"type":"string","description":"Parent region name. For example, the parent of Shenzhen City is Guangdong Province. If the parameter is empty, statistics are returned at…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_distribution_stat_data","summary":"This API is used to obtain channel distribution statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","StatDim"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"channel ID"},"CreatedTs":{"type":"integer","description":"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":{"type":"integer","description":"Channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the provided…"},"StatDim":{"type":"string","description":"Statistical dimension. Valid values: OS: Statistics by operating system. SDK_VERSION: Statistics by SDK version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-overall-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_overall_data","summary":"This API is used to query channel overview data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"UNIX timestamp indicating the channel creation time. Supports querying data from the last 30 days. Expressed as a UNIX timestamp in seconds"},"DestroyedTs":{"type":"integer","description":"Channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the provided…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-participants":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_participants","summary":"Queries the list of online users in a channel. The response does not include detailed user information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and view this ID in the Alibaba Cloud console. Only one ID is supported"},"ChannelId":{"type":"string","description":"The channel ID. Only one ID is supported"},"Order":{"type":"string","description":"The sort order. Valid values: asc: ascending. desc (default): descending"},"PageNum":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of users per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-top-pub-user-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_top_pub_user_list","summary":"This API is used to retrieve the list of publishing users in a channel, sorted in descending order by their…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"The UNIX timestamp of channel creation. Supports querying data from the last 30 days, expressed as a UNIX timestamp in seconds"},"DestroyedTs":{"type":"integer","description":"The UNIX timestamp indicating when the channel was released, in seconds. If this parameter is empty, data up to the current time will be…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-user":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_user","summary":"DescribeChannelUser","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query this ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"Channel ID to query. Only a single ID is supported"},"UserId":{"type":"string","description":"User ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-user-metrics":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_user_metrics","summary":"[responses_200_schema_properties_MetricDatas_description]List of metric data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID."},"CreatedTs":{"type":"integer","description":"The UNIX timestamp indicating when the channel was created. Data from the last 30 days is supported. The timestamp is expressed in seconds."},"DestroyedTs":{"type":"integer","description":"The UNIX timestamp indicating when the channel was released, in seconds. If this parameter is empty, the current time is used. If the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channel-users":{"post":{"operationId":"cloud_aliyun_rtc_describe_channel_users","summary":"Queries the list of real-time online users in a channel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query the ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The ID of the channel to query. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-channels":{"post":{"operationId":"cloud_aliyun_rtc_describe_channels","summary":"This operation retrieves a list of all active channels for a single AppId","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You create and view this ID in the console. Only one ID is supported"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-cloud-note-phrases":{"post":{"operationId":"cloud_aliyun_rtc_describe_cloud_note_phrases","summary":"Summary of trending terms","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Obtain the ID from the console. Only a single ID can be specified"},"PageNum":{"type":"integer","description":"The page number. The default value is 1"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. The default value is 10"},"Condition":{"type":"string","description":"The query condition (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-cloud-notes":{"post":{"operationId":"cloud_aliyun_rtc_describe_cloud_notes","summary":"Meeting Summary List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"PageNo":{"type":"integer","description":"Page number."},"PageSize":{"type":"integer","description":"Number of items per page."},"StartTs":{"type":"integer","description":"Query range, open interval of job start time, in milliseconds. If not specified, defaults to querying recordings from the last 3 days,…"},"EndTs":{"type":"integer","description":"Query range, closed interval of job start time, in milliseconds."},"TaskIds":{"type":"string","description":"List of job TaskIds. (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-cloud-record-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_cloud_record_status","summary":"Query the status of a recording task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"ChannelId":{"type":"string","description":"The channel name"},"TaskId":{"type":"string","description":"The task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-end-point-event-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_end_point_event_list","summary":"This API is used to retrieve the end-to-end user management event List","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","UserIdList"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"channel ID"},"CreatedTs":{"type":"integer","description":"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":{"type":"integer","description":"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":{"type":"string","description":"List of User IDs, separated by commas (,)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-end-point-metric-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_end_point_metric_data","summary":"This API is used to obtain end-to-end metric data.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","Metrics"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"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":{"type":"integer","description":"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":{"type":"string","description":"Subscriber User ID"},"PubUserId":{"type":"string","description":"User ID of the publisher. You can specify either the PubUserId parameter or the PubCallIdList parameter, but not both"},"PubCallIdList":{"type":"string","description":"Call IDs of the publisher's communication streams, separated by English commas (,). You must specify either PubUserId or PubCallIdList,…"},"Metrics":{"type":"string","description":"Enumeration list of Metrics, separated by commas (,)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-fault-diagnosis-factor-distribution-stat":{"post":{"operationId":"cloud_aliyun_rtc_describe_fault_diagnosis_factor_distribution_stat","summary":"Invoke the DescribeFaultDiagnosisFactorDistributionStat API to obtain the distribution of factors impacting…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StartTs","EndTs"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"StartTs":{"type":"integer","description":"Start Time of the query, expressed as a UNIX timestamp. Unit: seconds"},"EndTs":{"type":"integer","description":"End Time of the query, expressed as a UNIX timestamp. Unit: seconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-fault-diagnosis-overall-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_fault_diagnosis_overall_data","summary":"Invoke DescribeFaultDiagnosisOverallData to obtain the overview data for abnormal diagnosis.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StartTs","EndTs","StatDim"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"StartTs":{"type":"integer","description":"Start Time of the query, represented as a UNIX timestamp in seconds"},"EndTs":{"type":"integer","description":"End Time of the query, represented as a UNIX timestamp in seconds"},"StatDim":{"type":"string","description":"Dimension for Data Statistics. Valid values: JOIN_SLOW_USER: User Count with slow channel joining. AUDIO_STUCK_USER: User Count…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-fault-diagnosis-user-detail":{"post":{"operationId":"cloud_aliyun_rtc_describe_fault_diagnosis_user_detail","summary":"[responses_200_schema_properties_UserDetail_properties_Duration_type]integer","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","UserId","FaultType"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"频道ID"},"CreatedTs":{"type":"integer","description":"频道创建时间，使用UNIX时间戳表示，单位：秒"},"UserId":{"type":"string","description":"用户ID"},"FaultType":{"type":"string","description":"异常类型。取值： JOIN_SLOW：进频道慢 。 AUDIO_STUCK：音频卡顿。 VIDEO_STUCK：视频卡顿。 VIDEO_VAGUE：视频模糊。 HIGH_DELAY：通话延迟高 。 FIRST_FRAME_SLOW：接收首屏慢"},"QueryCallUserInfo":{"type":"string","description":"是否查询通话用户信息，为空默认是false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-fault-diagnosis-user-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_fault_diagnosis_user_list","summary":"Invoke DescribeFaultDiagnosisUserList to obtain the list of user details for abnormal diagnosis","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StartTs","EndTs","PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"StartTs":{"type":"integer","description":"The query start time, represented as a UNIX timestamp in seconds."},"EndTs":{"type":"integer","description":"The query end time, represented as a UNIX timestamp in seconds"},"ChannelId":{"type":"string","description":"Channel ID to search for"},"UserId":{"type":"string","description":"User ID to search for"},"FaultTypes":{"type":"string","description":"Abnormal types to filter. Separate multiple values with English commas (,). Valid values: JOIN_SLOW: Slow channel joining. AUDIO_STUCK:…"},"PageNo":{"type":"integer","description":"Page number"},"PageSize":{"type":"integer","description":"Number of entries per page."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-mpulayout-info-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_mpulayout_info_list","summary":"Call DescribeMPULayoutInfoList to retrieve layout parameters for a bypass live streaming task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can specify only one ID. Create or view IDs in the console"},"LayoutId":{"type":"integer","description":"Layout ID. To get a layout ID, see https://help.aliyun.com/document_detail/162192.html"},"Name":{"type":"string","description":"Layout name"},"PageNum":{"type":"integer","description":"Page number. Default value: 1"},"PageSize":{"type":"integer","description":"Number of entries per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-pub-user-list-by-sub-user":{"post":{"operationId":"cloud_aliyun_rtc_describe_pub_user_list_by_sub_user","summary":"This API is used to obtain the list of publishing users in a communication session based on the subscriber","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","SubUserId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"The channel creation time. You can query data from the last 30 days. The value is represented as a UNIX timestamp in seconds"},"DestroyedTs":{"type":"integer","description":"The channel release time, represented as a UNIX timestamp in seconds. If this parameter is empty, the current time is used. If the…"},"SubUserId":{"type":"string","description":"Subscriber User ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-qoe-metric-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_qoe_metric_data","summary":"This API is used to obtain the downlink experience quality metrics of a user in a single communication…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","CreatedTs","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"APP ID"},"ChannelId":{"type":"string","description":"Channel ID"},"CreatedTs":{"type":"integer","description":"Channel Creation Time. Supports querying data from the last 30 days. Represented as a UNIX timestamp in seconds"},"DestroyedTs":{"type":"integer","description":"Channel release time, represented as a UNIX timestamp in seconds. An empty parameter indicates retrieving data up to the current time. If…"},"UserId":{"type":"string","description":"User ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-quality-area-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_quality_area_distribution_stat_data","summary":"This API is used to obtain the regional distribution data of quality statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"Start Time of the query, represented as a UNIX timestamp in seconds."},"EndDate":{"type":"integer","description":"End Time of the query, represented as a UNIX timestamp in seconds."},"ParentArea":{"type":"string","description":"Parent area name. For example, the parent of Hangzhou City is Zhejiang Province, and the parameter value should be China_Zhejiang…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-quality-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_quality_distribution_stat_data","summary":"This API is used to obtain the distribution data of quality statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","StatDim","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"Start Time of the query, expressed as a UNIX timestamp in seconds."},"EndDate":{"type":"integer","description":"End Time of the query, expressed as a UNIX timestamp in seconds."},"StatDim":{"type":"string","description":"Statistical dimension. Valid values: CHANNEL_ONLINE: Statistics by channel online participant count. NETWORK: Statistics by network type.…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-quality-os-sdk-version-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_quality_os_sdk_version_distribution_stat_data","summary":"This API is used to obtain the distribution data of operating systems and SDK versions in quality statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"Start Time of the query, represented as a UNIX timestamp, in seconds."},"EndDate":{"type":"integer","description":"End Time of the query, represented as a UNIX timestamp, in seconds."},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-quality-overall-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_quality_overall_data","summary":"This API is used to obtain overview data of quality statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","Types","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"The Start Time of the query, represented as a UNIX timestamp in seconds"},"EndDate":{"type":"integer","description":"The End Time of the query, represented as a UNIX timestamp in seconds"},"Types":{"type":"string","description":"The Metric Types to query, separated by commas (,). Valid values: JOIN_CHANNEL_SUC_RATE: Channel Join Success Rate.…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-record-files":{"post":{"operationId":"cloud_aliyun_rtc_describe_record_files","summary":"Calls DescribeRecordFiles to query the list of files generated by recording","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"TaskIds":{"type":"string","description":"Recording task ID (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. Only a single ID can be passed. You can create and query it in the console"},"ChannelId":{"type":"string","description":"The channel ID. Only a single ID can be passed"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default value: 10. Maximum value: 100"},"PageNum":{"type":"integer","description":"The page number. By default, the first page is queried"},"StartTime":{"type":"string","description":"The start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC time)"},"EndTime":{"type":"string","description":"The end time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC time)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-record-templates":{"post":{"operationId":"cloud_aliyun_rtc_describe_record_templates","summary":"Queries a list of recording template configurations by calling the DescribeRecordTemplates operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"TemplateIds":{"type":"string","description":"The list of template IDs to query. The format is as follows: ``` TemplateIds.1=**** TemplateIds.2=**** ...... ``` To obtain a template ID,…"},"AppId":{"type":"string","description":"The application ID. You can create and query the application ID in the console. Only a single ID can be passed"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default value: 10"},"PageNum":{"type":"integer","description":"The page number. By default, the first page (1) is queried"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-rtc-channel-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_rtc_channel_list","summary":"Call DescribeRtcChannelList to retrieve a list of channel communication records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimePoint","PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and view this ID in the console. Only one ID is supported"},"TimePoint":{"type":"string","description":"Query time point in UTC format, yyyy-MM-ddTHH:mm:ssZ. Time granularity is day"},"SortType":{"type":"string","enum":["sortByStartTime","sortByStartTimeDesc","sortByEndTime","sortByEndTimeDesc"],"description":"Sort order. Default is descending by StartTime"},"ServiceArea":{"type":"string","description":"Service area. Default is all areas. cn: China. us: United States"},"UserId":{"type":"string","description":"User ID. Only one ID is supported"},"ChannelId":{"type":"string","description":"Channel ID. Only one ID is supported"},"PageNo":{"type":"integer","description":"Page number. Value must be greater than 0. Default is 1"},"PageSize":{"type":"integer","description":"Number of items to return. Value must be greater than 0. Default is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-rtc-channel-metric":{"post":{"operationId":"cloud_aliyun_rtc_describe_rtc_channel_metric","summary":"Queries the details of communication records in a channel. You can query data within the last 180 days","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TimePoint","AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"TimePoint":{"type":"string","description":"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":{"type":"string","description":"The application ID. You can create and query the application ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The channel ID. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-rtc-duration-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_rtc_duration_data","summary":"Retrieves the total communication duration for an application within a specified time range. Data is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartTime":{"type":"string","description":"The start of the time range to query. Specify the time in UTC format: yyyy-MM-ddTHH:mm:ssZ"},"EndTime":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The area where the service is deployed. The default value is CN, which indicates China"},"Interval":{"type":"string","enum":["86400","3600"],"description":"The time granularity of the query, in seconds. Valid values are 3600 (1 hour) and 86400 (1 day). The default value is 3600"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-rtc-peak-channel-cnt-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_rtc_peak_channel_cnt_data","summary":"Queries the peak number of concurrent channels of an application in a specified time range","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time for the data query. Specify the time in the UTC format: yyyy-MM-ddTHH:mm:ssZ"},"EndTime":{"type":"string","description":"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":{"type":"string","description":"The application ID. Only a single ID can be specified. By default, all application IDs are queried."},"ServiceArea":{"type":"string","description":"The service area. CN: China (default value)"},"Interval":{"type":"string","enum":["86400","3600"],"description":"The time granularity for the data query, in seconds. Valid values: 3600 (1 hour) or 86400 (1 day). Default value: 3600."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-rtc-user-cnt-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_rtc_user_cnt_data","summary":"Queries the number of active users of an application within a specified time range, that is, the number of…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time of the queried data. The time is displayed in UTC. The format is yyyy-MM-ddTHH:mm:ssZ"},"EndTime":{"type":"string","description":"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":{"type":"string","description":"The application ID. You can specify only one ID. By default, all application IDs are queried."},"ServiceArea":{"type":"string","description":"The service area. CN: China (default value)"},"Interval":{"type":"string","enum":["86400","3600"],"description":"The time granularity at which the data is queried. Unit: seconds. Valid values: 3600 (one hour) or 86400 (one day). Default value: 3600."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-streaming-out-status":{"post":{"operationId":"cloud_aliyun_rtc_describe_streaming_out_status","summary":"Queries the status of a streaming-out task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"ChannelId":{"type":"string","description":"The name of the channel"},"TaskId":{"type":"string","description":"The task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-system-layout-list":{"post":{"operationId":"cloud_aliyun_rtc_describe_system_layout_list","summary":"Built-in system layouts","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"PageNum":{"type":"integer","description":"Page number"},"PageSize":{"type":"integer","description":"Number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-usage-area-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_usage_area_distribution_stat_data","summary":"This API is used to retrieve the regional distribution data of usage statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"string","description":"The start time of the query, expressed as a UNIX timestamp in seconds"},"EndDate":{"type":"string","description":"The end time of the query, expressed as a UNIX timestamp in seconds"},"ParentArea":{"type":"string","description":"The parent region name. For example, the parent of Hangzhou City is Zhejiang Province, and the parameter should be set to China_Zhejiang…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-usage-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_usage_distribution_stat_data","summary":"This API is used to retrieve the distribution data of usage statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","StatDim","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"The start time of the query, expressed as a UNIX timestamp in seconds"},"EndDate":{"type":"integer","description":"The end time of the query, expressed as a UNIX timestamp in seconds"},"StatDim":{"type":"string","description":"The statistics dimension. Valid values: CHANNEL_ONLINE: Statistics by channel online user count. NETWORK: Statistics by network type. OS:…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-usage-os-sdk-version-distribution-stat-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_usage_os_sdk_version_distribution_stat_data","summary":"This API is used to obtain the distribution data of operating systems and SDK versions in usage statistics.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"Start Time of the query, represented as a UNIX timestamp in seconds"},"EndDate":{"type":"integer","description":"End Time of the query, represented as a UNIX timestamp in seconds"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-usage-overall-data":{"post":{"operationId":"cloud_aliyun_rtc_describe_usage_overall_data","summary":"This API is used to retrieve overview data of usage statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartDate","EndDate","Types","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"StartDate":{"type":"integer","description":"The Start Time of the query, represented as a UNIX timestamp in seconds"},"EndDate":{"type":"integer","description":"The End Time of the query, represented as a UNIX timestamp in seconds"},"Types":{"type":"string","description":"The Metric Type of the query. Separate multiple values with English commas (,). Valid values: TOTAL_CALL_DURATION: Total duration.…"},"AppId":{"type":"string","description":"APP ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/describe-user-info-in-channel":{"post":{"operationId":"cloud_aliyun_rtc_describe_user_info_in_channel","summary":"Calls DescribeUserInfoInChannel to query the real-time information of a user in a channel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is created and queried through the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The channel ID. Only a single ID is supported"},"UserId":{"type":"string","description":"The user ID. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/disable-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_disable_auto_live_stream_rule","summary":"Calls the DisableAutoLiveStreamRule operation to disable an automatic single-stream relay rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RuleId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which can be created and queried in the console"},"RuleId":{"type":"integer","description":"The ID of the relay rule. You can obtain the relay rule ID by querying it in the console or by calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/enable-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_enable_auto_live_stream_rule","summary":"Calls the EnableAutoLiveStreamRule operation to enable an automatic single-stream relay rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RuleId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query the application ID in the console"},"RuleId":{"type":"integer","description":"The ID of the relay rule. You can query the ID of the relay rule in the console or by calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/get-agent":{"post":{"operationId":"cloud_aliyun_rtc_get_agent","summary":"GetAgent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and view this ID in the console. Only one ID is supported"},"ChannelId":{"type":"string","description":"Channel ID"},"TaskId":{"type":"string","description":"Task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/get-mputask-status":{"post":{"operationId":"cloud_aliyun_rtc_get_mputask_status","summary":"Calls GetMPUTaskStatus to query the status of a stream relay task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Only a single ID is supported"},"TaskId":{"type":"string","description":"The task ID. Only a single ID is supported. The value must be the same as the TaskId parameter of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app":{"post":{"operationId":"cloud_aliyun_rtc_modify_app","summary":"Invoke ModifyApp to modify the name of a specified application.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","AppName"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."},"AppName":{"type":"string","description":"Application name. Only a single name is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-agent-function-status":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_agent_function_status","summary":"Toggle the application agent feature","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it in the console. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-agent-template":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_agent_template","summary":"Updating an application agent template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Id","Name"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can obtain this ID from the console. Only one ID can be specified"},"Id":{"type":"string","description":"The template ID"},"Name":{"type":"string","description":"The template name"},"Type":{"type":"integer","enum":["1"],"description":"The agent type: `1`: Voice call (default)"},"ChatMode":{"type":"integer","enum":["1","2"],"description":"The chat mode: `1`: Natural conversation mode (default) `2`: Walkie-talkie mode"},"InterruptMode":{"type":"integer","enum":["1","2"],"description":"The interrupt mode: `1`: Allow interrupt (default) `2`: Disable interrupt"},"Greeting":{"type":"string","description":"The greeting message. The maximum length is 500 characters"},"AsrConfig":{"type":"string","description":"ASR (Automatic Speech Recognition) configuration (JSON-encoded)"},"LlmConfig":{"type":"string","description":"LLM (Large Language Model) configuration (JSON-encoded)"},"TtsConfig":{"type":"string","description":"TTS (Text-to-Speech) configuration (JSON-encoded)"},"AgentSilenceConfig":{"type":"string","description":"The agent silence configuration (JSON-encoded)"},"AmbientSoundConfig":{"type":"string","description":"Configuration for the agent's ambient sound. If this parameter is not specified, ambient sound is disabled (JSON-encoded)"},"InterruptConfig":{"type":"string","description":"The agent interrupt configuration (JSON-encoded)"},"BackChannelConfig":{"type":"string","description":"The agent backchannel configuration (JSON-encoded)"},"EnableVideoUnderstanding":{"type":"string","description":"Specifies whether to enable video understanding. If enabled, the specified LLM must support multimodal data"},"PreferVideo":{"type":"integer","description":"When `EnableVideoUnderstanding` is `true`, this parameter specifies which video stream to prioritize if both a camera stream and a screen…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-callback-status":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_callback_status","summary":"Update the application callback management event toggle","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-layout":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_layout","summary":"Modify a custom application layout","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Layout"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotent parameter"},"AppId":{"type":"string","description":"Application ID. Create and query through the console. Only a single ID is supported"},"Layout":{"type":"string","description":"Layout (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-live-stream-status":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_live_stream_status","summary":"Modify the bypass toggle of an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency parameter"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-record-status":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_record_status","summary":"Modify the application recording toggle","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency parameter"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-record-template":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_record_template","summary":"Modify an application recording template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RecordTemplate","AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency parameter"},"RecordTemplate":{"type":"string","description":"Recording template (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Create and query through the console. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-streaming-out-template":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_streaming_out_template","summary":"Modify the stream ingest template for an RTC 3.0 application.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","StreamingOutTemplate"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported"},"StreamingOutTemplate":{"type":"string","description":"Template (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-view-status":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_view_status","summary":"Modify the stream mixing switch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it in the console. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-app-view-template":{"post":{"operationId":"cloud_aliyun_rtc_modify_app_view_template","summary":"Update an application view template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Template"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and view it in the console. Only one ID is supported"},"Template":{"type":"string","description":"The template (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-callback-meta":{"post":{"operationId":"cloud_aliyun_rtc_modify_callback_meta","summary":"Update application callback","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Callback"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"},"Callback":{"type":"string","description":"Callback configuration. (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-cloud-note-phrases":{"post":{"operationId":"cloud_aliyun_rtc_modify_cloud_note_phrases","summary":"You can update the hotword list for meeting minutes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Phrase"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and view it in the console. You can specify only one ID"},"Phrase":{"type":"string","description":"Hotword parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-mpulayout":{"post":{"operationId":"cloud_aliyun_rtc_modify_mpulayout","summary":"Modifies the layout of bypass live streaming","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LayoutId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"Panes":{"type":"string","description":"The list of panes in the layout (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. Only a single ID is supported. You can create and query applications in the console"},"Name":{"type":"string","description":"The layout name"},"LayoutId":{"type":"integer","description":"The layout ID. To obtain the layout ID, see https://help.aliyun.com/document_detail/162192.html"},"AudioMixCount":{"type":"integer","description":"The maximum number of audio mixing streams. Valid values: 0 to 6"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-streaming-property":{"post":{"operationId":"cloud_aliyun_rtc_modify_streaming_property","summary":"Set stream properties","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and query it in the console. Pass only one ID"},"ChannelId":{"type":"string","description":"Existing channel ID. Pass only one ID"},"TaskId":{"type":"string","description":"Mixing task ID"},"ViewSubscribers":{"type":"string","description":"ViewSubscribers (JSON-encoded)"},"ViewContent":{"type":"string","description":"Mixing content type"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/modify-view-layout":{"post":{"operationId":"cloud_aliyun_rtc_modify_view_layout","summary":"Configures the stream mixing layout","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and find this ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The ID of an existing channel. Only a single ID is supported"},"TemplateId":{"type":"string","description":"The template ID"},"TaskId":{"type":"string","description":"The task ID. Only a single ID is supported. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens…"},"Panes":{"type":"string","description":"The cell settings. You can set a maximum of 16 cells (JSON-encoded)"},"Backgrounds":{"type":"string","description":"The background images (JSON-encoded)"},"Images":{"type":"string","description":"The global image watermarks (JSON-encoded)"},"Texts":{"type":"string","description":"The global text watermarks (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"The global clock watermarks (JSON-encoded)"},"LayoutSpecifiedUsers":{"type":"string","description":"The settings for blacklists and whitelists (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/notify-agent":{"post":{"operationId":"cloud_aliyun_rtc_notify_agent","summary":"NotifyAgent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The channel to join. Only a single ID is supported"},"TaskId":{"type":"string","description":"The task ID"},"Message":{"type":"string","description":"The text content to announce"},"Priority":{"type":"integer","description":"The priority level for inserting the announcement: 1 — Interrupt the current interaction and announce immediately. 2 — Announce after the…"},"Interruptable":{"type":"string","description":"Indicates whether the announcement can be interrupted. If false, the message cannot be interrupted by voice input, key presses, or other…"},"CustomAttribute":{"type":"string","description":"Custom parameters passed through to the client"},"BackgroundMusic":{"type":"string","description":"Background audio (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/remove-terminals":{"post":{"operationId":"cloud_aliyun_rtc_remove_terminals","summary":"Call the RemoveTerminals operation to remove specified end users from a channel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TerminalIds","AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"TerminalIds":{"type":"string","description":"A list of user IDs (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. Only one ID is supported. You can create and query application IDs in the console"},"ChannelId":{"type":"string","description":"The ID of the channel that the user has joined. Only one ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/remove-users":{"post":{"operationId":"cloud_aliyun_rtc_remove_users","summary":"RemoveUsers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","Users"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."},"ChannelId":{"type":"string","description":"The ID of the joined channel. Only a single ID is supported"},"Users":{"type":"string","description":"User List. Valid values of N: 1 to 30. (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/rtc-cancel-sip-invite":{"post":{"operationId":"cloud_aliyun_rtc_rtc_cancel_sip_invite","summary":"Cancels a SIP invite","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","UserId","DeviceType"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and find this ID in the console. Specify only one ID"},"ChannelId":{"type":"string","description":"The ID of an existing channel. Specify only one ID"},"UserId":{"type":"string","description":"The user ID"},"DeviceType":{"type":"string","enum":["sip_device","mcu","phone"],"description":"The type of the third-party SIP device: sip_device mcu phone Note: Only the phone type is supported at this stage"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/rtc-sip-invite-member":{"post":{"operationId":"cloud_aliyun_rtc_rtc_sip_invite_member","summary":"Invite a SIP device to join a channel","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","Uid","DeviceType","Registered","SipDisplayName","SipUserId","SipRoomId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Get it from the console. Pass one ID only"},"ChannelId":{"type":"string","description":"Channel ID. Pass one ID only"},"Uid":{"type":"string","description":"User ID"},"DeviceType":{"type":"string","enum":["sip_device","mcu","phone"],"description":"Device type of the third-party SIP system: sip_device mcu phone Note: Only phone is supported at this time"},"ServerAddress":{"type":"string","description":"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":{"type":"string","description":"Token required to join the meeting. For sample code, see the referenced document"},"Registered":{"type":"string","description":"Whether the third-party conferencing system must register before receiving the call"},"SipDisplayName":{"type":"string","description":"Name displayed for the user on the third-party system"},"SipUserId":{"type":"string","description":"If DeviceType is mcu, this is the third-party conferencing system. If DeviceType is sip_device, this is the registered device. If the…"},"SipUserPassword":{"type":"string","description":"The registration password for the SipUserId. This parameter is required when a third party registers to receive incoming calls"},"SipRoomId":{"type":"string","description":"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":{"type":"string","description":"If the device is an MCU, this is the IP address and port of the third-party conferencing system in the format…"},"SipUserAgent":{"type":"string","enum":["polycom","cisco","tencent","zoom","pstn"],"description":"Brand or model of the third-party SIP device. Examples: polycom, cisco, tencent, zoom, pstn"},"CallNumber":{"type":"string","description":"Custom line number for PSTN calls"},"TaskId":{"type":"string","description":"Task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/rtc-sip-mute":{"post":{"operationId":"cloud_aliyun_rtc_rtc_sip_mute","summary":"Mute operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","Operations"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and view it in the console. You can specify only one ID"},"ChannelId":{"type":"string","description":"Existing channel ID. You can specify only one ID"},"Operations":{"type":"string","description":"Operations to perform (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-agent":{"post":{"operationId":"cloud_aliyun_rtc_start_agent","summary":"Start AI Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId","TemplateId","RtcConfig"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query this ID in the console. Only one application ID is supported"},"ChannelId":{"type":"string","description":"The ID of the channel to join. Only one channel ID is supported"},"TaskId":{"type":"string","description":"The task ID"},"TemplateId":{"type":"string","description":"The template ID"},"RtcConfig":{"type":"string","description":"The configuration for the agent to join an RTC channel (JSON-encoded)"},"VoiceChatConfig":{"type":"string","description":"The configuration for AI voice chat (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-category-callback":{"post":{"operationId":"cloud_aliyun_rtc_start_category_callback","summary":"Starts an event callback","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Callback"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"Callback":{"type":"string","description":"The callback (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-cloud-note":{"post":{"operationId":"cloud_aliyun_rtc_start_cloud_note","summary":"Enable intelligent summary","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId","StorageConfig"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"ChannelId":{"type":"string","description":"The channel ID"},"TaskId":{"type":"string","description":"The task ID"},"StorageConfig":{"type":"string","description":"The storage configuration (JSON-encoded)"},"SourceLanguage":{"type":"string","enum":["cn","en","ja","yue","ko","de","fr","ru","multilingual","es","vi","it","sv","cs","pl","th","fi","hi","id","pt","ar","fil","ms","tr","hu","lo","pt-br","es-ar","es-mx"],"description":"The source language model for the channel. `cn`: Chinese `yue`: Cantonese `en`: English `multilingual`: Multilingual `ja`: Japanese `ko`:…"},"LanguageHints":{"type":"string","description":"Deprecated. This parameter is no longer used (JSON-encoded)"},"Transcription":{"type":"string","description":"The transcription feature. This feature is enabled by default (JSON-encoded)"},"AutoChapters":{"type":"string","description":"The auto-chapters feature. If enabled, the service generates chapter titles and summaries (JSON-encoded)"},"MeetingAssistance":{"type":"string","description":"The meeting assistance feature. If enabled, the service generates outputs such as keywords, key information, and action items (JSON-encoded)"},"Summarization":{"type":"string","description":"The summarization feature. If enabled, the service generates outputs such as full-text summaries and speaker summaries (JSON-encoded)"},"TextPolish":{"type":"string","description":"The text polishing feature (JSON-encoded)"},"ServiceInspection":{"type":"string","description":"The service quality inspection feature (JSON-encoded)"},"CustomPrompt":{"type":"string","description":"The configuration for custom prompts (JSON-encoded)"},"RealtimeSubtitle":{"type":"string","description":"The configuration for real-time subtitles (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-cloud-record":{"post":{"operationId":"cloud_aliyun_rtc_start_cloud_record","summary":"Start a cloud recording task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","StorageConfig"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and view the application ID in the console. Only one application ID is supported"},"ChannelId":{"type":"string","description":"The existing channel ID. Only one channel ID is supported"},"TemplateId":{"type":"string","description":"The template ID"},"TaskId":{"type":"string","description":"The task ID of this cloud recording task. Only one task ID is supported. The task ID can contain letters, digits, underscores (_), and…"},"CropMode":{"type":"integer","enum":["1","2","3"],"description":"The cropping mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Pad while maintaining the aspect ratio. Default value. 3:…"},"ReservePaneForNoCameraUser":{"type":"string","description":"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":{"type":"string","description":"Show the default background image for muted users. true: Show the default background image. Default value. false: Do not show the default…"},"SubHighResolutionStream":{"type":"string","description":"Subscribe to high-resolution streams. false: Subscribe to streams of different resolutions based on the pane area. Default value. true:…"},"StartWithoutChannel":{"type":"string","description":"Start the recording task even if the channel does not exist. true: Yes. false: No. Default value"},"StartWithoutChannelWaitTime":{"type":"integer","description":"The wait time before starting the recording task if the channel does not exist. This parameter takes effect only when StartWithoutChannel…"},"Annotation":{"type":"string","enum":["disable","enable"],"description":"Enable or disable annotation"},"StorageConfig":{"type":"string","description":"Storage configuration (JSON-encoded)"},"Panes":{"type":"string","description":"Cell configuration settings (JSON-encoded)"},"Images":{"type":"string","description":"Global image watermarks (JSON-encoded)"},"Backgrounds":{"type":"string","description":"Background images (JSON-encoded)"},"Texts":{"type":"string","description":"Global text watermarks (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"Global clock watermarks (JSON-encoded)"},"RegionColor":{"type":"string","description":"The global pane background color (JSON-encoded)"},"BgColor":{"type":"string","description":"The global background color (JSON-encoded)"},"LayoutSpecifiedUsers":{"type":"string","description":"The list of specified users for layout generation. This includes blacklists and whitelists. Whitelist: Subscribes to the video streams of…"},"RecordMode":{"type":"integer","enum":["0","1"],"description":"0: Composite recording. Default value. 1: Individual recording. Individual recording does not support updates"},"SingleStreamingRecord":{"type":"string","description":"Parameters for individual recording (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-mputask":{"post":{"operationId":"cloud_aliyun_rtc_start_mputask","summary":"Starts a bypass live streaming task by calling StartMPUTask","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"SubSpecUsers":{"type":"string","description":"The list of users that this task subscribes to (JSON-encoded)"},"SubSpecAudioUsers":{"type":"string","description":"Specifies which users' audio streams to subscribe to in the room (JSON-encoded)"},"SubSpecShareScreenUsers":{"type":"string","description":"Specifies which users' screen sharing video streams to subscribe to in the room (JSON-encoded)"},"SubSpecCameraUsers":{"type":"string","description":"Specifies which users' camera video streams to subscribe to in the room (JSON-encoded)"},"UnsubSpecAudioUsers":{"type":"string","description":"Specifies which users' audio streams to unsubscribe from in the room (JSON-encoded)"},"UnsubSpecShareScreenUsers":{"type":"string","description":"Specifies which users' screen sharing video streams to unsubscribe from in the room (JSON-encoded)"},"UnsubSpecCameraUsers":{"type":"string","description":"Specifies which users' camera video streams to unsubscribe from in the room (JSON-encoded)"},"LayoutIds":{"type":"string","description":"The layout ID data (JSON-encoded)"},"UserPanes":{"type":"string","description":"The list of layout parameters (JSON-encoded)"},"Backgrounds":{"type":"string","description":"The list of canvas background image placeholders (JSON-encoded)"},"Watermarks":{"type":"string","description":"The list of watermark image placeholders (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"The clock widgets (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. Only a single ID is supported. You can create and query applications in the console"},"ChannelId":{"type":"string","description":"The channel ID. Only a single ID is supported"},"TaskId":{"type":"string","description":"The task ID. Only a single ID is supported. The ID can contain uppercase and lowercase letters, digits, underscores (_), and hyphens (-),…"},"MixMode":{"type":"integer","description":"The stream mixing mode. Valid values: 0: single-stream relay. The original single stream is relayed without mixing or transcoding. You do…"},"CropMode":{"type":"integer","description":"The video cropping mode. Valid values: 1: crops the video while maintaining the aspect ratio. 2: adds padding while maintaining the aspect…"},"MediaEncode":{"type":"integer","description":"The encoding option. For more information, see the MediaEncode enumeration values below"},"SourceType":{"type":"string","description":"The video input stream of the user in single-stream relay mode. Valid values: camera: camera. shareScreen: screen sharing"},"StreamType":{"type":"integer","description":"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":{"type":"integer","description":"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":{"type":"string","description":"The live stream ingest URL. Only a single URL is supported. For information about how to generate the URL, see…"},"PayloadType":{"type":"integer","description":"The payload type. Valid values: 0: no payload. 1: VideoSEI"},"ReportVad":{"type":"integer","description":"The voice activity detection (VAD) flag. Valid values: 0: does not transmit VAD information. 1: transmits VAD information"},"RtpExtInfo":{"type":"integer","description":"The RTP extension header information. Valid values: 0: does not transmit. 1: transmits"},"TimeStampRef":{"type":"integer","description":"The timestamp"},"VadInterval":{"type":"integer","description":"The callback interval for voice activity detection"},"TaskType":{"type":"integer","enum":["0","1"],"description":"The media processing type. Valid values: 0: bypass live streaming task. 1: MCU stream mixing low-latency distribution task"},"EnhancedParam":{"type":"string","description":"The enhanced parameter (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-record-task":{"post":{"operationId":"cloud_aliyun_rtc_start_record_task","summary":"Call StartRecordTask to record a video task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"SubSpecUsers":{"type":"string","description":"Specifies the list of users to which this task is subscribed (JSON-encoded)"},"SubSpecAudioUsers":{"type":"string","description":"Specifies the audio streams of which users in the room to subscribe to (JSON-encoded)"},"SubSpecShareScreenUsers":{"type":"string","description":"Specifies the screen-sharing streams of which users in the room to subscribe to (JSON-encoded)"},"SubSpecCameraUsers":{"type":"string","description":"Specifies the camera streams of which users in the room to subscribe to (JSON-encoded)"},"UnsubSpecAudioUsers":{"type":"string","description":"Specifies the audio streams of which users in the room not to subscribe to (JSON-encoded)"},"UnsubSpecShareScreenUsers":{"type":"string","description":"Specifies the screen-sharing streams of which users in the room not to subscribe to (JSON-encoded)"},"UnsubSpecCameraUsers":{"type":"string","description":"Specifies the camera streams of which users in the room not to subscribe to (JSON-encoded)"},"UserPanes":{"type":"string","description":"The list of layout parameters (JSON-encoded)"},"LayoutIds":{"type":"string","description":"The layout ID group (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. It is created and queried in the console. Only a single ID can be passed in"},"ChannelId":{"type":"string","description":"The channel ID. Only a single ID can be passed in"},"TaskId":{"type":"string","description":"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":{"type":"string","description":"The task billing configuration. Fees are charged based on your different settings. See the TaskProfile enumeration values below. The…"},"MediaEncode":{"type":"integer","description":"The encoding option. See the MediaEncode enumeration values below"},"TemplateId":{"type":"string","description":"The configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html"},"SourceType":{"type":"string","description":"The video source in single-stream recording mode. Valid values: camera: The camera. shareScreen: The screen sharing. If the video source…"},"StreamType":{"type":"integer","description":"The single-stream recording mode. Valid values: 0 (default): Record the original stream. 1: Record only the audio stream"},"MixMode":{"type":"integer","description":"The recording mode. Valid values: 0: Single-stream recording. The task parameters cannot be modified in the middle of recording (the…"},"CropMode":{"type":"integer","description":"The video cropping mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Add borders while maintaining the aspect ratio…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-streaming-out":{"post":{"operationId":"cloud_aliyun_rtc_start_streaming_out","summary":"StartStreamingOut","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","Url"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID, created and queried via the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"An existing channel ID. Only a single ID is supported"},"TemplateId":{"type":"string","description":"Template ID."},"Url":{"type":"string","description":"Live ingest URL. Only a single URL is supported. This URL cannot be used by multiple jobs simultaneously"},"TaskId":{"type":"string","description":"The task ID of this bypass stream ingest job. Only a single ID is supported. It can contain uppercase and lowercase letters, digits,…"},"CropMode":{"type":"integer","enum":["1","2","3"],"description":"Crop mode. Valid values: 1: Crop while maintaining the aspect ratio. 2: Maintain aspect ratio with padding (Default Value). 3: Stretch to…"},"ReservePaneForNoCameraUser":{"type":"string","description":"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":{"type":"string","description":"Whether to display the default pane background when muted. true: Display (default value) false: Do not display (the configured local pane…"},"SubHighResolutionStream":{"type":"string","description":"Subscribe to a high resolution stream. false: Subscribe to streams with different resolutions based on the pane area. (Default Value)…"},"StartWithoutChannel":{"type":"string","description":"Whether to allow starting a job when the channel does not exist. true: Yes false: No (default value)"},"StartWithoutChannelWaitTime":{"type":"integer","description":"This value is valid only when the StartWithoutChannel parameter is true. It specifies the maximum time, in seconds, that a job waits if…"},"Annotation":{"type":"string","enum":["disable","enable"],"description":"Toggle for annotation"},"Panes":{"type":"string","description":"Cell settings. (JSON-encoded)"},"Backgrounds":{"type":"string","description":"Background image (JSON-encoded)"},"Images":{"type":"string","description":"Global image watermark. (JSON-encoded)"},"Texts":{"type":"string","description":"Global text watermark (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"Global clock watermark (JSON-encoded)"},"RegionColor":{"type":"string","description":"Global grid background color (JSON-encoded)"},"BgColor":{"type":"string","description":"Global background color (JSON-encoded)"},"LayoutSpecifiedUsers":{"type":"string","description":"The layout generation uses a user-specified list, which includes both blacklist and whitelist. Whitelist: specifies which users' video…"},"SpecMixedUserList":{"type":"string","description":"List of users specified to be included in audio mixing (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/start-view":{"post":{"operationId":"cloud_aliyun_rtc_start_view","summary":"Start stream composition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. Create and view it in the console. Pass only one ID"},"ChannelId":{"type":"string","description":"Existing channel ID. Pass only one ID"},"TemplateId":{"type":"string","description":"Template ID"},"TaskId":{"type":"string","description":"Task ID for this request. Pass only one ID. Use uppercase letters, lowercase letters, digits, underscores (_), or hyphens (-). Maximum…"},"CropMode":{"type":"integer","enum":["1","2","3"],"description":"Cropping mode. Valid values: 1: Crop while preserving aspect ratio. 2: Pad while preserving aspect ratio (default). 3: Stretch to fill"},"StartWithoutChannel":{"type":"string","description":"Whether to start the task even if the channel does not exist. true: Yes false: No (default)"},"StartWithoutChannelWaitTime":{"type":"integer","description":"Time to wait for the channel to become available, in seconds. This parameter applies only when StartWithoutChannel is true. Valid range:…"},"RegionColor":{"type":"string","description":"Background color of the global frame (JSON-encoded)"},"BgColor":{"type":"string","description":"Global background color (JSON-encoded)"},"ViewSubscribers":{"type":"string","description":"List of user IDs for SIP devices that can view the main stream or screen-sharing stream (JSON-encoded)"},"ViewContent":{"type":"string","enum":["main","screen-cast"],"description":"Stream type. main: Main stream screen-cast: Screen-sharing stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-agent":{"post":{"operationId":"cloud_aliyun_rtc_stop_agent","summary":"Stops an AI Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Only a single ID is supported. You can create and query applications in the console"},"ChannelId":{"type":"string","description":"The channel to join. Only a single ID is supported"},"TaskId":{"type":"string","description":"The task ID. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-category-callback":{"post":{"operationId":"cloud_aliyun_rtc_stop_category_callback","summary":"Shuts down an event callback","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Callback"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"Callback":{"type":"string","description":"The callback (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-channel":{"post":{"operationId":"cloud_aliyun_rtc_stop_channel","summary":"This API is used by the server to actively shut down a channel.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID. You can create and query it in the console. Only a single ID is supported."},"ChannelId":{"type":"string","description":"An existing channel ID. Only a single ID is supported."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-cloud-note":{"post":{"operationId":"cloud_aliyun_rtc_stop_cloud_note","summary":"Stop Intelligent Summary","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ClientToken":{"type":"string","description":"Idempotency parameter"},"AppId":{"type":"string","description":"The application ID."},"ChannelId":{"type":"string","description":"The channel name."},"TaskId":{"type":"string","description":"The job ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-cloud-record":{"post":{"operationId":"cloud_aliyun_rtc_stop_cloud_record","summary":"StopCloudRecord","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, created and queried via the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The existing channel ID. Only a single ID is supported"},"TaskId":{"type":"string","description":"The existing cloud recording job ID. Only a single ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-mputask":{"post":{"operationId":"cloud_aliyun_rtc_stop_mputask","summary":"Calls the StopMPUTask operation to stop a stream relay task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Only a single ID can be passed. You can create and query the application ID in the console…"},"TaskId":{"type":"string","description":"The task ID. Only a single ID can be passed. The value must be the same as the TaskId parameter of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-record-task":{"post":{"operationId":"cloud_aliyun_rtc_stop_record_task","summary":"Calls the StopRecordTask operation to stop a video recording task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query the ID in the console. Only a single ID is supported"},"TaskId":{"type":"string","description":"The task ID. Only a single ID is supported. The value must be the same as the TaskId parameter of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-streaming-out":{"post":{"operationId":"cloud_aliyun_rtc_stop_streaming_out","summary":"StopStreamingOut","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is created and queried via the console. Only a single ID is supported."},"ChannelId":{"type":"string","description":"An existing channel ID. Only a single ID is supported."},"TaskId":{"type":"string","description":"The ID of an existing bypass stream ingest job. Only a single ID is supported. It can contain uppercase and lowercase letters, digits,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/stop-view":{"post":{"operationId":"cloud_aliyun_rtc_stop_view","summary":"Stop stream mixing","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Create and query it in the console. Only one ID is supported"},"ChannelId":{"type":"string","description":"An existing channel ID. Only one ID is supported"},"TaskId":{"type":"string","description":"An existing task ID. Only one ID is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-agent":{"post":{"operationId":"cloud_aliyun_rtc_update_agent","summary":"Update an AI Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. Specify only one ID. You can create and query applications in the console"},"ChannelId":{"type":"string","description":"The existing channel ID. Specify only one ID"},"TaskId":{"type":"string","description":"The task ID. Specify only one ID"},"VoiceChatConfig":{"type":"string","description":"Configuration for AI voice conversation (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-auto-live-stream-rule":{"post":{"operationId":"cloud_aliyun_rtc_update_auto_live_stream_rule","summary":"Modifies an automatic bypass single-stream relay rule by calling UpdateAutoLiveStreamRule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","PlayDomain","RuleId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"ChannelIds":{"type":"string","description":"The list of channel IDs for exact matching (JSON-encoded)"},"ChannelIdPrefixes":{"type":"string","description":"The prefix list for fuzzy matching of channel IDs (JSON-encoded)"},"AppId":{"type":"string","description":"The application ID. You can create and query applications in the console"},"PlayDomain":{"type":"string","description":"The streaming domain name for automatic bypass. The streaming URL for an automatic bypass task is rtmp://${domain}/${app}/${stream}.…"},"RuleName":{"type":"string","description":"The name of the bypass rule"},"CallBack":{"type":"string","description":"The callback URL for starting and stopping bypass tasks. You can query the callback URL in the console or by calling the…"},"MediaEncode":{"type":"integer","description":"The encoding option. For more information, see the MediaEncode enumeration values in https://help.aliyun.com/document_detail/353179.html"},"RuleId":{"type":"integer","description":"The bypass rule ID. You can query the rule ID in the console or by calling the https://help.aliyun.com/document_detail/353198.html operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-cloud-record":{"post":{"operationId":"cloud_aliyun_rtc_update_cloud_record","summary":"Updates a cloud recording task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. You can create and query it in the console. Only one ID is supported"},"ChannelId":{"type":"string","description":"The existing channel ID. Only one ID is supported"},"TemplateId":{"type":"string","description":"The template ID. To update the layout, change the template ID. Resolution updates are not supported.>"},"TaskId":{"type":"string","description":"The task ID for this cloud recording. Only one ID is supported. It can contain letters, digits, underscores (_), and hyphens (-), with a…"},"Panes":{"type":"string","description":"Cell settings (JSON-encoded)"},"Images":{"type":"string","description":"Global image watermarks (JSON-encoded)"},"Backgrounds":{"type":"string","description":"Background images (JSON-encoded)"},"Texts":{"type":"string","description":"Global text watermarks (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"Global clock watermarks (JSON-encoded)"},"LayoutSpecifiedUsers":{"type":"string","description":"A list that specifies users for layout generation. It supports both blacklists and whitelists. Whitelist: Specifies the users whose video…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-mputask":{"post":{"operationId":"cloud_aliyun_rtc_update_mputask","summary":"Call UpdateMPUTask to update a bypass relay task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"LayoutIds":{"type":"string","description":"Layout ID data (JSON-encoded)"},"SubSpecUsers":{"type":"string","description":"The list of users subscribed to by this task (JSON-encoded)"},"SubSpecAudioUsers":{"type":"string","description":"Specifies the users in the room whose audio streams are subscribed to (JSON-encoded)"},"SubSpecShareScreenUsers":{"type":"string","description":"Specifies the users in the room whose shared video streams are subscribed to (JSON-encoded)"},"SubSpecCameraUsers":{"type":"string","description":"Specifies the users in the room whose camera video streams are subscribed to (JSON-encoded)"},"UnsubSpecAudioUsers":{"type":"string","description":"Specifies the users in the room whose audio streams are not subscribed to (JSON-encoded)"},"UnsubSpecShareScreenUsers":{"type":"string","description":"Specifies the users in the room whose shared video streams are not subscribed to (JSON-encoded)"},"UnsubSpecCameraUsers":{"type":"string","description":"Specifies the users in the room whose camera video streams are not subscribed to (JSON-encoded)"},"UserPanes":{"type":"string","description":"Layout parameters (JSON-encoded)"},"Backgrounds":{"type":"string","description":"The list of canvas background image pane positions (JSON-encoded)"},"Watermarks":{"type":"string","description":"The list of watermark image pane positions (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"Clock widget (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Only a single ID can be passed. You can create and query it in the console"},"TaskId":{"type":"string","description":"Task ID. Only a single ID can be passed. It is consistent with the input parameter TaskId in…"},"CropMode":{"type":"integer","description":"Video cropping mode. Values: 1: crop while maintaining ratio. 2 (default): keep margins while maintaining ratio"},"MediaEncode":{"type":"integer","description":"Encoding option. See the MediaEncode enumeration values below"},"MixMode":{"type":"integer","description":"Stream mixing mode. Values: 0: single-stream relay. No stream mixing or transcoding. Only the original single stream is relayed. No need…"},"SourceType":{"type":"string","description":"User video input stream in single-stream relay mode. Values: camera: camera. shareScreen: screen sharing"},"StreamType":{"type":"integer","description":"Audio stream relayed in single-stream relay mode. Values: 0 (default): relay the original stream. 1: relay only the audio stream. 2: relay…"},"BackgroundColor":{"type":"integer","description":"Background color RGB. The default is 0 (black). The calculation formula is `R + G × 256 + B × 65536`. Values of R (red), G (green), and B…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-record-task":{"post":{"operationId":"cloud_aliyun_rtc_update_record_task","summary":"Calls UpdateRecordTask to update a video recording task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TaskId","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"SubSpecUsers":{"type":"string","description":"Specifies the list of users that the task subscribes to (JSON-encoded)"},"SubSpecAudioUsers":{"type":"string","description":"Specifies which users' audio streams to subscribe to in the room (JSON-encoded)"},"SubSpecShareScreenUsers":{"type":"string","description":"Specifies which users' screen sharing streams to subscribe to in the room (JSON-encoded)"},"SubSpecCameraUsers":{"type":"string","description":"Specifies which users' camera streams to subscribe to in the room (JSON-encoded)"},"UnsubSpecAudioUsers":{"type":"string","description":"Specifies which users' audio streams in the room are not subscribed to (JSON-encoded)"},"UnsubSpecShareScreenUsers":{"type":"string","description":"Specifies which users' screen sharing streams in the room are not subscribed to (JSON-encoded)"},"UnsubSpecCameraUsers":{"type":"string","description":"Specifies which users' camera streams in the room are not subscribed to (JSON-encoded)"},"UserPanes":{"type":"string","description":"Layout parameter list (JSON-encoded)"},"LayoutIds":{"type":"string","description":"Layout ID group (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Created and queried through the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"Channel ID. Only a single ID is supported"},"TaskId":{"type":"string","description":"Task ID. Only a single ID is supported, and it must be the same as the TaskId input parameter of…"},"TemplateId":{"type":"string","description":"Configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html"},"TaskProfile":{"type":"string","description":"The TaskProfile"},"CropMode":{"type":"integer","description":"The CropMode"},"MediaEncode":{"type":"integer","description":"The MediaEncode"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-record-template":{"post":{"operationId":"cloud_aliyun_rtc_update_record_template","summary":"Calls UpdateRecordTemplate to update a recording configuration template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LayoutIds","Formats","AppId","Name","TemplateId","TaskProfile","MediaEncode","OssBucket","OssFilePrefix","FileSplitInterval"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"LayoutIds":{"type":"string","description":"Layout ID group (JSON-encoded)"},"Formats":{"type":"string","description":"Recording file format (JSON-encoded)"},"Backgrounds":{"type":"string","description":"Background image information (JSON-encoded)"},"Watermarks":{"type":"string","description":"Watermark information (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"Clock information (JSON-encoded)"},"AppId":{"type":"string","description":"Application ID. Created and queried through the console. Only a single ID is supported"},"Name":{"type":"string","description":"Recording configuration template name"},"TemplateId":{"type":"string","description":"Configuration template ID. To obtain the template ID, see https://help.aliyun.com/document_detail/193625.html"},"TaskProfile":{"type":"string","description":"Task billing configuration"},"MediaEncode":{"type":"integer","description":"Encoding option"},"BackgroundColor":{"type":"integer","description":"Background color RGB. The default value is 0 (black). The calculation formula is R+G×256+B×65536. The values of R (red), G (green), and B…"},"OssBucket":{"type":"string","description":"OSS bucket for storing recording files"},"OssFilePrefix":{"type":"string","description":"Recording file naming rule"},"MnsQueue":{"type":"string","description":"Recording event callback message queue"},"HttpCallbackUrl":{"type":"string","description":"Recording event HTTP callback URL"},"FileSplitInterval":{"type":"integer","description":"Recording file split duration (greater than or equal to 1800). Unit: seconds"},"DelayStopTime":{"type":"integer","description":"Delayed recording stop time. Unit: seconds. The default value is 180 seconds"},"EnableM3u8DateTime":{"type":"string","description":"Whether the recorded m3u8 file needs to include ts file timestamps"},"OssEndpoint":{"type":"string","description":"The OssEndpoint"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/update-streaming-out":{"post":{"operationId":"cloud_aliyun_rtc_update_streaming_out","summary":"Updates a bypass stream ingest task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ChannelId","TemplateId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. Create and find the application ID in the console. Only a single ID is supported"},"ChannelId":{"type":"string","description":"The ID of an existing channel. Only a single ID is supported"},"TemplateId":{"type":"string","description":"The template ID. When you update the template ID, you can update only the layout. You cannot update the resolution.>"},"TaskId":{"type":"string","description":"The ID of the bypass stream ingest task. Only a single ID is supported. The ID can contain uppercase letters, lowercase letters, digits,…"},"CropMode":{"type":"integer","enum":["1","2","3"],"description":"The clipping mode. Valid values: 1: Clips the stream while maintaining the aspect ratio. 2: Scales the stream proportionally and adds…"},"Panes":{"type":"string","description":"The cell settings. Configure up to 16 cells (JSON-encoded)"},"Images":{"type":"string","description":"The global image watermarks (JSON-encoded)"},"Backgrounds":{"type":"string","description":"The background images (JSON-encoded)"},"Texts":{"type":"string","description":"The global text watermarks (JSON-encoded)"},"ClockWidgets":{"type":"string","description":"The global clock watermarks (JSON-encoded)"},"RegionColor":{"type":"string","description":"The global background color for panes (JSON-encoded)"},"BgColor":{"type":"string","description":"The global background color (JSON-encoded)"},"LayoutSpecifiedUsers":{"type":"string","description":"The list of users for the layout. This list can act as a whitelist or a blacklist. Whitelist: Lists the user video streams to subscribe to…"},"SpecMixedUserList":{"type":"string","description":"The list of users whose audio to mix (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc/version":{"post":{"operationId":"cloud_aliyun_rtc_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://rtc.aliyuncs.com"],"default":"https://rtc.aliyuncs.com","description":"Regional endpoint, for example https://rtc.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}