2024-01-06
音视频内容安全
新增版本

2023-11-01

版本特性
接口变更
新增接口接口描述
StartDetection对用户通过 RTC 发送的视频、音频内容进行审核。
StopDetection关闭审核任务。
ListDetectionTask查询指定用户的审核状态。
错误码变更

InternalError.Parallel 变更为 InternalError.Redis。

2024-01-05
房间管理
新增版本

2023-11-01

版本特性

该版本下接口:

接口变更
新增接口接口描述
BanRoomUser封禁房间&用户。可解散整个房间或移除指定用户。
UpdateBanRoomUserRule更新房间&用户封禁规则。可对封禁时长进行更新。
BanUserStream封禁房间内某个用户的音/视频流。
UnbanUserStream解封房间内某个用户的音/视频流。
GetRoomOnlineUsers获取指定房间的实时用户列表。
LimitTokenPrivilege限制某个用户指定 Token 的发布权限。
错误码变更
云端媒体处理
新增版本

2023-11-01

版本特性
接口变更
新增接口接口描述
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

版本特性
接口变更
新增接口接口描述
StartPushPublicStream将指定音视频房间内的单路或多路音视频流,使用指定的布局方式,进行发布。
UpdatePublicStreamParam更新公共流任务部分参数。
StopPushPublicStream停止发布公共流。
2023-12-27
获取数据指标
新增版本

2023-11-01

接口变更
新增接口
新增接口接口描述
ListRoomInfo查询一段时间内,某个应用下进行音视频通话的房间列表及房间相关信息。
ListCallDetail查询一段时间内,某个应用下进行音视频通话的指定房间内某个用户的上下行数据。
ListUserInfo查询一段时间内,某个应用下进行音视频通话的指定房间内特定或全部用户信息。
应用管理
新增版本

2023-11-01

接口变更
新增接口
新增接口接口描述
ListApps查询指定 AppId 对应应用的相关信息。
CreateApp创建 AppId。

2023-11-01 版本下 OpenAPI 返回结构进行了优化,细节如下:

2023-11-13
输入在线媒体流
更新版本

2020-12-01

接口变更
改进优化

流处理模式为转封装时,新增支持原视频编码方式为 ByteVC1。

2023-11-08
获取数据指标
更新版本

2020-12-01

接口变更
废弃接口

废弃 GetUserStreamState 接口,请使用音视频流状态变化相关回调来获取用户的实时推流状态。

2023-11-07
房间管理
更新版本

2020-12-01

接口变更
更新回调
更新回调描述
可见用户进入房间新增 UserExtraInfo 参数,回调客户端 SDK 通过 joinRoom 传入的用户附加信息。
不可见用户进入房间新增 UserExtraInfo 参数,回调客户端 SDK 通过 joinRoom 传入的用户附加信息。
2023-11-01
实时消息通信
新增版本

2023-07-20

接口变更
新增接口
新增接口接口描述
SendUnicast向指定的一个应用客户端发送房间外点对点消息
SendRoomUnicast向指定 RTC 房间内指定的一个应用客户端发送消息
SendBroadcast向指定一个 RTC 房间内的所有用户广播消息
BatchSendRoomUnicast向指定 RTC 房间内的批量用户发送点对点消息
2023-10-23
转推直播
新增版本

2023-06-01

新增功能
功能优化

若返回的一级错误码为 InvalidParamter, http 响应状态码为 400。

更新版本

2020-12-01

新增功能

支持开启合流 SEI 音量提示

功能优化

自定义布局下,支持最多将 30 路流合为一路流进行转推。

参数优化

Control.VolumeIndicationInterval 参数类型变为 Float32,取值范围由[1,∞] 变为[0.3,∞]。

云端录制
新增版本

2023-06-01

新增功能
功能优化
2023-10-18
公共流
更新版本

2020-12-01

接口变更
参数新增
2023-09-20
房间管理
更新版本

2023-08-01

接口变更
新增接口
新增接口接口描述
GetRoomOnlineUsers获取指定房间的实时用户列表
2023-07-27
转推直播
更新版本

2020-12-01

接口变更
更新回调

TranscodeStateChanged 回调 TaskState 字段新增枚举值 4,表示当前推流地址已切换。

参数新增
2023-07-11
转推直播
更新版本

2020-12-01

接口变更
参数新增

新增 Layout.CustomLayout.Regions.Region.ApplySpatialAudio 参数,支持设置该路流对应用户是否开启空间音频效果。

2023-06-15
房间管理
更新版本

2020-12-01

回调变更
改进优化

进房互踢行为优化,详情查看用户进退房回调说明

2023-06-08
音视频内容安全
更新版本

2020-12-01

接口变更
更新回调

回调新增 AudioSegmentInfo,音频审核时返回音频切片信息。

2023-06-07
歌曲查询
更新版本

2020-12-01

接口变更
新增回调
新增回调
曲库下架歌曲列表
2023-06-02
转推直播
更新版本

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 参数,支持补位图独立设置渲染模式。

改进优化

录制切片规则发生变化,详情请参看录制切片规则

2023-05-09
页面转推
更新版本

2020-12-01

功能下线

页面转推功能更名为云录屏,原云录屏功能下线。

2023-04-11
房间管理
更新版本

2020-12-01

接口变更
新增接口
新增接口接口描述
BanRoomUser封禁房间&用户。可解散整个房间或移除指定用户。
UpdateBanRoomUserRule更新房间&用户封禁规则。可对封禁时长进行更新。
废弃接口

废弃 KickUser 接口,请使用 BanRoomUser 接口移除指定用户。
废弃 DismissRoom 接口,请使用 BanRoomUser 接口解散房间。

2023-03-29
合流转推
更新版本

2020-12-01

接口变更
新增接口
新增接口接口描述
GetPushMixedStreamToCDNTask查询合流转推任务状态。可查询指定合流转推任务的相关信息。
GetPushSingleStreamToCDNTask查询单流转推任务状态。可查询指定单流转推任务的相关信息。
音频切片
更新版本

2022-06-01

接口变更
新增接口
新增接口接口描述
GetSegmentTask查询合流转推任务状态。可查询指定音频切片任务的相关信息。
抽帧截图
更新版本

2022-06-01

接口变更
新增接口
新增接口接口描述
GetSnapshotTask查询抽帧截图任务状态。可查询指定抽帧截图任务的相关信息。
页面转推
更新版本

2020-12-01

接口变更
新增接口
新增接口接口描述
GetWebCastTask查询页面转推任务状态。可查询指定页面转推任务的相关信息。
2023-03-22
转推直播
更新版本

2020-12-01

接口变更
2023-03-16
音视频内容安全
更新版本

2020-12-01

新增功能

新增支持房间维度审核。详情可参看StartDetection.UserId。

2023-03-13
输入在线媒体流
更新版本

2020-12-01

接口变更
参数优化

StreamControl.FrameRate 取值范围由[1,60] 变为[1,30]。

2023-03-02
公共流
更新版本

2020-12-01

接口变更
参数新增

新增 VideoConfig.VideoCodec参数,支持 H.264 和 VP8编码协议。

2023-03-01
歌曲查询
更新版本

2020-12-01

新增功能
功能功能描述相关接口
歌曲查询
  • 支持根据关键字搜索歌曲。
  • 支持根据筛选条件查询歌曲列表
  • 搜索音乐列表 SearchMusics
  • 查询歌曲列表 ListMusics
  • 2023-02-24
    云端录制
    更新版本

    2022-06-01

    新增功能

    云端录制支持音视频模式录制下生成纯音频文件,即 Control.MediaType = 0 , FileFormatConfig= MP3、AAC 或 M4A时,可以生成纯音频文件。

    2023-02-16
    房间管理
    更新版本

    2020-12-01

    接口变更
    废弃接口

    废弃 ListRooms 接口,请使用 ListRoomInfo 接口查询一段时间内,某个应用下进行音视频通话的房间列表及房间相关信息。
    废弃 ListUsers 接口,请使用 ListUserInfo 接口查询一段时间内,某个应用下进行音视频通话的指定房间内特定或全部用户信息。

    2023-02-13
    转推直播
    更新版本

    2020-12-01

    新增功能

    新增支持设置布局的边框圆角半径。详情可参看Region。

    2023-02-07
    抽帧截图
    更新版本

    2022-06-01

    新增功能
    云端录制
    更新版本

    2022-06-01

    新增功能

    新增 S3 存储平台。

    新增支持存储平台包括:

    音频切片
    新增版本

    2022-06-01

    新增功能

    新增 S3 存储平台。

    新增支持存储平台包括:

    2023-02-03
    转推直播
    更新版本

    2020-12-01

    新增功能

    支持在房间内无用户推流的场景下发起转推直播任务。详细参数可参看Control。

    2023-01-18
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListCallDetail(2022-06-01)获取通话质量指标。可查询一段时间内,某个应用下进行音视频通话的指定房间内某个用户的上下行数据。
    新增功能

    获取离线质量数据支持查询 web 端指标数据。详细参数可参看ListQuality

    2023-01-17
    获取数据指标
    更新版本

    2020-12-01

    新增功能

    获取离线分布质量数据支持查询 web 端指标数据。详细参数可参看ListQualityDistribution

    2023-01-13
    转推直播
    更新版本

    2020-12-01

    接口变更
    废弃接口

    废弃StopTranscode接口,请使用 StopPushStreamToCDN 接口结束转推任务。

    2023-01-12
    抽帧截图
    更新版本

    2020-12-01&2022-06-01

    接口变更
    新增接口
    新增接口接口描述
    UpdateSnapshot(2022-06-01)更新抽帧参数。可更新使用 OpenAPI 设置的截图间隔。
    UpdateSnapshot(2020-12-01)更新抽帧参数。可更新使用 OpenAPI 设置的截图间隔。
    2022-12-16
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListQualityDistribution获取不同维度(一级行政区/国家/设备平台/网络类型)的离线质量指标数据。
    ListRealTimeQualityDistribution获取不同维度(一级行政区/国家/设备平台/网络类型)的实时质量指标数据。
    2022-12-15
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListOperationDistribution获取地域维度(一级行政区/国家)的离线运营指标数据(目前仅支持查询通话人数)。
    2022-11-17
    页面转推
    更新版本

    2020-12-01

    新增功能

    页面转推支持页面监控功能。详细参数可参看Monitor

    2022-11-16
    房间管理
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListRoomInfo获取通话房间列表。可查询一段时间内,某个应用下进行音视频通话的房间列表及房间相关信息。
    ListUserInfo取用户通话详情。可查询一段时间内,某个应用下进行音视频通话的指定房间内特定或全部用户信息。
    废弃接口

    废弃ListRoomInformation接口,请使用 ListRoomInfo 接口进行查询。
    废弃 ListUserInformation接口,请使用 ListUserInfo 接口进行查询。

    2022-11-10
    公共流
    更新版本

    2020-12-01

    新增功能

    公共流支持发送房间内用户音量指示。详细参数可参看 Control

    2022-11-08
    抽帧截图
    新增版本

    2022-06-01

    新增功能

    截图生成文件新增支持 S3 存储。

    目前支持的存储平台包括:

    接口变更
    新增接口
    新增接口接口描述
    StartSnapshot开启抽帧截图。
    StopSnapshot关闭抽帧截图。
    音频切片
    新增版本

    2022-06-01

    新增功能

    切片生成文件新增支持 S3 存储。

    目前支持的存储平台包括:

    接口变更
    新增接口
    新增接口接口描述
    StartSegment开启音频切片。
    UpdateSegment更新音频切片。
    StopSegment关闭音频切片。
    2022-11-02
    单流转推
    更新版本

    2020-12-01

    新增功能
    功能功能描述相关接口
    单流转推支持将一路流通过 RTMP 协议推送到指定的 CDN 推流地址。
  • 开始单流转推 StartPushSingleStreamToCDN
  • 结束单流转推 StopPushSingleStreamToCDN
  • 2022-10-21
    转推直播
    更新版本

    2020-12-01

    新增功能

    转推直播支持空间音频功能。

    2022-10-17
    音频切片
    更新版本

    2020-12-01

    新增功能

    音频切片支持屏幕共享流。

    2022-09-20
    业务标识管理
    更新版本

    2020-12-01

    新增功能
    功能功能描述相关接口
    业务标识管理支持对业务标识进行添加、修改、查询与删除。
  • 添加业务标识 AddBusinessID
  • 修改业务标识名称 ModifyBusinessRemarks
  • 获取业务标识 GetAllBusinessID
  • 删除业务标识 DeleteBusinessID
  • 2022-08-25
    公共流
    更新版本

    2020-12-01

    接口变更
    新增回调
    新增回调
    公共流推送异常或推送结束
    2022-08-24
    转推直播
    更新版本

    2020-12-01

    接口变更
    新增回调
    新增回调
    转推直播任务开始
    转推直播任务结束
    转推直播任务更新
    转推直播任务状态变化
    2022-08-10
    房间管理
    更新版本

    2020-12-01

    接口变更
    新增回调
    新增回调
    音频流开始推送
    音频流结束推送
    视频流开始推送
    视频流结束推送
    屏幕音频流开始推送
    屏幕音频流结束推送
    屏幕视频流开始推送
    屏幕视频流结束推送
    更新回调
    更新回调描述
    可见用户退出房间Reason 中新增 Token 过期被移出房间
    不可见用户退出房间Reason 中新增 Token 过期被移出房间
    2022-08-04
    音频切片
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    UpdateSegment更新已启用的切片任务的相关参数。
    2022-08-02
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListRealTimeOperationData获取实时运营数据。可查询一段时间内,某个应用的音视频通话实时运营数据。
    ListOperationData获取离线运营数据。可查询一段时间内,某个应用的音视频通话的离线运营数据。
    废弃接口

    废弃ListConcurrentData接口,请使用 ListOperationData 接口进行查询。
    废弃 ListIndicators接口,请使用 ListQuality 接口进行查询。

    2022-07-19
    云端录制
    更新版本

    2022-06-01

    新增功能

    新增录制文件格式设置,支持 MP4、HLS、FLV、MP3、 AAC、M4A 格式存储。

    2022-07-07
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListQuality获取离线质量数据。可查询一段时间内,某个应用的音视频通话离线质量指标数据
    ListRealTimeQuality获取实时质量数据。可查询一段时间内,某个应用的音视频通话实时质量指标数据
    废弃接口

    废弃 ListIndicators接口,请使用 ListQuality 接口进行查询。

    2022-06-30
    输入在线媒体流
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListRelayStream查询输入媒体流任务。可查询指定 AppID 下指定房间内所有输入的媒体流任务。
    2022-06-23
    页面转推
    更新版本

    2020-12-01

    新增功能
    功能功能描述相关接口
    页面转推支持将指定网页中的内容转推到 RTC 房间内。
  • 开启页面转推 StartWebCast
  • 结束页面转推 StopWebCast
  • 2022-06-13
    获取数据指标
    更新版本

    2020-12-01

    接口变更
    新增接口
    新增接口接口描述
    ListCallDetail获取通话质量指标。可查询一段时间内,某个应用下进行音视频通话的指定房间内某个用户的上下行数据。
    2022-06-01
    云端录制
    新增版本

    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生效。

    功能优化

    垂直布局支持屏幕流。