文档中心

实时音视频

服务端 API 参考

API 列表

API 列表

房间管理

API	说明
BanUserStream	封禁音视频流 BanUserStream
UnbanUserStream	解封音视频流 UnbanUserStream
BanRoomUser	封禁房间&用户 BanRoomUser
UpdateBanRoomUserRule	更新房间&用户封禁规则 UpdateBanRoomUserRule
GetRoomOnlineUsers	获取实时用户列表 GetRoomOnlineUsers
GetRoomUsersProperty	查询用户状态 GetRoomUsersProperty
LimitTokenPrivilege	限制 Token 发布权限 LimitTokenPrivilege
KickUser	（不推荐使用）移出用户 KickUser
DismissRoom	（不推荐使用）解散房间 DismissRoom

云端录制

API	说明
StartRecord	开始云端录制 StartRecord
UpdateRecord	更新云端录制 UpdateRecord
StopRecord	结束云端录制 StopRecord
GetRecordTask	查询录制任务状态 GetRecordTask

转推直播

API	说明
StartPushMixedStreamToCDN	开始合流转推 StartPushMixedStreamToCDN
StartPushSingleStreamToCDN	开始单流转推 StartPushSingleStreamToCDN
UpdatePushMixedStreamToCDN	更新合流转推 UpdatePushMixedStreamToCDN
StopPushStreamToCDN	结束转推直播 StopPushStreamToCDN
GetPushSingleStreamToCDNTask	查询单流转推任务状态 GetPushSingleStreamToCDNTask
GetPushMixedStreamToCDNTask	查询合流转推任务状态 GetPushMixedStreamToCDNTask

音频切片

API	说明
StartSegment	开启音频切片 StartSegment
UpdateSegment	更新音频切片 UpdateSegment
StopSegment	结束音频切片 StopSegment
GetSegmentTask	查询音频切片任务状态 GetSegmentTask

抽帧截图

API	说明
StartSnapshot	开启抽帧截图 StartSnapshot
UpdateSnapshot	更新抽帧参数 UpdateSnapshot
StopSnapshot	关闭抽帧截图 StopSnapshot
GetSnapshotTask	查询抽帧截图任务状态 GetSnapshotTask

输入在线媒体流

API	说明
StartRelayStream	开始在线媒体流输入 StartRelayStream
UpdateRelayStream	更新在线媒体流输入 UpdateRelayStream
StopRelayStream	停止在线媒体流输入 StopRelayStream
ListRelayStream	查询输入媒体流任务 ListRelayStream

WTN 流（原公共流）

API	说明
StartPushPublicStream	发布公共流 StartPushPublicStream
UpdatePublicStreamParam	更新公共流 UpdatePublicStreamParam
StopPushPublicStream	停止发布公共流 StopPushPublicStream

云录屏

API	说明
StartWebcast	开启云录屏 StartWebcast
StopWebcast	结束云录屏 StopWebcast
GetWebCastTask	查询云录屏任务状态 GetWebCastTask

实时数据监控

API	说明
ListRealTimeQuality	获取实时质量数据 ListRealTimeQuality
ListRealTimeOperationData	获取实时运营数据 ListRealTimeOperationData
ListRealTimeQualityDistribution	获取实时分布质量数据 ListRealTimeQualityDistribution
ListCallDetail	获取通话质量指标 ListCallDetail
ListRealTimePublicStreamInfo	获取实时公共流订阅数据 ListRealTimePublicStreamInfo

历史数据查询

API	说明
ListQuality	获取离线数据指标 ListQuality
ListOperationData	获取离线运营数据 ListOperationData
ListOperationDistribution	获取离线运营分布数据 ListOperationDistribution
ListQualityDistribution	获取离线分布质量数据 ListQualityDistribution
ListRoomInfo	获取离线通话房间列表 ListRoomInfo
ListUserInfo	获取离线用户通话详情 ListUserInfo
ListUsages	获取通话时长数据 ListUsages

应用管理

API	说明
CreateApp	创建应用 CreateApp
ListApps	查询应用 ListApps
ModifyAppStatus	启用&停用应用 ModifyAppStatus

业务标识管理

API	说明
AddBusinessID	添加业务标识 AddBusinessID
ModifyBusinessRemarks	修改业务标识名称 ModifyBusinessRemarks
GetAllBusinessID	获取业务标识 GetAllBusinessID
DeleteBusinessID	删除业务标识 DeleteBusinessID

实时消息通信

API	说明
SendUnicast	发送房间外点对点消息 SendUnicast
SendRoomUnicast	发送房间内点对点消息 SendRoomUnicast
SendBroadcast	发送房间内广播消息 SendBroadcast
BatchSendRoomUnicast	批量发送房间内点对点消息 BatchSendRoomUnicast

实时通话字幕和翻译

API	说明
StartSubtitle	开启实时字幕 StartSubtitle
UpdateSubtitle	更新实时字幕 UpdateSubtitle
StopSubtitle	停止实时字幕 StopSubtitle

最近更新时间：2026.03.02 17:57:32

这个页面对您有帮助吗？

有用

有用

无用

无用