API overview
Updated at:
Copy as MD
API standards and multilingual preset SDKs
The OpenAPI of this product (live/2016-11-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Domain management
|
API |
Title |
Description |
| AddLiveDomain | AddLiveDomain | Adds a domain name to ApsaraVideo Live. This operation allows you to add only one domain name at a time. |
| AddLiveDomainPlayMapping | AddLiveDomainPlayMapping | Maps a sub-streaming domain to a main streaming domain. |
| DeleteLiveDomainPlayMapping | DeleteLiveDomainPlayMapping | Deletes the mapping between a main streaming domain and a sub-streaming domain. |
| AddLiveDomainMapping | AddLiveDomainMapping | Creates the mapping between a streaming domain and an ingest domain. |
| DeleteLiveDomain | DeleteLiveDomain | Deletes all records of the specified live streaming domain. |
| DeleteLiveDomainMapping | DeleteLiveDomainMapping | Deletes the mapping between a streaming domain and an ingest domain. |
| DescribeLiveDomainMapping | DescribeLiveDomainMapping | Retrieves the mapping between ingest domains, main streaming domains, and sub-streaming domains. |
| DescribeLiveDomainDetail | DescribeLiveDomainDetail | Queries the basic configuration information of a specified ingest domain or streaming domain. |
| StartLiveDomain | StartLiveDomain | Starts a disabled live streaming domain. This operation changes the DomainStatus to online. |
| StopLiveDomain | StopLiveDomain | Disables a live streaming domain. This operation changes the DomainStatus to offline. |
| DescribeLiveCertificateDetail | DescribeLiveCertificateDetail | Queries the details of a certificate. |
| DescribeLiveDomainCertificateInfo | DescribeLiveDomainCertificateInfo | Retrieves the certificate information for a specified domain name. |
| DescribeLiveCertificateList | DescribeLiveCertificateList | Queries the certificates of one or more specified domain names or all certificates within your Alibaba Cloud account. |
| SetLiveDomainCertificate | Set domain certificate | Sets whether the certificate feature is enabled for a domain and modifies certificate information. |
| BatchDeleteLiveDomainConfigs | BatchDeleteLiveDomainConfigs | Deletes the configurations of multiple domain names at a time. |
| BatchSetLiveDomainConfigs | BatchSetLiveDomainConfigs | Configures multiple domain names at a time. |
| DescribeLiveDomainConfigs | DescribeLiveDomainConfigs | Queries one or more configurations of a domain name. |
| DescribeLiveDomainByCertificate | Query domain names that match a certificate | Retrieves accelerated domain names based on certificate information. |
| DescribeLiveHttpsDomainList | Query certificate service list | Queries all configured certificate information for the certificate service of a user. |
| ModifyLiveDomainSchdmByProperty | ModifyLiveDomainSchdmByProperty | Modifies the acceleration region of a domain name. |
| DescribeLiveUserTags | DescribeLiveUserTags | Retrieves user tags. |
| VerifyLiveDomainOwner | VerifyLiveDomainOwner | Verifies the ownership of a domain name. |
| DescribeLiveVerifyContent | DescribeLiveVerifyContent | Queries the ownership verification content for a specified domain name. |
| ChangeLiveDomainResourceGroup | ChangeLiveDomainResourceGroup | Moves a domain name in ApsaraVideo Live to a specified resource group. |
Live stream preloading
|
API |
Title |
Description |
| SetLiveStreamPreloadTasks | Set live stream prefetch tasks | Sets live stream prefetch tasks. You can prefetch up to 100 live streams in a batch. |
| DescribeLiveStreamPreloadTasks | Query live stream preload tasks | Only data from the last 3 days can be queried. |
| HotLiveRtcStream | HotLiveRtcStream | Prefetches Real-Time Communication (RTC) streams. |
Live stream pulling
|
API |
Title |
Description |
| AddLivePullStreamInfoConfig | AddLivePullStreamInfoConfig | Creates a scheduled stream pulling configuration, which includes parameters such as the origin URL, start time, and end time. |
| DescribeLivePullStreamConfig | DescribeLivePullStreamConfig | Retrieves the scheduled stream pulling configurations for a domain name. |
| DeleteLivePullStreamInfoConfig | DeleteLivePullStreamInfoConfig | Deletes a scheduled stream pulling configuration. |
| SetLiveLazyPullStreamInfoConfig | SetLiveLazyPullStreamInfoConfig | Configures triggered stream pulling. |
| DescribeLiveLazyPullStreamConfig | DescribeLiveLazyPullStreamConfig | Retrieves the configurations of triggered stream pulling for a streaming domain. |
| DeleteLiveLazyPullStreamInfoConfig | DeleteLiveLazyPullStreamInfoConfig | Deletes a configuration of triggered stream pulling. |
| UpdateLivePullStreamInfoConfig | UpdateLivePullStreamInfoConfig | Modifies a scheduled stream pulling configuration, including the origin URL, start time, and end time. |
Live stream management
|
API |
Title |
Description |
| DescribeLiveStreamsBlockList | DescribeLiveStreamsBlockList | Queries the live streams that are blacklisted under a streaming domain. |
| DescribeLiveStreamsControlHistory | DescribeLiveStreamsControlHistory | Queries the operations performed on live streams for a specified domain name or application. |
| DescribeLiveStreamBitRateData | Query frame rates and bitrates of an RTMP live stream | Queries the frame rates and bitrates of an RTMP live stream within a specified time range. This operation is applicable to retrieving historical data. |
| DescribeLiveStreamsOnlineList | Query active streams under a domain name | Queries the information about all active streams under a specified domain name or a specified application under a domain name. |
| DescribeLiveStreamsPublishList | Query historical stream list for a domain name | Retrieves the historical stream ingest records of a domain name, an application under a domain name, or a specific stream within a specified time range. |
| ForbidLiveStream | Disable a live stream | Disables stream ingest for a specified stream. You can preset a time to resume the stream. |
| ResumeLiveStream | Resume stream ingest for a live stream | Resumes stream ingest for a specified stream. |
| DescribeLiveDomainOnlineUserNum | DescribeLiveDomainOnlineUserNum | Retrieves the number of online viewers for all live streams on a specified domain. |
| DescribeLiveDomainFrameRateAndBitRateData | DescribeLiveDomainFrameRateAndBitRateData | Queries the frame rate and bitrate data of streams for an ingest domain. |
| DescribeLiveDomainLimit | DescribeLiveDomainLimit | Queries the maximum numbers of ingested and transcoded streams for a streaming domain. |
| DescribeLiveStreamState | DescribeLiveStreamState | Queries the real-time status of a single stream. |
Primary/secondary stream merging
|
API |
Title |
Description |
| DeleteLiveStreamMerge | DeleteLiveStreamMerge | Deletes an active merged stream. |
| AddLiveStreamMerge | AddLiveStreamMerge | Call AddLiveStreamMerge to add a primary/backup stream merge configuration. |
| DescribeLiveStreamMerge | Query primary/backup stream merge configuration | Query primary/backup stream merge configuration. |
Stream delay
|
API |
Title |
Description |
| DeleteLiveDelayConfig | DeleteLiveDelayConfig | Deletes a stream delay configuration. |
| UpdateLiveDelayConfig | UpdateLiveDelayConfig | Updates the live stream delay configuration. |
| DescribeLiveDelayConfig | DescribeLiveDelayConfig | Calls DescribeLiveDelayConfig to query the stream delay configuration. |
| ListLiveDelayConfig | ListLiveDelayConfig | Retrieves stream delay configurations. |
| CreateLiveDelayConfig | CreateLiveDelayConfig | Adds a stream delay configuration. |
Ingest callback
|
API |
Title |
Description |
| SetLiveStreamsNotifyUrlConfig | Set stream ingest callback notification URL configuration | Sets the stream ingest callback configuration. |
| DescribeLiveStreamsNotifyUrlConfig | DescribeLiveStreamsNotifyUrlConfig | Queries the callback configuration for stream ingest. |
| DeleteLiveStreamsNotifyUrlConfig | DeleteLiveStreamsNotifyUrlConfig | Deletes the callback configuration of stream ingest for an ingest domain. |
| DescribeLiveStreamsNotifyRecords | Query stream callback records | Queries stream callback records. |
Live stream security
|
API |
Title |
Description |
| DeleteLiveStreamBlock | DeleteLiveStreamBlock | Deletes blocking configurations for a specific live stream. |
| SetLiveStreamBlock | Set live stream-level blocking | Sets stream-level blocking for live streams by calling SetLiveStreamBlock. |
| DescribeStreamLocationBlock | DescribeStreamLocationBlock | Queries region blocking configurations of a specific live stream. |
Time shifting
|
API |
Title |
Description |
| DescribeLiveShiftConfigs | DescribeLiveShiftConfigs | Queries the time-shifting configurations for a specified domain name. |
| OpenLiveShift | OpenLiveShift | You can call the OpenLiveShift operation to enable time shifting for a specific domain name, application, or stream. |
| CloseLiveShift | CloseLiveShift | Disables time shifting for a domain name, or an application or a live stream under the domain name. |
Live stream transcoding
|
API |
Title |
Description |
| AddLiveStreamTranscode | Add transcoding configuration information | Calls AddLiveStreamTranscode to add transcoding configuration information. |
| AddCustomLiveStreamTranscode | AddCustomLiveStreamTranscode | Adds a custom transcoding configuration. |
| AddRtsLiveStreamTranscode | AddRtsLiveStreamTranscode | Adds a custom transcoding configuration for a streaming domain with Real-Time Streaming (RTS) enabled. |
| UpdateCustomLiveStreamTranscode | UpdateCustomLiveStreamTranscode | Updates a custom transcoding configuration. |
| UpdateLiveStreamTranscode | UpdateLiveStreamTranscode | Updates a default transcoding configuration. |
| UpdateRtsLiveStreamTranscode | UpdateRtsLiveStreamTranscode | Updates the configuration of a custom Real-time Streaming (RTS) transcoding template. |
| DeleteLiveStreamTranscode | DeleteLiveStreamTranscode | Deletes a transcoding configuration. |
| DescribeLiveStreamTranscodeInfo | DescribeLiveStreamTranscodeInfo | Queries transcoding configurations. |
| AddTrancodeSEI | AddTrancodeSEI | Inserts Supplemental Enhancement Information (SEI) data into transcoded streams. |
Live recording to VOD
|
API |
Title |
Description |
| AddLiveRecordVodConfig | AddLiveRecordVodConfig | Creates a live-to-VOD configuration to store recordings in ApsaraVideo VOD. |
| UpdateLiveRecordVodConfig | UpdateLiveRecordVodConfig | Update a live-to-VOD configuration. |
| DeleteLiveRecordVodConfig | DeleteLiveRecordVodConfig | Deletes a Live-to-VOD configuration. |
| DescribeLiveRecordVodConfigs | DescribeLiveRecordVodConfigs | Queries live-to-VOD configurations of a streaming domain. |
Live recording to OSS
|
API |
Title |
Description |
| AddLiveAppRecordConfig | AddLiveAppRecordConfig | Configures live recording settings and saves the output to Object Storage Service (OSS). |
| RealTimeRecordCommand | RealTimeRecordCommand | Controls recordings manually on demand. You can start or stop recording at any time. |
| UpdateLiveAppRecordConfig | UpdateLiveAppRecordConfig | Updates a live stream recording configuration that saves the output to Object Storage Service (OSS). |
| DeleteLiveAppRecordConfig | DeleteLiveAppRecordConfig | Deletes a recording configuration at the AppName level. |
| DeleteLiveStreamRecordIndexFiles | DeleteLiveStreamRecordIndexFiles | Deletes the index files of live stream recordings. |
| DescribeLiveRecordConfig | Query All App Recording Configurations Under a Domain | Queries all APP recording configurations under a live streaming domain. |
| DescribeLiveStreamRecordContent | DescribeLiveStreamRecordContent | Queries the recordings of a live stream. |
| CreateLiveStreamRecordIndexFiles | CreateLiveStreamRecordIndexFiles | Creates an M3U8 manifest for a specified time range. |
| DescribeLiveStreamRecordIndexFile | DescribeLiveStreamRecordIndexFile | Queries a single recording manifest. |
| DescribeLiveStreamRecordIndexFiles | Query all recording index files within a specified time period | Queries all recording index files within a specified time period. |
| AddLiveRecordNotifyConfig | Add domain-level recording callback configuration | Adds a domain-level recording callback configuration. |
| DescribeLiveRecordNotifyConfig | DescribeLiveRecordNotifyConfig | This operation queries the recording callback configuration for a domain name. |
| UpdateLiveRecordNotifyConfig | Update domain-level recording callback configuration | Updates the domain-level recording callback configuration. |
| DescribeLiveRecordNotifyRecords | Query live stream recording callback records | Queries the callback records for live stream recordings stored in OSS. |
Live stream snapshot
|
API |
Title |
Description |
| AddLiveAppSnapshotConfig | AddLiveAppSnapshotConfig | Configures the snapshot feature for a streaming domain. The captured snapshots are stored in Object Storage Service (OSS). The configuration takes effect after you restart stream ingest. |
| DeleteLiveAppSnapshotConfig | DeleteLiveAppSnapshotConfig | Deletes the snapshot configuration for live streams in an application. The deletion takes effect after you restart stream ingest. |
| DeleteSnapshotFiles | DeleteSnapshotFiles | Deletes specified snapshot files. |
| DescribeLiveSnapshotConfig | Query snapshot configurations under a domain name | Queries the snapshot configurations under a streaming domain. |
| UpdateLiveAppSnapshotConfig | UpdateLiveAppSnapshotConfig | Modifies a snapshot configuration of a streaming domain. The captured snapshots are stored in Object Storage Service (OSS). The modification takes effect after you restart stream ingest. |
| DescribeLiveStreamSnapshotInfo | Query snapshot content within a time range | Queries snapshot content within a specified time range. |
| DescribeLiveSnapshotNotifyConfig | DescribeLiveSnapshotNotifyConfig | Queries the configuration for snapshot callbacks. |
| DeleteLiveSnapshotNotifyConfig | DeleteLiveSnapshotNotifyConfig | Deletes the snapshot callback configuration. |
| AddLiveSnapshotNotifyConfig | AddLiveSnapshotNotifyConfig | Configures snapshot callbacks. |
| UpdateLiveSnapshotNotifyConfig | UpdateLiveSnapshotNotifyConfig | Updates the snapshot callback configuration. |
| SetSnapshotCallbackAuth | SetSnapshotCallbackAuth | Configures authentication for snapshot callbacks. |
| QuerySnapshotCallbackAuth | QuerySnapshotCallbackAuth | Queries the authentication configuration for snapshot callbacks. |
| DeleteSnapshotCallbackAuth | DeleteSnapshotCallbackAuth | Deletes the authentication configuration for snapshot callbacks. |
Live stream packaging
|
API |
Title |
Description |
| AddLivePackageConfig | AddLivePackageConfig | You can call the AddLivePackageConfig operation to add a live stream packaging configuration. |
| UpdateLivePackageConfig | UpdateLivePackageConfig | Updates live encapsulation configurations. |
| DescribeLivePackageConfig | Query live packaging configuration | Queries the live packaging configuration under a streaming domain. |
| DeleteLivePackageConfig | DeleteLivePackageConfig | Deletes a live stream encapsulation configuration. |
Live stream content moderation
|
API |
Title |
Description |
| AddLiveSnapshotDetectPornConfig | AddLiveSnapshotDetectPornConfig | Adds a video moderation configuration for live streams in an application under a domain name. |
| AddLiveDetectNotifyConfig | AddLiveDetectNotifyConfig | Configures callbacks for video moderation results. As a result, a callback URL that is used to receive the callback notifications is added. |
| DescribeLiveSnapshotDetectPornConfig | Query live streaming content moderation configurations | Queries the content moderation configurations for live streaming. |
| DescribeLiveDetectNotifyConfig | DescribeLiveDetectNotifyConfig | Queries the configuration of callbacks for video moderation results. |
| UpdateLiveSnapshotDetectPornConfig | UpdateLiveSnapshotDetectPornConfig | Modifies a video moderation configuration. |
| UpdateLiveDetectNotifyConfig | UpdateLiveDetectNotifyConfig | Modifies the configuration of callbacks for video moderation results. As a result, the callback URL that is used to receive the callback notifications is changed. |
| DeleteLiveSnapshotDetectPornConfig | DeleteLiveSnapshotDetectPornConfig | Deletes a video moderation configuration. |
| DeleteLiveDetectNotifyConfig | DeleteLiveDetectNotifyConfig | Deletes the configuration of callbacks for video moderation results. |
| AddLiveAudioAuditConfig | AddLiveAudioAuditConfig | Adds an audio moderation configuration. |
| AddLiveAudioAuditNotifyConfig | AddLiveAudioAuditNotifyConfig | Adds a callback configuration for audio moderation. |
| DeleteLiveAudioAuditConfig | DeleteLiveAudioAuditConfig | Deletes an audio moderation configuration. |
| DeleteLiveAudioAuditNotifyConfig | DeleteLiveAudioAuditNotifyConfig | Deletes the callback configuration for automated audio review from a streaming domain. |
| UpdateLiveAudioAuditNotifyConfig | UpdateLiveAudioAuditNotifyConfig | Updates the callback configuration for automated audio review. |
| UpdateLiveAudioAuditConfig | UpdateLiveAudioAuditConfig | Updates the audio moderation configuration. |
| DescribeLiveAudioAuditConfig | DescribeLiveAudioAuditConfig | Queries the audio moderation configurations. |
| DescribeLiveAudioAuditNotifyConfig | DescribeLiveAudioAuditNotifyConfig | Queries the callback configuration for audio moderation. |
Global acceleration
|
API |
Title |
Description |
| CreateLivePrivateLine | CreateLivePrivateLine | Creates a Global Accelerator (GA) instance and binds it to an acceleration circuit. |
| DeleteLivePrivateLine | DeleteLivePrivateLine | Detaches a Global Accelerator instance from a live stream link. |
| DescribeLivePrivateLineAreas | DescribeLivePrivateLineAreas | Queries the available origin points for Global Accelerator links. |
| DescribeLivePrivateLineAvailGA | DescribeLivePrivateLineAvailGA | Queries the binding information between an Alibaba Cloud Global Accelerator (GA) instance and a live channel. |
Live streaming latency
|
API |
Title |
Description |
| DescribeLiveStreamDelayConfig | DescribeLiveStreamDelayConfig | Queries the live streaming latency. |
| SetLiveStreamDelayConfig | SetLiveStreamDelayConfig | You can call SetLiveStreamDelayConfig to configure live streaming latency. |
Monitoring and statistics
|
API |
Title |
Description |
| DescribeLiveDomainBpsData | Query network bandwidth monitoring data of a domain name | Queries the network bandwidth monitoring data of a live streaming domain. |
| DescribeLiveDomainTrafficData | Query traffic data for live streaming domains | Queries network traffic monitoring data for live streaming domains. |
| DescribeLiveStreamTranscodeMetricData | Query transcoding usage of video streams at stream granularity | Queries transcoding data for a specified domain name at the app and stream granularity. |
| DescribeLiveCenterStreamRateData | DescribeLiveCenterStreamRateData | Queries the audio and video frame rates and bitrates of a stream in a live center. |
| DescribeLiveDomainBpsDataByLayer | Query domain name bandwidth and traffic data by protocol | Queries bandwidth and traffic data of a domain name by protocol by calling DescribeLiveDomainBpsDataByLayer. |
| DescribeLiveDomainPushBpsData | Query network bandwidth monitoring data for stream ingest on an ingest domain | Queries the network bandwidth monitoring data for stream ingest on an ingest domain by calling DescribeLiveDomainPushBpsData. |
| DescribeLiveDomainPushTrafficData | Query ingest domain push traffic monitoring data | Queries the push traffic monitoring data of an ingest domain by calling DescribeLiveDomainPushTrafficData. |
| DescribeLiveStreamPushMetricDetailData | Query batch stream-granularity data for stream ingest of a specified domain name | Queries stream ingest data at the app and stream granularity for a specified domain name. |
| DescribeLiveDomainPublishErrorCode | Query ingest domain stream ingest status codes | Queries the stream ingest status codes for an ingest domain within a specified time range. |
| DescribeLiveUpVideoAudioInfo | DescribeLiveUpVideoAudioInfo | Queries the audio and video parameters of an upstream ingest stream within a specified time range. |
| DescribeLiveDomainRealTimeBpsData | DescribeLiveDomainRealTimeBpsData | Call the DescribeLiveDomainRealTimeBpsData operation to retrieve bandwidth data for a domain name at a 1-minute granularity. |
| DescribeLiveDomainRealTimeTrafficData | DescribeLiveDomainRealTimeTrafficData | Queries real-time traffic monitoring data for live streaming domain names. |
| DescribeLiveDomainRealTimeHttpCodeData | Query real-time HTTP status code proportions for live streaming domains | Retrieves the proportions of HTTP status codes for an accelerated domain name at a 1-minute granularity. |
| DescribeLiveStreamHistoryUserNum | DescribeLiveStreamHistoryUserNum | Queries the number of historical online users for a live stream. |
| DescribeLiveStreamCount | DescribeLiveStreamCount | Retrieves the real-time count of active original and transcoded streams for a specified streaming domain. |
| DescribeLiveStreamTranscodeStreamNum | Query the number of live stream transcoding streams | Queries the number of transcoding streams in real time by calling DescribeLiveStreamTranscodeStreamNum. |
| DescribeLiveDomainPvUvData | DescribeLiveDomainPvUvData | Queries the page view (PV) and unique visitor (UV) data for a specified streaming domain. |
| DescribeLiveTopDomainsByFlow | Query top domains by traffic | Queries the domains of a user ranked by traffic volume by calling DescribeLiveTopDomainsByFlow. |
| DescribeLiveStreamsTotalCount | Query the cumulative number of live streams at the day granularity | Queries the cumulative number of live streams at the day granularity by calling the DescribeLiveStreamsTotalCount operation. |
| DescribeLiveStreamMetricDetailData | Query stream-level batch data for a specified domain name | Queries stream-level batch data for a specified domain name. A maximum of 5,000 rows of data can be returned per query. |
| DescribeLiveStreamDetailFrameRateAndBitRateData | DescribeLiveStreamDetailFrameRateAndBitRateData | Queries the detailed audio and video frame rates and bitrates of a live stream that uses the Real-Time Messaging Protocol (RTMP). |
| DescribeLiveUserStreamMetricData | Query stream-level batch data for a specified domain | Queries stream-level batch data for a specified streaming domain. Multiple protocols are supported. |
Usage query
|
API |
Title |
Description |
| DescribeLiveDomainRecordUsageData | Query live recording streams and container format conversion usage | Queries the number of concurrent recording streams and container format conversion usage for ApsaraVideo Live. |
| DescribeLiveDomainSnapshotData | Query snapshot count data for a live streaming domain | Queries the number of snapshots captured for a live streaming domain. |
| DescribeLiveDetectPornData | DescribeLiveDetectPornData | You can call the DescribeLiveDetectPornData operation to query usage data for live stream moderation. |
| DescribeDomainUsageData | DescribeDomainUsageData | Call the DescribeDomainUsageData operation to query usage data for one or more domain names in a specific billing region. |
| DescribeLivePushProxyUsageData | Query live center relay usage data | Queries the usage data of live center relay by calling DescribeLivePushProxyUsageData. |
| DescribeLiveRealtimeDeliveryAcc | Query real-time log delivery count | Invokes DescribeLiveRealtimeDeliveryAcc to query the number of real-time log delivery attempts. |
| DescribeLiveDomainTimeShiftData | Query time shifting usage data for live streaming | Queries time shifting usage data for live streaming. |
| DescribeLiveDomainStreamTranscodeData | Query domain name transcoding usage data | Queries transcoding usage data for a domain name by calling DescribeLiveDomainStreamTranscodeData. |
| DescribeLiveProducerUsageData | Query producer studio usage data | Calls DescribeLiveProducerUsageData to query producer studio usage data. |
| DescribeLiveDomainMonitoringUsageData | Query domain name monitoring usage | Queries the monitoring usage data of a domain name by calling DescribeLiveDomainMonitoringUsageData. |
| DescribeLiveDelayedStreamingUsage | Query delayed streaming duration data | Calls DescribeLiveDelayedStreamingUsage to query delayed streaming duration usage data. |
| DescribeLiveGrtnDuration | Query co-hosting call duration usage data | Call DescribeLiveGrtnDuration to query co-hosting call duration usage data. |
| DescribeLiveDrmUsageData | Query live DRM usage data | Queries DRM usage data within a specified time range. |
| DescribeLiveRtcRecordUsageData | DescribeLiveRtcRecordUsageData | Queries the usage data of cloud recording. |
Cloud production studio
|
API |
Title |
Description |
| Production studio management | Production studio management | |
| CreateCaster | CreateCaster | Call the CreateCaster operation to create a production studio. |
| SetCasterConfig | SetCasterConfig | Call this operation to configure a production studio in detail, including the name, transcoding configuration, recording configuration, and other parameters of the production studio. |
| DescribeCasterConfig | DescribeCasterConfig | Queries the configuration of a production studio. |
| DescribeCasters | Query production studio list | Queries the list of production studios. |
| DescribeCasterStreamUrl | DescribeCasterStreamUrl | Queries the stream URL of a production studio. |
| CopyCaster | CopyCaster | Duplicates a production studio and creates a new production studio instance. |
| StartCaster | StartCaster | Starts a production studio. If the Preview (PVW) and Program (PGM) scenarios do not exist, this operation creates them, and then starts the scenarios and the underlying audio and video processing tasks. |
| StopCaster | StopCaster | Stops a production studio. This stops the PVW (preview scene) and PGM (program output scene) scenes. |
| DeleteCaster | DeleteCaster | Deletes a production studio. |
| RestartCaster | RestartCaster | Restarts a production studio. |
| UpdateCasterResourceGroup | UpdateCasterResourceGroup | Updates the resource group of a production studio. |
| Input source media management | Input source media management | |
| AddCasterVideoResource | AddCasterVideoResource | Adds a video source to a production studio. The number of video sources that you can add is limited by the number of ingest endpoints in the production studio. |
| DeleteCasterVideoResource | DeleteCasterVideoResource | Removes an input source from a production studio. |
| ModifyCasterVideoResource | ModifyCasterVideoResource | Modifies the video resources of a production studio. |
| DescribeCasterVideoResources | DescribeCasterVideoResources | Queries the video sources of a production studio. |
| Layout management | Layout management | |
| AddCasterLayout | AddCasterLayout | Adds a layout to a production studio. |
| DeleteCasterLayout | DeleteCasterLayout | Deletes a layout in a production studio. |
| ModifyCasterLayout | Modify production studio layout | Modifies a layout configuration. Only the items to be modified need to be passed. Items that do not require modification do not need to be included. |
| DescribeCasterLayouts | DescribeCasterLayouts | Queries the layouts of a production studio. |
| Component management | Component management | |
| AddCasterComponent | AddCasterComponent | Adds a component to a production studio. |
| DeleteCasterComponent | DeleteCasterComponent | Deletes a component from a production studio. |
| ModifyCasterComponent | ModifyCasterComponent | Modifies a component of a production studio. |
| DescribeCasterComponents | DescribeCasterComponents | Queries the list of components for a production studio. |
| Scene and audio management | Scene and audio management | |
| CopyCasterSceneConfig | CopyCasterSceneConfig | Applies the configuration of a PVW scene to a PGM scene. |
| DeleteCasterSceneConfig | DeleteCasterSceneConfig | Deletes the scene configuration of a production studio. |
| UpdateCasterSceneConfig | UpdateCasterSceneConfig | Modifies a scene, including the layout, without invalidating the previous configurations. This operation is more efficient than the SetCasterSceneConfig operation. |
| SetCasterSceneConfig | SetCasterSceneConfig | Configures all settings of a scene. This operation clears all previous settings of the scene and applies new settings, including the layout setting, to the scene. |
| DescribeCasterScenes | DescribeCasterScenes | Queries the scenes for a production studio. |
| UpdateCasterSceneAudio | UpdateCasterSceneAudio | Modifies the audio configurations of a scene. This operation also lets you add an audio configuration or apply an existing audio configuration to a new scene. |
| DescribeCasterSceneAudio | DescribeCasterSceneAudio | Queries the audio configuration of a scenario. |
| StartCasterScene | StartCasterScene | Starts a specified Program View (PVW) scene. This operation is used to start preview scenes. |
| StopCasterScene | StopCasterScene | Stops a specified preview (PVW) scene. |
| Channel management | Channel management | |
| SetCasterChannel | SetCasterChannel | Sets a channel for a production studio. |
| DescribeCasterChannels | DescribeCasterChannels | This operation queries the channels of a production studio. |
| Standby video management | Standby video management | |
| EffectCasterUrgent | EffectCasterUrgent | Switches a production studio to the standby resource. |
| EffectCasterVideoResource | EffectCasterVideoResource | Update the standby video of a production studio. |
| New playlist mode production studio management | New playlist mode production studio management | |
| AddShowIntoShowList | AddShowIntoShowList | Adds an episode to an episode list. |
| RemoveShowFromShowList | RemoveShowFromShowList | Removes an episode from an episode list. |
| ModifyShowList | ModifyShowList | Modifies the attributes of an episode list. |
| DescribeShowList | DescribeShowList | Queries a playlist. |
| PlayChoosenShow | PlayChoosenShow | Switches to a specified episode. |
| InitializeAutoShowListTask | InitializeAutoShowListTask | Creates a scheduled task. |
| DescribeAutoShowListTasks | DescribeAutoShowListTasks | Queries scheduled tasks for automatic start and stop. |
| EditShowAndReplace | EditShowAndReplace | Adds a video editing job. |
| GetEditingJobInfo | GetEditingJobInfo | Queries information about video editing jobs. |
| SetShowListBackground | Set playlist background | Sets the background for a playlist mode production studio. |
| Virtual studio management | Virtual studio management | |
| AddStudioLayout | AddStudioLayout | Adds layout settings for a virtual production studio. |
| DeleteStudioLayout | DeleteStudioLayout | Deletes a layout in a virtual studio. |
| ModifyStudioLayout | ModifyStudioLayout | Modifies the layout of a production studio. |
| DescribeStudioLayouts | DescribeStudioLayouts | Queries one or more layouts of a virtual studio. |
| (Legacy) playlist mode production studio | (Legacy) playlist mode production studio | |
| AddCasterEpisode | AddCasterEpisode | Adds an episode to a production studio. |
| DeleteCasterEpisode | DeleteCasterEpisode | Deletes an episode from a production studio. |
| ModifyCasterEpisode | ModifyCasterEpisode | Modifies the configuration of a production studio episode. The episode type cannot be modified. |
| AddCasterEpisodeGroup | AddCasterEpisodeGroup | Adds a program list to a production studio. |
| DeleteCasterEpisodeGroup | DeleteCasterEpisodeGroup | Deletes an episode list in a production studio. |
| AddCasterEpisodeGroupContent | AddCasterEpisodeGroupContent | Adds content to an episode group of a production studio. |
| AddCasterProgram | AddCasterProgram | Adds a program list to a production studio. |
| DescribeCasterProgram | DescribeCasterProgram | Queries the program list of a production studio. |
| ModifyCasterProgram | ModifyCasterProgram | This operation modifies the program list of a production studio. |
| DeleteCasterProgram | DeleteCasterProgram | Deletes the episode list for carousel playback in a production studio. |
| AddPlaylistItems | AddPlaylistItems | Adds items to a playlist. |
| DeletePlaylistItems | DeletePlaylistItems | Deletes items from a playlist. |
| ListPlaylistItems | ListPlaylistItems | Queries the items in a specified playlist. |
| EditPlaylist | EditPlaylist | Edits a playlist. |
| DeletePlaylist | DeletePlaylist | Deletes an entire playlist. |
| ListPlaylist | ListPlaylist | Queries episode lists. |
| StartPlaylist | StartPlaylist | Starts a playlist. |
| StopPlaylist | StopPlaylist | Stops playing an episode list. |
Live stream watermark
|
API |
Title |
Description |
| AddLiveStreamWatermark | AddLiveStreamWatermark | Adds a watermark template. |
| DeleteLiveStreamWatermark | DeleteLiveStreamWatermark | Deletes a specified watermark template. |
| UpdateLiveStreamWatermark | UpdateLiveStreamWatermark | Updates a watermark template. |
| DynamicUpdateWaterMarkStreamRule | DynamicUpdateWaterMarkStreamRule | Dynamically updates a watermark. |
| DescribeLiveStreamWatermarks | DescribeLiveStreamWatermarks | Queries watermark templates. |
| AddLiveStreamWatermarkRule | AddLiveStreamWatermarkRule | Adds a watermark rule. |
| DeleteLiveStreamWatermarkRule | DeleteLiveStreamWatermarkRule | Deletes a watermark rule. |
| UpdateLiveStreamWatermarkRule | UpdateLiveStreamWatermarkRule | Updates a watermark rule. |
| DescribeLiveStreamWatermarkRules | DescribeLiveStreamWatermarkRules | Queries a list of watermark rules. |
Edge transcoding
|
API |
Title |
Description |
| ListEdgeTranscodeTemplate | ListEdgeTranscodeTemplate | Queries a list of edge transcoding templates. |
| GetEdgeTranscodeTemplate | GetEdgeTranscodeTemplate | Queries the details of an edge transcoding template. |
| CreateEdgeTranscodeJob | CreateEdgeTranscodeJob | Creates an edge transcoding job. |
| DeleteEdgeTranscodeJob | DeleteEdgeTranscodeJob | Deletes an edge transcoding job. |
| ListEdgeTranscodeJob | ListEdgeTranscodeJob | Queries a list of edge transcoding jobs. |
| GetEdgeTranscodeJob | GetEdgeTranscodeJob | Queries the details of an edge transcoding job. |
| UpdateEdgeTranscodeJob | UpdateEdgeTranscodeJob | Updates an edge transcoding job. |
| StartEdgeTranscodeJob | StartEdgeTranscodeJob | Starts an edge transcoding task. |
| StopEdgeTranscodeJob | StopEdgeTranscodeJob | Stops an edge transcoding task. |
Live stream logs
|
API |
Title |
Description |
| EnableLiveRealtimeLogDelivery | EnableLiveRealtimeLogDelivery | Call the EnableLiveRealtimeLogDelivery operation to enable real-time log delivery for a domain name. |
| DisableLiveRealtimeLogDelivery | DisableLiveRealtimeLogDelivery | Call DisableLiveRealtimeLogDelivery to pause real-time log delivery for a domain name. |
| ModifyLiveRealtimeLogDelivery | ModifyLiveRealtimeLogDelivery | Modifies the real-time log delivery configuration for a domain name. |
| CreateLiveRealTimeLogDelivery | CreateLiveRealTimeLogDelivery | Configures real-time log delivery for a domain name. |
| DeleteLiveRealtimeLogDelivery | DeleteLiveRealtimeLogDelivery | Deletes a real-time log delivery configuration. |
| DescribeLiveDomainRealtimeLogDelivery | DescribeLiveDomainRealtimeLogDelivery | Queries the information about real-time log delivery for a domain name. |
| ListLiveRealtimeLogDelivery | ListLiveRealtimeLogDelivery | You can call the ListLiveRealtimeLogDelivery operation to query all real-time log delivery configurations. |
| ListLiveRealtimeLogDeliveryDomains | ListLiveRealtimeLogDeliveryDomains | Call ListLiveRealtimeLogDeliveryDomains to query all streaming domains that are configured for the real-time log delivery service. |
| ListLiveRealtimeLogDeliveryInfos | ListLiveRealtimeLogDeliveryInfos | Queries information about all real-time log delivery services. |
| DescribeLivePushProxyLog | Query download uRLs of offline relay logs | Retrieves the download URLs of offline logs for live stream relay by calling DescribeLivePushProxyLog. |
| DeleteLiveRealTimeLogLogstore | DeleteLiveRealTimeLogLogstore | Deletes a Logstore for real-time log delivery. |
| DescribeLiveDomainLog | Query log download uRLs | Retrieves the download URLs of raw access logs for a specified domain name in ApsaraVideo Live. |
Live stream monitoring
|
API |
Title |
Description |
| CreateLiveStreamMonitor | CreateLiveStreamMonitor | Creates a monitoring session. |
| UpdateLiveStreamMonitor | UpdateLiveStreamMonitor | Updates the configurations of a monitoring session. |
| DescribeLiveStreamMonitorList | DescribeLiveStreamMonitorList | Queries the list of created monitoring sessions. |
| StartLiveStreamMonitor | StartLiveStreamMonitor | Starts live monitoring. |
| StopLiveStreamMonitor | StopLiveStreamMonitor | Stops a monitoring session. |
| DeleteLiveStreamMonitor | DeleteLiveStreamMonitor | Deletes a monitoring session. |
Interactive messaging server API
|
API |
Title |
Description |
| GetMessageToken | GetMessageToken | Call GetMessageToken to obtain a persistent connection token. The client can use this token to communicate with various atomic capabilities through the LWP protocol via persistent connection. |
| CreateMessageApp | CreateMessageApp | You can call CreateMessageApp to create an interactive message application. |
| UpdateMessageApp | UpdateMessageApp | Call UpdateMessageApp to update interactive message application information. |
| ListMessageApp | ListMessageApp | Call ListMessageApp to query the list of interactive message applications. |
| GetMessageApp | GetMessageApp | You can call the GetMessageApp operation to retrieve the details of a specified interactive message application. |
| QueryMessageApp | QueryMessageApp | Call QueryMessageApp to query interactive message applications based on specified conditions. |
| DeleteMessageApp | DeleteMessageApp | Call DeleteMessageApp to delete an interactive message application. |
| CreateMessageGroup | CreateMessageGroup | Creates a message group. |
| UpdateMessageGroup | UpdateMessageGroup | You can call the UpdateMessageGroup operation to update message group information. |
| ListMessageGroupUser | ListMessageGroupUser | Query message group members. |
| ListMessageGroup | ListMessageGroup | Call ListMessageGroup to query the message group list for a specified user. |
| GetMessageGroup | GetMessageGroup | Call GetMessageGroup to retrieve message group details. |
| JoinMessageGroup | JoinMessageGroup | Join a message group. |
| MuteAllGroupUser | MuteAllGroupUser | Call MuteAllGroupUser to mute a message group, enabling group-wide muting. |
| MuteGroupUser | MuteGroupUser | Call MuteGroupUser to mute multiple members in a message group. |
| CancelMuteGroupUser | CancelMuteGroupUser | Calls CancelMuteGroupUser to batch unmute members in a message group. |
| CancelMuteAllGroupUser | CancelMuteAllGroupUser | Cancels the muting of a message group user. |
| LeaveMessageGroup | LeaveMessageGroup | Call LeaveMessageGroup to allow users to exit a message group. |
| SendLike | SendLike | Call SendLike to configure system like messages. |
| SendMessageToGroup | SendMessageToGroup | Call SendMessageToGroup to send messages to all members of a message group. |
| SendMessageToGroupUsers | SendMessageToGroupUsers | Call SendMessageToGroupUsers to send messages to specified users in a message group. |
| ListMessage | ListMessage | Queries the message list. |
| ListMessageGroupUserById | Indicates whether the user is muted. Valid values: * true * false | Call ListMessageGroupUserById to query user information by user ID list. |
| BatchGetOnlineUsers | BatchGetOnlineUsers | Queries whether one or more users are online based on their UIDs |
| ListMuteGroupUser | ListMuteGroupUser | Call ListMuteGroupUser to query the list of muted members in a message group. |
Interactive messaging (new)
|
API |
Title |
Description |
| CreateLiveMessageApp | CreateLiveMessageApp | Creates an interactive messaging application. |
| ModifyLiveMessageGroup | ModifyLiveMessageGroup | You can call the ModifyLiveMessageGroup operation to modify information about an interactive message group. |
| ModifyLiveMessageGroupBand | ModifyLiveMessageGroupBand | Changes the mute status of users in a group. |
| BanLiveMessageGroup | BanLiveMessageGroup | Call the BanLiveMessageGroup operation to mute a user. |
| AddLiveMessageGroupBand | AddLiveMessageGroupBand | The AddLiveMessageGroupBand operation mutes users in a group. |
| RemoveLiveMessageGroupBand | RemoveLiveMessageGroupBand | Unmutes users in a live interactive message group. |
| SendLiveMessageGroup | SendLiveMessageGroup | Sends a message to a group. |
ApsaraVideo real-time communication
|
API |
Title |
Description |
| Cloud recording | Cloud recording | |
| StartRtcCloudRecording | Start an RTC cloud recording task | Starts an RTC cloud recording task. |
| UpdateRtcCloudRecording | Update an RTC cloud recording task | Updates an RTC cloud recording task. |
| StopRtcCloudRecording | StopRtcCloudRecording | Stops an RTC cloud recording task. |
| DescribeRtcCloudRecordingFiles | Query RTC cloud recording files and task status | Queries the cloud recording files and task information for RTC. |
| Channel management | Channel management | |
| CreateRTCWhipStreamAddress | CreateRTCWhipStreamAddress | Creates a WHIP ingest URL for an ARTC channel. |
| CreateRoomRealTimeStreamAddress | CreateRoomRealTimeStreamAddress | Creates a Real-Time Messaging Protocol (RTMP) ingest URL for a channel. |
| ListRTCLiveRooms | ListRTCLiveRooms | Retrieves active ARTC channels. |
| Relay to CDN | Relay to CDN | |
| StartLiveMPUTask | StartLiveMPUTask | Creates a stream mixing and transcoding task. |
| UpdateLiveMPUTask | UpdateLiveMPUTask | Updates a mixed-stream relay task. |
| StopLiveMPUTask | StopLiveMPUTask | Stops a mixed-stream relay task. |
| ListRtcMPUTaskDetail | ListRtcMPUTaskDetail | Queries the parameters of mixed-stream relay tasks. |
| SetLiveMpuTaskSei | SetLiveMpuTaskSei | Configures custom supplemental enhancement information (SEI) for co-streaming. |
| Event callback | Event callback | |
| CreateEventSub | CreateEventSub | Creates a callback to subscribe to channel or user events. |
| UpdateEventSub | UpdateEventSub | Updates a callback that is used to subscribe to channel or user events. |
| CreateRtcMPUEventSub | Create a stream mixing and relaying event subscription | Creates an event subscription for stream mixing and relaying. |
| UpdateRtcMPUEventSub | UpdateRtcMPUEventSub | Updates a subscription to mixed-stream relay events. |
| DeleteRtcMPUEventSub | DeleteRtcMPUEventSub | Deletes a subscription to mixed-stream relay events. |
| DescribeRtcMPUEventSub | DescribeRtcMPUEventSub | Queries information about a subscription to mixed-stream relay events. |
| ListRtcMPUEventSubRecord | ListRtcMPUEventSubRecord | Queries the callback records of a subscription to mixed-stream relay events. |
| Quality data | Quality data | |
| DescribeLiveInteractionMetricData | DescribeLiveInteractionMetricData | Queries metric data for ApsaraVideo Real-time Communication (ARTC). |
Real-time subtitles
|
API |
Title |
Description |
| DeleteLiveAIProduceRules | DeleteLiveAIProduceRules | Deletes caption rules. |
| DescribeLiveAIProduceRules | DescribeLiveAIProduceRules | Queries a list of caption rules. |
| UpdateLiveAIProduceRules | UpdateLiveAIProduceRules | Updates a caption rule. |
| AddLiveAIProduceRules | AddLiveAIProduceRules | Adds a subtitle rule. |
| AddLiveAISubtitle | Add a live subtitle template | Adds a subtitle template by calling AddLiveAISubtitle. |
| DeleteLiveAISubtitle | DeleteLiveAISubtitle | Deletes a specified subtitle template. |
| UpdateLiveAISubtitle | Update a subtitle template | Updates a subtitle template by calling UpdateLiveAISubtitle. |
| DescribeLiveAISubtitle | DescribeLiveAISubtitle | You can call the DescribeLiveAISubtitle operation to query a list of caption templates. |
Virtual background
|
API |
Title |
Description |
| CreateLiveAIStudio | Create a virtual studio template | Creates a lightweight virtual studio template. |
| DeleteLiveAIStudio | DeleteLiveAIStudio | Deletes a virtual studio template. |
| ModifyLiveAIStudio | Modify Virtual Studio Template | This API is used to modify the specified virtual studio template. |
| DescribeLiveAIStudio | DescribeLiveAIStudio | Queries the virtual studio templates in your account. |
Stream pulling and relaying
|
API |
Title |
Description |
| CreateLivePullToPush | Create a pull-to-push task | Call CreateLivePullToPush to create a pull-to-push task. |
| UpdateLivePullToPush | Update a stream pulling and pushing task | Updates a stream pulling and pushing task by calling UpdateLivePullToPush. |
| DeleteLivePullToPush | Delete a stream pulling-to-pushing task | Deletes a stream pulling-to-pushing task by calling DeleteLivePullToPush. |
| DescribeLivePullToPush | Query pull-to-push streaming task | Calls DescribeLivePullToPush to query a pull-to-push streaming task. |
| DescribeLivePullToPushList | Fuzzy Query for Pull-to-Push Tasks | Fuzzy query for stream pulling and pushing tasks. |
| StopLivePullToPush | Stop a stream pulling task | Stops a stream pulling task. |
| RestartLivePullToPush | Restart a stream pulling task | Restarts a stream pulling task. |
Dual-stream disaster recovery
|
API |
Title |
Description |
| SetLiveDomainMultiStreamOptimalMode | Set dual-stream disaster recovery automatic mode switch | Sets the automatic mode switch for dual-stream disaster recovery. |
| SetLiveDomainMultiStreamMaster | SetLiveDomainMultiStreamMaster | Manually switches between the active stream and standby stream. |
| DescribeLiveDomainMultiStreamConfig | DescribeLiveDomainMultiStreamConfig | Queries the configuration status of dual-stream disaster recovery. |
| QueryLiveDomainMultiStreamList | Query dual-stream disaster recovery online records | Queries dual-stream disaster recovery online records. |
Edge scripting
|
API |
Title |
Description |
| DescribeLiveDomainStagingConfig | DescribeLiveDomainStagingConfig | Queries the feature configurations of an accelerated domain name in the canary release environment. |
| PublishLiveStagingConfigToProduction | PublishLiveStagingConfigToProduction | Publishes the configurations of an accelerated domain name from the canary release environment to the production environment. |
| RollbackLiveStagingConfig | RollbackLiveStagingConfig | Rolls back the configurations of an accelerated domain name in the canary release environment. |
| SetLiveDomainStagingConfig | SetLiveDomainStagingConfig | Sets or modifies domain configurations in the canary release environment. |
| DeleteLiveSpecificStagingConfig | DeleteLiveSpecificStagingConfig | You can call the DeleteLiveSpecificStagingConfig operation to delete domain name configurations in a grayscale environment. |
Toolbox
|
API |
Title |
Description |
| DescribeLiveIpInfo | DescribeLiveIpInfo | Checks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP). |
| DescribeLiveStreamAuthChecking | DescribeLiveStreamAuthChecking | Queries the authentication status of an active stream. |
Tag management
|
API |
Title |
Description |
| TagLiveResources | Add labels to live resources | Adds labels to ApsaraVideo Live resources by calling TagLiveResources. |
| UnTagLiveResources | Delete apsaraVideo live resource tags | Calls UnTagLiveResources to delete tags from ApsaraVideo Live resources. |
| ListLiveTagResources | Query resources and tags that meet specified conditions | Queries resources and tags that meet the specified conditions. |
| DescribeLiveTagResources | DescribeLiveTagResources | Queries the tags of ApsaraVideo Live resources. |
Others
|
API |
Title |
Description |
| AddLiveCenterTransfer | Add live center stream relay configuration | Adds a live center stream relay configuration. |
| CheckLiveMessageUsersInGroup | CheckLiveMessageUsersInGroup | Queries whether a user is in an interactive messaging group. |
| CheckLiveMessageUsersOnline | CheckLiveMessageUsersOnline | Queries whether one or more specified users are online. |
| CreateLiveMessageGroup | CreateLiveMessageGroup | Creates an interactive messaging group. |
| CreateRtcAsrTask | Create real-time speech-to-text or translation | Creates a real-time subtitle task to transcribe an audio stream into text in real time. |
| DeleteChannel | DeleteChannel | This operation closes a channel and removes all current members. The channel can be reused later. |
| DeleteEventSub | DeleteEventSub | Deletes a callback that is used to subscribe to channel or user events. |
| DeleteLiveCenterTransfer | DeleteLiveCenterTransfer | Deletes a live center stream relay configuration. |
| DeleteLiveEdgeTransfer | Delete live stream edge transfer configuration | Delete the live stream edge transfer configuration. |
| DeleteLiveMessageGroup | DeleteLiveMessageGroup | Deletes an interactive messaging group. |
| DeleteLiveMessageGroupMessage | DeleteLiveMessageGroupMessage | Deletes a message that was sent to an interactive messaging group. |
| DeleteLiveMessageUserMessage | DeleteLiveMessageUserMessage | Deletes a message that is sent to a user. |
| DeleteLiveRecordNotifyConfig | DeleteLiveRecordNotifyConfig | Deletes the configuration of callbacks for live stream recording under a domain name. |
| DeleteRtcAsrTask | DeleteRtcAsrTask | Call `DeleteRtcAsrTask` to delete a real-time speech-to-text or translation task. |
| DescribeChannelParticipants | DescribeChannelParticipants | Queries online users in a channel. |
| DescribeChannelUsers | DescribeChannelUsers | Queries the details of online users in a channel. |
| DescribeDomainWithIntegrity | DescribeDomainWithIntegrity | Obtains the integrity of a domain name. |
| DescribeLiveCenterTransfer | Query live center stream relay | Queries the live center stream relay configuration by calling DescribeLiveCenterTransfer. |
| DescribeLiveEdgeTransfer | DescribeLiveEdgeTransfer | Retrieves the configuration of edge stream relay. |
| DescribeLiveMessageApp | DescribeLiveMessageApp | Query Interactive Message App |
| DescribeLiveMessageGroup | DescribeLiveMessageGroup | Queries the information about an interactive messaging group. |
| DescribeLiveMessageGroupBand | DescribeLiveMessageGroupBand | Queries the mute status of users. |
| DescribeLiveRealtimeLogAuthorized | DescribeLiveRealtimeLogAuthorized | Queries the authorization status for real-time log delivery. |
| DescribeLiveUserBillPrediction | DescribeLiveUserBillPrediction | Retrieves the bill prediction for a live streaming user. |
| DescribeLiveUserDomains | DescribeLiveUserDomains | Queries domain names of ApsaraVideo Live in your Alibaba Cloud account. |
| DescribeMeterLiveBypassDuration | Query stream mixing transcoding usage data | DescribeMeterLiveBypassDuration. |
| DescribeRTSNativeSDKFirstFrameCost | Query first frame latency composition | Retrieves the first frame latency composition within a specified time period. |
| DescribeRTSNativeSDKFirstFrameDelay | Query First Frame Delay | Query the average first frame delay within a specified time period |
| DescribeRTSNativeSDKPlayFailStatus | Query playback failure reasons | Queries the reasons for playback failures (in the form of status codes) within a specified time period. |
| DescribeRTSNativeSDKPlayTime | Query playback duration | Retrieves the playback duration within a specified time range. |
| DescribeRTSNativeSDKVvData | Query playback count | Retrieves the playback count within a specified time period, including the total count and the successful count. |
| DescribeRtcCloudTranscode | Query a cloud transcoding task | Queries a cloud transcoding task. |
| DescribeToutiaoLivePlay | DescribeToutiaoLivePlay | This operation queries stream pulling information for a specified Toutiao live stream. |
| DescribeToutiaoLivePublish | DescribeToutiaoLivePublish | Queries the stream ingest information for a specified Toutiao live stream. |
| DescribeUpBpsPeakData | Query daily peak upstream bandwidth of a user | Queries the daily peak upstream bandwidth of a user. |
| DescribeUpBpsPeakOfLine | Query daily peak upstream bandwidth of a specific dedicated line | Queries the daily peak upstream bandwidth of a specific dedicated line for a user. |
| DescribeUpPeakPublishStreamData | Query daily peak concurrent upstream ingest streams | Queries the daily peak number of concurrent upstream ingest streams for a user. |
| KickLiveMessageGroupUser | KickLiveMessageGroupUser | Removes a user from an interactive messaging group. |
| ListEventSub | ListEventSub | Queries the events generated in channels to which you subscribe. |
| ListEventSubEvent | ListEventSubEvent | Queries callback records. |
| ListLiveMessageApps | ListLiveMessageApps | Queries interactive messaging applications. |
| ListLiveMessageGroupByPage | ListLiveMessageGroupByPage | Queries interactive messaging groups by page. |
| ListLiveMessageGroupMessages | ListLiveMessageGroupMessages | Queries the messages sent in a group. |
| ListLiveMessageGroupUsers | ListLiveMessageGroupUsers | Queries the users in an interactive messaging group. |
| ListLiveMessageGroups | ListLiveMessageGroups | Queries the interactive messaging groups in an interactive messaging application. |
| ModifyLiveMessageAppAudit | ModifyLiveMessageAppAudit | Modifies the content moderation settings of an interactive messaging application. |
| ModifyLiveMessageAppCallback | ModifyLiveMessageAppCallback | Modifies the callback settings of an interactive messaging application. |
| ModifyLiveMessageAppDisable | ModifyLiveMessageAppDisable | Disables or enables an interactive messaging application. |
| ModifyLiveMessageUserInfo | ModifyLiveMessageUserInfo | Modifies the information about a user. |
| QueryRtcAsrTasks | QueryRtcAsrTasks | Queries the status of created real-time speech-to-text or translation tasks. |
| RecoverLiveMessageDeletedGroup | RecoverLiveMessageDeletedGroup | Restores a deleted interactive messaging group. |
| RemoveTerminals | RemoveTerminals | Removes users from a channel. |
| SendLiveMessageUser | SendLiveMessageUser | Sends a message to a specified user. The user is identified by ReceiverId. |
| SetLiveDomainMultiStreamConfig | Set dual-stream disaster recovery switch | Calls SetLiveDomainMultiStreamConfig to enable or disable the dual-stream disaster recovery switch. |
| SetLiveEdgeTransfer | Configure live stream relay settings | Calls SetLiveEdgeTransfer to configure live stream relay settings. |
| StartRtcCloudTranscode | StartRtcCloudTranscode | Creates a cloud transcoding job. |
| StopRtcAsrTask | StopRtcAsrTask | Stops a live subtitle task. |
| StopRtcCloudTranscode | StopRtcCloudTranscode | Stops a cloud transcoding job. |
| UnbanLiveMessageGroup | UnbanLiveMessageGroup | Unmutes a group. |
| UpdateLiveCenterTransfer | Update live center transfer configuration | Updates the live center transfer configuration by calling UpdateLiveCenterTransfer. |
Is this page helpful?