API 概览
2023-09-04
ZEGO 云通讯产品服务端 API 升级到 v2 版本，全新的 API 接口文档更加规范和全面。
服务端 API v2 版本支持全球就近接入、统一的鉴权方式、统一的参数风格和公共错误码，给开发者带来简单快捷的使用体验。
-
开发者可参考 快速开始 文档快速完成一次接口调用。
-
如需进行开发调试，也可参考 使用 Postman 调试。
注意
-
本文档 API 接口均为最新服务端 API v2 接口，后续相关功能的新增都会在此更新。为了给开发者带来更好的体验，ZEGO 推荐开发者使用最新 API v2 接口。
-
旧版 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 | 清空旁路推流 |
| RTMPDispatchV2 | RTMP 推拉流调度 |
媒体文件接口
| 接口名称 | 接口功能 |
|---|---|
| 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 | 视频流画面审核状态回调 |