API overview

更新时间:
复制 MD 格式

This topic outlines the server-side APIs for Real-Time Communication.

Application management

APIDescription
ModifyAppModifies the name of a specified application.
DescribeAppsQueries a list of applications.
DescribeAppKeyQueries the AppKey of a specified application.

Channel management

APIDescription
DeleteChannelDeletes a channel.
RemoveTerminalsRemoves specified end users from a channel.
DescribeChannelUsersQueries the details of online users in a channel across different patterns.
DescribeUserInfoInChannelQueries the real-time information of a user in a channel.
DescribeChannelParticipantsQueries the list of online users in a channel.

Bypass streaming

APIDescription
StartMPUTaskStarts a bypass streaming task.
GetMPUTaskStatusGets the status of a bypass streaming task.
StopMPUTaskStops a bypass streaming task.
UpdateMPUTaskUpdates a bypass streaming task.

Automatic single-stream bypass rules

APIDescription
CreateAutoLiveStreamRuleCreates an automatic single-stream bypass rule.
DeleteAutoLiveStreamRuleDeletes an automatic single-stream bypass rule.
DescribeAutoLiveStreamRuleQueries an automatic single-stream bypass rule.
EnableAutoLiveStreamRuleEnables an automatic single-stream bypass rule.
DisableAutoLiveStreamRuleDisables an automatic single-stream bypass rule.
UpdateAutoLiveStreamRuleModifies an automatic single-stream bypass rule.

Layout management

APIDescription
DeleteMPULayoutDeletes a bypass streaming layout.
CreateMPULayoutCreates a bypass streaming layout.
DescribeMPULayoutInfoListGets the layout parameters for a bypass streaming task.
ModifyMPULayoutModifies a bypass streaming layout.

Cloud recording

APIDescription
AddRecordTemplateAdds a recording configuration template.
DeleteRecordTemplateDeletes a recording configuration template.
UpdateRecordTemplateUpdates a recording configuration template.
DescribeRecordTemplatesQueries a list of recording template configurations.
DescribeRecordFilesQueries a list of generated recording files.
StartRecordTaskStarts a video recording task.
StopRecordTaskStops a video recording task.
UpdateRecordTaskUpdates a video recording task.

Event callbacks

APIDescription
CreateEventSubscribeCreates a callback to subscribe to channel messages.
DeleteEventSubscribeDeletes a callback that subscribes to channel messages.