logo
超低延迟直播
服务端 API
场景服务接口
当前页

API 概览

2023-09-04

ZEGO 云通讯产品服务端 API 升级到 v2 版本,全新的 API 接口文档更加规范和全面。

服务端 API v2 版本支持全球就近接入、统一的鉴权方式、统一的参数风格和公共错误码,给开发者带来简单快捷的使用体验。

注意
  1. 本文档 API 接口均为最新服务端 API v2 接口,后续相关功能的新增都会在此更新。为了给开发者带来更好的体验,ZEGO 推荐开发者使用最新 API v2 接口。

  2. 旧版 API 接口已停止维护,不添加新功能。旧版接口文档请参考 服务端 API

房间信令接口

接口名称接口功能
SendBroadcastMessage推送广播消息
SendBarrageMessage推送弹幕消息
SendCustomCommand推送自定义消息
DescribeUserNum获取房间人数
DescribeUsers查询用户状态
DescribeUserList获取房间用户列表
AddStream增加房间流
DeleteStream删除房间流
DescribeSimpleStreamList获取简易流列表
CloseRoom关闭房间
KickoutUser踢出房间用户
SetForbidUserRule设置用户封禁规则
DescribeForbidUserRules查询用户封禁规则
DelForbidUserRule删除用户封禁规则
SetForbidStreamRule设置房间音视频流封禁规则
DescribeForbidStreamRules查询房间音视频流封禁规则
DelForbidStreamRule删除房间音视频流封禁规则

混流转码接口

接口名称接口功能
StartMix开始混流
StopMix停止混流
GetMixTaskInfo查询混流任务信息
StartAutoMix开始自动混流
StopAutoMix停止自动混流
StartCloudTranscode开始单流转码
StopCloudTranscode停止单流转码

媒体服务接口

接口名称接口功能
ForbidCDNLiveStream禁止 CDN 推流
QueryForbidCDNLiveStream查询已被禁止推流到 CDN 的 URL 列表
ResumeCDNLiveStream恢复 CDN 推流
ForbidRTCStream禁止 RTC 推流
ResumeRTCStream恢复 RTC 推流
ForbidRTCStreams批量禁止 RTC 推流
ResumeRTCStreams批量恢复 RTC 推流
CreatCDNTransferRule启动旁路推流
DeleteCDNTransferRule停止旁路推流
ClearCDNTransferRule清空旁路推流
RTMPDispatchV2RTMP 推拉流调度

媒体文件接口

接口名称接口功能
StartCDNRecord开始 CDN 录制
StopCDNRecord停止 CDN 录制
SearchMedia检索媒体信息
DeleteMedia删除媒体文件
MergeMedia合并媒体文件
DescribeMediaTask查询媒体文件任务
TranscodeMedia开始点播转码

音视频流审核接口

接口名称接口功能
StartCensorAudioV2开始音频流审核
StopCensorAudioV2结束音频流审核
StartCensorVideoV2开始视频流审核
StopCensorVideoV2结束视频流审核
GenerateIdentifyToken音视频流审核鉴权 Token

场景服务接口

接口名称接口功能
SetSceneTemplate场景模板配置

回调说明

回调名称回调说明
room_create房间创建回调
room_close房间关闭回调
room_login登录房间回调
room_logout退出房间回调
stream_create流创建回调
stream_close流关闭回调
mix_start混流开始回调
mix_stop混流结束回调
transcode_start单流转码开始回调
transcode_stop单流转码停止回调
record录制文件生成回调
compose媒体文件合并完成回调
procedure点播转码完成回调
censor_audio_v2_result音频流审核结果回调
censor_audio_v2_status音频流审核任务状态回调
censor_video_v2_audio_result视频流音频审核结果回调
censor_video_v2_img_result视频流画面审核结果回调
censor_video_v2_audio_status视频流音频审核状态回调
censor_video_v2_img_status视频流画面审核状态回调

Next

快速开始