服务端 API v2

API概览

更新时间:2021-06-16 15:43

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

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

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

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

ZEGO 云通信产品服务端提供以下相关 API 接口。

房间信令接口

接口名称 接口功能
SendBroadcastMessage 推送广播消息
SendBarrageMessage 推送弹幕消息
SendCustomCommand 推送自定义消息
KickoutUser 踢出房间用户
AddStream 增加房间流
DeleteStream 删除房间流

混流接口

接口名称 接口功能
StartMix 开始混流
StopMix 停止混流

媒体服务接口

接口名称 接口功能
ForbidCDNLiveStream 禁止 CDN 推流
ResumeCDNLiveStream 恢复 CDN 推流
ForbidRTCStream 禁止 RTC 推流
ResumeRTCStream 恢复 RTC 推流
DescribeRTCStreamState RTC 流状态查询
CreatCDNTransferRule 启动旁路推流
DeleteCDNTransferRule 停止旁路推流
ClearCDNTransferRule 清空旁路推流

媒体文件接口

接口名称 接口功能
StartCDNRecrod 开始 CDN 录制
StopCDNRecord 停止 CDN 录制
SearchMedia 检索媒体信息
DeleteMedia 删除媒体文件
MergeMedia 合并媒体文件

互动白板接口

接口名称 接口功能
SetWhiteboardRoomAuth 设置房间权限
SetWhiteboardUserAuth 设置用户权限
GetWhiteboardRoomAuth 获取房间权限
GetWhiteboardUserAuth 获取用户权限