API overview-Real-Time Communication(RTC)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (rtc/2018-01-11) 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.

Application management

API	Title	Description
ModifyApp	Modify the name of a specified application	Invoke ModifyApp to modify the name of a specified application.
DescribeApps	Query application list	Invoke DescribeApps to query the application list.
DescribeAppKey	Query the AppKey of a specified application	Invoke DescribeAppKey to query the AppKey of a specified application.

Layout

API	Title	Description
CreateAppLayout	Create a custom layout	Create a custom app layout.
ModifyAppLayout	Modify custom layout	Modify a custom application layout.
DeleteAppLayout	Delete a custom layout	Delete a custom application layout.
DescribeAppLayouts	Query Custom layout List	Query custom application layouts.
DescribeSystemLayoutList	Query the List of Built-in System Layouts	Built-in system layouts

Callback management

API	Title	Description
DescribeAppCallStatus	Query application callback status	View application callback toggle
ModifyAppCallbackStatus	Modify application callback status	Update the application callback management event toggle
DescribeAllCallback	All management events supported by system callbacks	Lists the event callbacks supported by the system.
DescribeCallbacks	Query application webhook List	Lists the event callbacks configured for an application.
DescribeAppCallbackSecretKey	Query callback key	Obtain the application callback key
ModifyCallbackMeta	Modify application callback	Update application callback
StartCategoryCallback	Enable a management event callback	Starts an event callback.
StopCategoryCallback	Shut down a management event callback	Shuts down an event callback.

Channel management

API	Title	Description
DescribeChannels	Query Online Channel List	This operation retrieves a list of all active channels for a single AppId.
StopChannel	Shutdown Channel	This API is used by the server to actively shut down a channel.
DescribeChannelAllUsers	Query Online Users in a Channel	This API is used to query the user list in a channel.
DescribeChannelUser	Query User Information Within a Channel	DescribeChannelUser
DescribeChannel	Query Online Channel Information	DescribeChannel
RemoveUsers	Kick Out User	RemoveUsers

Cloud recording

API	Title	Description
Recording template management	Recording template management
DescribeAppRecordStatus	Query the status of the recording feature	Queries the recording status of an application.
ModifyAppRecordStatus	Modify the status of the recording feature	Modify the application recording toggle
CreateAppRecordTemplate	Create a recording template	Adds an application recording template.
ModifyAppRecordTemplate	Modify recording template	Modify an application recording template.
DeleteAppRecordTemplate	Delete recording template	Delete an application recording template.
DescribeAppRecordTemplates	Query recording template list	Lists application recording templates.
Cloud recording operations	Cloud recording operations
DescribeCloudRecordStatus	Query recording status	Query the status of a recording task.
DescribeAppRecordingFiles	Recording List	Lists recording files.
StartCloudRecord	Start Cloud Recording Job	Start a cloud recording task.
UpdateCloudRecord	Update a cloud recording job	Updates a cloud recording task.
StopCloudRecord	Stop Cloud Recording Job	StopCloudRecord

Relay streaming

API	Title	Description
Streaming template management	Streaming template management
DescribeAppLiveStreamStatus	Query the status of the bypass stream ingest feature	View the application bypass switch.
ModifyAppLiveStreamStatus	Modify the status of the bypass stream ingest feature	Modify the bypass toggle of an application
CreateAppStreamingOutTemplate	Create a stream ingest template	Create an RTC 3.0 application stream ingest template.
ModifyAppStreamingOutTemplate	Modify stream ingest template	Modify the stream ingest template for an RTC 3.0 application.
DeleteAppStreamingOutTemplate	Delete Stream Ingest Template	Delete an RTC 3.0 application stream ingest template.
DescribeAppStreamingOutTemplates	Query stream ingest template list	Query the list of stream ingest templates under an RTC 3.0 application.
Relay streaming operations	Relay streaming operations
DescribeStreamingOutStatus	Query bypass stream ingest status	Queries the status of a streaming-out task.
StartStreamingOut	Start Bypass Stream Ingest Job	StartStreamingOut
UpdateStreamingOut	Update a bypass stream ingest job	Updates a bypass stream ingest task.
StopStreamingOut	Stop Bypass Stream Ingest Job	StopStreamingOut

Minutes

API	Title	Description
Hot word list	Hot word list
CreateCloudNotePhrases	Create a hotword list	Add a keyword list to the meeting minutes.
ModifyCloudNotePhrases	Modify hotword list	You can update the hotword list for meeting minutes.
DescribeCloudNotePhrases	Hot word List	Summary of trending terms
DeleteCloudNotePhrases	Delete hotword table	Delete the hot words list for meeting minutes.
StartCloudNote	Start Meeting Summary Job	Enable intelligent summary
StopCloudNote	Stop Summary Job	Stop Intelligent Summary
DescribeCloudNotes	Summary File List	Meeting Summary List

Agent

API	Title	Description
Agent template management	Agent template management
DescribeAppAgentFunctionStatus	Query the agent feature toggle	Query the status of the application agent feature.
ModifyAppAgentFunctionStatus	Modify the agent feature toggle	Toggle the application agent feature
ModifyAppAgentTemplate	Modify agent template	Updating an application agent template
DescribeAppAgentTemplates	Query agent template list	Application agent templates
DeleteAppAgentTemplate	Delete agent template	Deletes an application agent template.
CreateAppAgentTemplate	Create Agent Template	Create an application agent template
Agent operations	Agent operations
StartAgent	Start Agent	Start AI Agent
GetAgent	Query agent status	GetAgent.
UpdateAgent	Update Agent	Update an AI Agent
NotifyAgent	Custom Message Announcement	NotifyAgent
StopAgent	Shutdown Agent	Stops an AI Agent.

SIP

API	Title	Description
Mix-stream template management	Mix-stream template management
DescribeAppViewStatus	Query stream merging feature status	View the stream merging switch
ModifyAppViewStatus	Modify the status of the stream merging feature	Modify the stream mixing switch.
CreateAppViewTemplate	Create a stream merging template	Create an application composite streaming template.
ModifyAppViewTemplate	Modify stream mixing template	Update an application view template.
DescribeAppViewTemplates	Stream Mixing Template List	Lists application compositing templates.
DeleteAppViewTemplate	Delete stream merging template	Deletes an application's composite stream template.
Task operations	Task operations
RtcSipInviteMember	Invite SIP to a meeting	Invite a SIP device to join a channel
RtcCancelSipInvite	Cancel SIP Outbound Call	Cancels a SIP invite.
StartView	Enable stream mixing	Start stream composition.
StopView	Stop stream mixing	Stop stream mixing.
RtcSipMute	Microphone toggle control for SIP endpoints	Mute operation
ModifyViewLayout	[parameters_AppId_schema_type]string	Configures the stream mixing layout.
ModifyStreamingProperty	Modify Sip stream configuration	Set stream properties

Data service

API	Title	Description
Communication monitoring	Communication monitoring
DescribeCallList	Paged query of communication information within a time range	Invoke DescribeCallList to perform a paged query of communication records created within a specified time range.
DescribeCall	Query details of a single communication session	This API is used to query the details of a single communication session. For example, you can query the communication status, user details, and other information.
DescribePubUserListBySubUser	Retrieve the list of publishing users during communication from the subscriber side	This API is used to obtain the list of publishing users in a communication session based on the subscriber.
DescribeEndPointEventList	Obtain End-to-End User Event List	This API is used to retrieve the end-to-end user management event List.
DescribeEndPointMetricData	Obtain end-to-end Metric Data	This API is used to obtain end-to-end metric data.
DescribeQoeMetricData	Downlink Quality of Experience Metrics for a Single Communication Session	This API is used to obtain the downlink experience quality metrics of a user in a single communication session.
Channel data	Channel data
DescribeChannelOverallData	Query channel overview data	This API is used to query channel overview data.
DescribeChannelDistributionStatData	Obtain Channel Distribution Statistics	This API is used to obtain channel distribution statistics.
DescribeChannelAreaDistributionStatData	Obtain channel geographical distribution statistics	This API is used to obtain the statistics on the regional distribution of channels.
DescribeChannelTopPubUserList	Obtain the list of publishing users in the channel	This API is used to retrieve the list of publishing users in a channel, sorted in descending order by their online duration.
DescribeChannelUserMetrics	Query user data in channel overview	[responses_200_schema_properties_MetricDatas_description]List of metric data.
Usage statistics	Usage statistics
DescribeUsageOverallData	Obtain overview data of usage statistics	This API is used to retrieve overview data of usage statistics.
DescribeUsageDistributionStatData	Obtain distribution data of usage statistics	This API is used to retrieve the distribution data of usage statistics.
DescribeUsageAreaDistributionStatData	Retrieve Regional Distribution Data of Usage Statistics	This API is used to retrieve the regional distribution data of usage statistics.
DescribeUsageOsSdkVersionDistributionStatData	Usage Distribution by Operating System and SDK Version	This API is used to obtain the distribution data of operating systems and SDK versions in usage statistics.
Quality statistics	Quality statistics
DescribeQualityOverallData	Obtain overview data of quality statistics	This API is used to obtain overview data of quality statistics.
DescribeQualityDistributionStatData	Obtain distribution data of quality statistics	This API is used to obtain the distribution data of quality statistics.
DescribeQualityAreaDistributionStatData	Obtain regional distribution data of quality statistics.	This API is used to obtain the regional distribution data of quality statistics.
DescribeQualityOsSdkVersionDistributionStatData	Version Distribution by Operating System and SDK for Quality Metrics	This API is used to obtain the distribution data of operating systems and SDK versions in quality statistics.
Anomaly diagnostics	Anomaly diagnostics
DescribeFaultDiagnosisOverallData	Obtain overview data for abnormal Diagnosis.	Invoke DescribeFaultDiagnosisOverallData to obtain the overview data for abnormal diagnosis.
DescribeFaultDiagnosisFactorDistributionStat	Retrieve the distribution of factors impacting abnormal diagnosis	Invoke the DescribeFaultDiagnosisFactorDistributionStat API to obtain the distribution of factors impacting abnormal diagnosis.
DescribeFaultDiagnosisUserList	Obtain the detailed user list for abnormal diagnosis	Invoke DescribeFaultDiagnosisUserList to obtain the list of user details for abnormal diagnosis.
DescribeFaultDiagnosisUserDetail	获取异常诊断的用户详情	[responses_200_schema_properties_UserDetail_properties_Duration_type]integer

RTC (legacy)

API	Title	Description
Channel management (legacy)	Channel management (legacy)
DeleteChannel	Delete a channel	Calls DeleteChannel to delete a channel.
DescribeChannelParticipants	Query the List of Online Users in a Channel	Queries the list of online users in a channel. The response does not include detailed user information.
DescribeChannelUsers	Query real-time online users	Queries the list of real-time online users in a channel.
RemoveTerminals	Kick Specified End Users from a Channel	Call the RemoveTerminals operation to remove specified end users from a channel.
Relay streaming (legacy)	Relay streaming (legacy)
GetMPUTaskStatus	Query the status of a task	Calls GetMPUTaskStatus to query the status of a stream relay task.