跳到主要内容

API 接口列表

提示

本文档将帮助您快速了解音视频(RTC)服务端提供的 API 接口。所有接口均提供了对应的 API 调试地址(需登录开发者账号)。

用户管理服务

融云 RTC 服务端与 IM 服务端共用注册用户接口,用于获取 Token。

功能/文档页面API URL频率限制北极星 API 调试地址
注册用户/user/getToken.json100 次/秒,不可调频转至 IM 服务端的 API 调试

房间人员管理服务

功能/文档页面API URL频率限制北极星 API 调试地址
查询房间人员/rtc/room/query.json100 次/秒,不可调频API 调试
踢出房间/rtc/user/kick.json100 次/秒,不可调频API 调试
封禁用户/rtc/user/block.json100 次/秒,不可调频API 调试
解封用户/rtc/user/unblock.json100 次/秒,不可调频API 调试
指定房间封禁用户/v2/rtc/rooms/{room_id}/block-users100 次/秒,不可调频API 调试
指定房间解封用户/v2/rtc/rooms/{room_id}/block-users100 次/秒,不可调频API 调试

销毁房间服务

功能/文档页面API URL频率限制北极星 API 调试地址
主动销毁音视频房间/v2/rtc/rooms/{room_id}100 次/秒,不可调频API 调试

低延迟直播服务

功能/文档页面API URL频率限制北极星 API 调试地址
直播合流/rtc/mcu/config.json100 次/秒,不可调频API 调试
转推第三方 CDN/rtc/mcu/config.json100 次/秒,不可调频API 调试
占位水印/v2/rtc/mcu/placehold100 次/秒,不可调频API 调试

云端录制服务

功能/文档页面API URL频率限制北极星 API 调试地址
开始录制/rtc/record/start.json100 次/秒,不可调频API 调试
更改布局/rtc/record/config.json100 次/秒,不可调频API 调试
结束录制/rtc/record/stop.json100 次/秒,不可调频API 调试

云播放器服务

功能/文档页面API URL频率限制北极星 API 调试地址
开始播放/v2/rtc/cloudplayer/start100 次/秒,不可调频API 调试
结束播放/v2/rtc/cloudplayer/stop100 次/秒,不可调频API 调试

内容审核服务

功能/文档页面具体接口名/文档API URL频率限制北极星 API 调试地址
任务管理开始审核/rtc/contentcensor/start.json100 次/秒,不可调频API 调试
任务管理结束审核/rtc/contentcensor/stop.json100 次/秒,不可调频API 调试