2023-11-01
| 新增接口 | 接口描述 |
|---|---|
| ModifyAppStatus | 控制指定应用的启用/停用状态。 |
2023-11-012023-06-012022-06-012020-12-01
存储方式选择 VOD 时，新增海外存储 Region：ap-southeast-1。
2023-11-01
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。| 新增接口 | 接口描述 |
|---|---|
| ListQuality | 查询一段时间内，某个应用的音视频通话离线质量指标数据。 |
| ListUsages | 查询一段时间内，某个应用的通话时长数据。 |
| ListRealTimeQuality | 查询一段时间内，某个应用的音视频通话实时质量指标数据。 |
| ListRealTimeOperationData | 查询一段时间内，某个应用的音视频通话实时运营数据。 |
| ListRealTimeQualityDistribution | 查询一段时间内，某个应用的音视频通话在地域分布、设备平台、网络类型等维度的实时质量指标数据。 |
| ListOperationData | 查询一段时间内，某个应用的音视频通话的离线运营数据。 |
| ListOperationDistribution | 查询一段时间内，某个应用的音视频通话在地域维度的离线运营质量指标数据。 |
| ListQualityDistribution | 查询一段时间内某个应用的音视频通话在不同维度的离线质量指标数据。 |
2023-11-01
StartRecord 接口新增 StorageClass 请求参数，上传到视频点播平台时, 支持选择文件的存储类型。StartRecord 接口新增 AutoSetFileExtension 请求参数，上传到视频点播平台时, 可以选择是否需要根据文件后缀自动设置 FileExtension。2023-11-01
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。| 新增接口 | 接口描述 |
|---|---|
| StartDetection | 对用户通过 RTC 发送的视频、音频内容进行审核。 |
| StopDetection | 关闭审核任务。 |
| ListDetectionTask | 查询指定用户的审核状态。 |
InternalError.Parallel 变更为 InternalError.Redis。
2023-11-01
该版本下接口：
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。| 新增接口 | 接口描述 |
|---|---|
| BanRoomUser | 封禁房间&用户。可解散整个房间或移除指定用户。 |
| UpdateBanRoomUserRule | 更新房间&用户封禁规则。可对封禁时长进行更新。 |
| BanUserStream | 封禁房间内某个用户的音/视频流。 |
| UnbanUserStream | 解封房间内某个用户的音/视频流。 |
| GetRoomOnlineUsers | 获取指定房间的实时用户列表。 |
| LimitTokenPrivilege | 限制某个用户指定 Token 的发布权限。 |
InternalError.UnmarshalFail 变更为 InternalError.Unmarshal。InternalError.RPCError 变更为 InternalError.RPC。UnknownUser错误码废弃，不再返回错误，BaseResponse.Result 会提示 User is not found.BaseResponse.Result 会提示 User has been banned.BaseResponse.Result 会提示 Room has been banned.BaseResponse.Result 会提示 Room is not found.BaseResponse.Result 会提示 Room has been banned.BaseResponse.Result 会提示 Room is not banned.BaseResponse.Result 会提示 User is not banned.MissingParameter.NoRoomId 错误码。MissingParameter.NoUserId 错误码。MissingParameter.NoToken 错误码。MissingParameter.NoAppId 错误码。InvalidParameter.Forbidden 错误码。2023-11-01
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。TaskId 重复调用开始接口不会导致请求失败，BaseResponse.Result 会提示 The task has been started. Please do not call the startup task interface repeatedly。UpdatePushMixedStreamToCDN 或 UpdateRecord时，若查不到正在运行的任务，会返回InvalidParameter.ErrorActiveTaskNotFound 错误。| 新增接口 | 接口描述 |
|---|---|
| StartRecord | 录制房间内音视频通话，生成音视频文件。 |
| StopRecord | 停止云端录制任务。 |
| UpdateRecord | 更新云端录制任务部分参数。 |
| GetRecordTask | 查询指定录制任务的相关信息。 |
| StartPushMixedStreamToCDN | 将其中的多路音视频流合为一路，并将合并得到的音视频流通过 RTMP 协议推送到指定的推流地址。 |
| StartPushSingleStreamToCDN | 将一路流通过 RTMP 协议推送到指定的 CDN 推流地址。 |
| UpdatePushMixedStreamToCDN | 更新合流转推任务的部分参数。 |
| StopPushStreamToCDN | 结束合流转推任务。 |
| GetPushSingleStreamToCDNTask | 查询指定单流转推任务的相关信息。 |
| GetPushMixedStreamToCDNTask | 查询指定合流转推任务的相关信息。 |
| StartSegment | 对房间中的音频流进行切片，供后续处理。 |
| UpdateSegment | 更新音频切片任务的部分参数。 |
| StopSegment | 结束音频切片任务。 |
| GetSegmentTask | 查询指定音频切片任务的相关信息。 |
| StartSnapshot | 对房间内的实时音视频互动按一定时间间隔进行截图。 |
| UpdateSnapshot | 更新抽帧截图任务的部分参数。 |
| StopSnapshot | 关闭已启动的抽帧截图任务。 |
| GetSnapshotTask | 查询指定抽帧截图任务的相关信息。 |
| StartRelayStream | 将在线媒体流输入到 RTC 房间中，供频道内的远端用户欣赏。 |
| UpdateRelayStream | 更新在线媒体流任务的部分参数。 |
| StopRelayStream | 停止在线媒体流任务。 |
| ListRelayStream | 查询指定 AppId 下指定房间内所有输入的媒体流任务。 |
| StartWebCast | 将指定页面的音视频流转推到 RTC 房间供房间内用户观看。 |
| StopWebCast | 停止已启动的云录屏任务。 |
| GetWebCastTask | 查询指定云录屏任务的相关信息 |
2023-11-01
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。| 新增接口 | 接口描述 |
|---|---|
| StartPushPublicStream | 将指定音视频房间内的单路或多路音视频流，使用指定的布局方式，进行发布。 |
| UpdatePublicStreamParam | 更新公共流任务部分参数。 |
| StopPushPublicStream | 停止发布公共流。 |
2023-11-01
| 新增接口 | 接口描述 |
|---|---|
| ListRoomInfo | 查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。 |
| ListCallDetail | 查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。 |
| ListUserInfo | 查询一段时间内，某个应用下进行音视频通话的指定房间内特定或全部用户信息。 |
2023-11-01
| 新增接口 | 接口描述 |
|---|---|
| ListApps | 查询指定 AppId 对应应用的相关信息。 |
| CreateApp | 创建 AppId。 |
2023-11-01 版本下 OpenAPI 返回结构进行了优化，细节如下：
!=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。2020-12-01
流处理模式为转封装时，新增支持原视频编码方式为 ByteVC1。
2020-12-01
废弃 GetUserStreamState 接口，请使用音视频流状态变化相关回调来获取用户的实时推流状态。
2020-12-01
| 更新回调 | 描述 |
|---|---|
| 可见用户进入房间 | 新增 UserExtraInfo 参数，回调客户端 SDK 通过 joinRoom 传入的用户附加信息。 |
| 不可见用户进入房间 | 新增 UserExtraInfo 参数，回调客户端 SDK 通过 joinRoom 传入的用户附加信息。 |
2023-07-20
| 新增接口 | 接口描述 |
|---|---|
| SendUnicast | 向指定的一个应用客户端发送房间外点对点消息 |
| SendRoomUnicast | 向指定 RTC 房间内指定的一个应用客户端发送消息 |
| SendBroadcast | 向指定一个 RTC 房间内的所有用户广播消息 |
| BatchSendRoomUnicast | 向指定 RTC 房间内的批量用户发送点对点消息 |
2023-06-01
Layout.CustomLayout.region 宽高设置绝对值像素。PayLoadType若返回的一级错误码为 InvalidParamter, http 响应状态码为 400。
2020-12-01
支持开启合流 SEI 音量提示
自定义布局下，支持最多将 30 路流合为一路流进行转推。
Control.VolumeIndicationInterval 参数类型变为 Float32，取值范围由[1,∞] 变为[0.3,∞]。
2023-06-01
Layout.CustomLayout.region 宽高设置绝对值像素。InvalidParamter, http 响应状态码为 400。2020-12-01
StartPushPublicStream 接口新增 TranscodeMode 请求参数，支持设置公共流处理模式。UpdatePublicStreamParam 接口新增 TranscodeMode 请求参数，支持更新公共流处理模式。Control 字段新增 UserCaptureStatsMode 参数，支持开启房间用户采集状态回调。Control 字段新增 UserCaptureStatsInterval 参数，支持设置房间用户采集状态回调间隔。Control 字段新增 StreamPublishStatsMode 参数，支持开启房间用户发布状态回调。Control 字段新增 StreamPublishStatsInterval 参数，支持设置房间用户发布状态回调间隔。2023-08-01
| 新增接口 | 接口描述 |
|---|---|
| GetRoomOnlineUsers | 获取指定房间的实时用户列表 |
2020-12-01
TranscodeStateChanged 回调 TaskState 字段新增枚举值 4，表示当前推流地址已切换。
UpdatePushMixedStreamToCDN 接口新增 IsUpdatePartialParam 请求参数，支持合流转推参数部分更新。UpdatePushMixedStreamToCDN 接口新增 SequenceNumber 请求参数，支持为更新请求添加序列号，确保服务端按照最新配置更新合流转推接口。GetPushSingleStreamToCDNTask 接口新增 PushStreamState 返回参数，支持查询推流状态。GetPushMixedStreamToCDNTask 接口新增 PushStreamState 返回参数，支持查询推流状态。2020-12-01
新增 Layout.CustomLayout.Regions.Region.ApplySpatialAudio 参数，支持设置该路流对应用户是否开启空间音频效果。
2020-12-01
进房互踢行为优化，详情查看用户进退房回调说明
2020-12-01
回调新增 AudioSegmentInfo,音频审核时返回音频切片信息。
2020-12-01
| 新增回调 |
|---|
| 曲库下架歌曲列表 |
2020-12-01
合流转推与单流转推接口支持 Layout.CustomLayout.Regions.Region 字段传空。
| 更新回调 | 描述 |
|---|---|
| 转推直播任务开始 | 合流转推下新增 PushUrl 参数，回调当前推流 CDN 地址。 |
| 转推直播任务结束 | 合流转推下新增 PushUrl 参数，回调当前推流 CDN 地址。 |
| 转推直播任务更新 | 合流转推下新增 PushUrl 参数，回调当前推流 CDN 地址。 |
| 转推直播任务状态变化 | 合流转推下新增 PushUrl 参数，回调当前推流 CDN 地址。 |
新增 Layout.CustomLayout.Regions.Region.MediaType 参数，支持设置单个用户流的媒体类型。
新增 Layout.CustomLayout.Regions.Region.AlternateImageRenderMode参数，支持补位图独立设置渲染模式。
2020-12-01
新增 Layout.CustomLayout.Regions.Region.MediaType 参数，支持设置单个用户流的媒体类型。
新增 Layout.CustomLayout.Regions.Region.AlternateImageRenderMode 参数，支持补位图独立设置渲染模式。
录制切片规则发生变化，详情请参看录制切片规则
2022-06-01
新增 Layout.CustomLayout.Regions.Region.MediaType 参数，支持设置单个用户流的媒体类型。
新增 Layout.CustomLayout.Regions.Region.AlternateImageRenderMode 参数，支持补位图独立设置渲染模式。
录制切片规则发生变化，详情请参看录制切片规则
2020-12-01
页面转推功能更名为云录屏，原云录屏功能下线。
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| BanRoomUser | 封禁房间&用户。可解散整个房间或移除指定用户。 |
| UpdateBanRoomUserRule | 更新房间&用户封禁规则。可对封禁时长进行更新。 |
废弃 KickUser 接口，请使用 BanRoomUser 接口移除指定用户。
废弃 DismissRoom 接口，请使用 BanRoomUser 接口解散房间。
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| GetPushMixedStreamToCDNTask | 查询合流转推任务状态。可查询指定合流转推任务的相关信息。 |
| GetPushSingleStreamToCDNTask | 查询单流转推任务状态。可查询指定单流转推任务的相关信息。 |
2022-06-01
| 新增接口 | 接口描述 |
|---|---|
| GetSegmentTask | 查询合流转推任务状态。可查询指定音频切片任务的相关信息。 |
2022-06-01
| 新增接口 | 接口描述 |
|---|---|
| GetSnapshotTask | 查询抽帧截图任务状态。可查询指定抽帧截图任务的相关信息。 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| GetWebCastTask | 查询页面转推任务状态。可查询指定页面转推任务的相关信息。 |
2020-12-01
StartTranscode 变为 StartPushMixedStreamToCDN。UpdateTranscode 变为 UpdatePushMixedStreamToCDN。2020-12-01
新增支持房间维度审核。详情可参看StartDetection.UserId。
2020-12-01
StreamControl.FrameRate 取值范围由[1,60] 变为[1,30]。
2020-12-01
新增 VideoConfig.VideoCodec参数，支持 H.264 和 VP8编码协议。
2020-12-01
| 功能 | 功能描述 | 相关接口 |
|---|---|---|
| 歌曲查询 |
2022-06-01
云端录制支持音视频模式录制下生成纯音频文件，即 Control.MediaType = 0 , FileFormatConfig= MP3、AAC 或 M4A时，可以生成纯音频文件。
2020-12-01
废弃 ListRooms 接口，请使用 ListRoomInfo 接口查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。
废弃 ListUsers 接口，请使用 ListUserInfo 接口查询一段时间内，某个应用下进行音视频通话的指定房间内特定或全部用户信息。
2020-12-01
新增支持设置布局的边框圆角半径。详情可参看Region。
2022-06-01
ConfigStorageConfig2022-06-01
新增 S3 存储平台。
新增支持存储平台包括：
CustomConfig2022-06-01
新增 S3 存储平台。
新增支持存储平台包括：
CustomConfig2020-12-01
支持在房间内无用户推流的场景下发起转推直播任务。详细参数可参看Control。
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListCallDetail(2022-06-01) | 获取通话质量指标。可查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。 |
获取离线质量数据支持查询 web 端指标数据。详细参数可参看ListQuality
2020-12-01
获取离线分布质量数据支持查询 web 端指标数据。详细参数可参看ListQualityDistribution
2020-12-01
废弃StopTranscode接口，请使用 StopPushStreamToCDN 接口结束转推任务。
2020-12-01&2022-06-01
| 新增接口 | 接口描述 |
|---|---|
| UpdateSnapshot(2022-06-01) | 更新抽帧参数。可更新使用 OpenAPI 设置的截图间隔。 |
| UpdateSnapshot(2020-12-01) | 更新抽帧参数。可更新使用 OpenAPI 设置的截图间隔。 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListQualityDistribution | 获取不同维度（一级行政区/国家/设备平台/网络类型）的离线质量指标数据。 |
| ListRealTimeQualityDistribution | 获取不同维度（一级行政区/国家/设备平台/网络类型）的实时质量指标数据。 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListOperationDistribution | 获取地域维度（一级行政区/国家）的离线运营指标数据（目前仅支持查询通话人数）。 |
2020-12-01
页面转推支持页面监控功能。详细参数可参看Monitor
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListRoomInfo | 获取通话房间列表。可查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。 |
| ListUserInfo | 取用户通话详情。可查询一段时间内，某个应用下进行音视频通话的指定房间内特定或全部用户信息。 |
废弃ListRoomInformation接口，请使用 ListRoomInfo 接口进行查询。
废弃 ListUserInformation接口，请使用 ListUserInfo 接口进行查询。
2020-12-01
公共流支持发送房间内用户音量指示。详细参数可参看 Control
2022-06-01
截图生成文件新增支持 S3 存储。
目前支持的存储平台包括：
| 新增接口 | 接口描述 |
|---|---|
| StartSnapshot | 开启抽帧截图。 |
| StopSnapshot | 关闭抽帧截图。 |
2022-06-01
切片生成文件新增支持 S3 存储。
目前支持的存储平台包括：
| 新增接口 | 接口描述 |
|---|---|
| StartSegment | 开启音频切片。 |
| UpdateSegment | 更新音频切片。 |
| StopSegment | 关闭音频切片。 |
2020-12-01
| 功能 | 功能描述 | 相关接口 |
|---|---|---|
| 单流转推 | 支持将一路流通过 RTMP 协议推送到指定的 CDN 推流地址。 |
2020-12-01
转推直播支持空间音频功能。
2020-12-01
音频切片支持屏幕共享流。
2020-12-01
| 功能 | 功能描述 | 相关接口 |
|---|---|---|
| 业务标识管理 | 支持对业务标识进行添加、修改、查询与删除。 |
2020-12-01
| 新增回调 |
|---|
| 公共流推送异常或推送结束 |
2020-12-01
| 新增回调 |
|---|
| 转推直播任务开始 |
| 转推直播任务结束 |
| 转推直播任务更新 |
| 转推直播任务状态变化 |
2020-12-01
| 新增回调 |
|---|
| 音频流开始推送 |
| 音频流结束推送 |
| 视频流开始推送 |
| 视频流结束推送 |
| 屏幕音频流开始推送 |
| 屏幕音频流结束推送 |
| 屏幕视频流开始推送 |
| 屏幕视频流结束推送 |
| 更新回调 | 描述 |
|---|---|
| 可见用户退出房间 | Reason 中新增 Token 过期被移出房间 |
| 不可见用户退出房间 | Reason 中新增 Token 过期被移出房间 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| UpdateSegment | 更新已启用的切片任务的相关参数。 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListRealTimeOperationData | 获取实时运营数据。可查询一段时间内，某个应用的音视频通话实时运营数据。 |
| ListOperationData | 获取离线运营数据。可查询一段时间内，某个应用的音视频通话的离线运营数据。 |
废弃ListConcurrentData接口，请使用 ListOperationData 接口进行查询。
废弃 ListIndicators接口，请使用 ListQuality 接口进行查询。
2022-06-01
新增录制文件格式设置，支持 MP4、HLS、FLV、MP3、 AAC、M4A 格式存储。
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListQuality | 获取离线质量数据。可查询一段时间内，某个应用的音视频通话离线质量指标数据 |
| ListRealTimeQuality | 获取实时质量数据。可查询一段时间内，某个应用的音视频通话实时质量指标数据 |
废弃 ListIndicators接口，请使用 ListQuality 接口进行查询。
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListRelayStream | 查询输入媒体流任务。可查询指定 AppID 下指定房间内所有输入的媒体流任务。 |
2020-12-01
| 功能 | 功能描述 | 相关接口 |
|---|---|---|
| 页面转推 | 支持将指定网页中的内容转推到 RTC 房间内。 |
2020-12-01
| 新增接口 | 接口描述 |
|---|---|
| ListCallDetail | 获取通话质量指标。可查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。 |
2022-06-01
录制生成文件新增支持 S3 存储。
目前支持的存储平台包括：
| 新增接口 | 接口描述 |
|---|---|
| StartRecord | 开始云端录制。可使用云端录制功能，录制音视频文件。 |
| UpdateRecord | 更新云端录制。可更新录制的配置参数 |
| StopRecord | 结束云端录制。可关闭指定的云端录制任务 |
| GetRecordTask | 查询录制任务状态。可查询指定录制任务的相关信息。 |
2020-12-01
新增 Layout.MainVideoStream 参数
废弃 Layout.MainVideoStreamIndex 参数。
当前版本
MainVideoStreamIndex依然可用，但我们强烈建议你使用MainVideoStream参数。
如果你同时指定了MainVideoStream和MainVideoStreamIndex的值，此时只有MainVideoStream生效。
垂直布局支持屏幕流。
2020-12-01
新增 Layout.MainVideoStream参数
废弃 Layout.MainVideoStreamIndex 参数。
当前版本
MainVideoStreamIndex依然可用，但我们强烈建议你使用MainVideoStream参数。
如果你同时指定了MainVideoStream和MainVideoStreamIndex的值，此时只有MainVideoStream生效。
垂直布局支持屏幕流。