API 接口列表
注意
本文档将帮助您快速了解音视频(RTC)服务端提供的 API 接口。 所有接口均提供了对应的 API 调试地址(需登录开发者账号)。
用户管理服务
融云 RTC 服务端与 IM 服务端共用注册用户接口,用于获取 Token。
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
注册用户 | POST | /user/getToken.json | 转至 IM 服务端的 API 调试 |
房间人员管理服务
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
查询房间人员 | POST | /rtc/room/query.json | API 调试 |
踢出房间 | POST | /rtc/user/kick.json | API 调试 |
封禁用户 | POST | /rtc/user/block.json | API 调试 |
解封用户 | POST | /rtc/user/unblock.json | API 调试 |
指定房间封禁用户 | POST | /v2/rtc/rooms/{room_id}/block-users | API 调试 |
指定房间解封用户 | DELETE | /v2/rtc/rooms/{room_id}/block-users | API 调试 |
销毁房间服务
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
主动销毁音视频房间 | POST | /v2/rtc/rooms/{room_id} | API 调试 |
低延迟直播服务
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
直播合流 | POST | /rtc/mcu/config.json | API 调试 |
获取融云 CDN 拉流地址 | POST | /v2/rtc/innercdn/pull_url | API 调试 |
转推第三方 CDN | POST | /rtc/mcu/config.json | API 调试 |
占位水印 | POST | /v2/rtc/mcu/placehold | API 调试 |
云端录制服务
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
开始录制 | POST | /rtc/record/start.json | API 调试 |
更改布局 | POST | /rtc/record/config.json | API 调试 |
结束录制 | POST | /rtc/record/stop.json | API 调试 |
云 播放器服务
功能/文档页面 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|
开始播放 | POST | /v2/rtc/cloudplayer/start | API 调试 |
结束播放 | POST | /v2/rtc/cloudplayer/stop | API 调试 |
开始播放(旧版) | POST | /v2/rtc/cloudplayer/rtmp/start | 暂不支持「北极星」API 调试 |
结束播放(旧版) | POST | /v2/rtc/cloudplayer/rtmp/stop | 暂不支持「北极星」API 调试 |
内容审核服务
功能/文档页面 | 具体接口名/文档 | 方法 | API URL | 北极星 API 调试地址 |
---|---|---|---|---|
任务管理 | 开始审核 | POST | /rtc/contentcensor/start.json | API 调试 |
任务管理 | 结束审核 | POST | /rtc/contentcensor/stop.json | API 调试 |