跳到主要内容

API 接口列表

注意

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

用户管理服务

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

功能/文档页面方法API URL北极星 API 调试地址
注册用户POST/user/getToken.json转至 IM 服务端的 API 调试

房间人员管理服务

功能/文档页面方法API URL北极星 API 调试地址
查询房间人员POST/rtc/room/query.jsonAPI 调试
踢出房间POST/rtc/user/kick.jsonAPI 调试
封禁用户POST/rtc/user/block.jsonAPI 调试
解封用户POST/rtc/user/unblock.jsonAPI 调试
指定房间封禁用户POST/v2/rtc/rooms/{room_id}/block-usersAPI 调试
指定房间解封用户DELETE/v2/rtc/rooms/{room_id}/block-usersAPI 调试

销毁房间服务

功能/文档页面方法API URL北极星 API 调试地址
主动销毁音视频房间POST/v2/rtc/rooms/{room_id}API 调试

低延迟直播服务

功能/文档页面方法API URL北极星 API 调试地址
直播合流POST/rtc/mcu/config.jsonAPI 调试
获取融云 CDN 拉流地址POST/v2/rtc/innercdn/pull_urlAPI 调试
转推第三方 CDNPOST/rtc/mcu/config.jsonAPI 调试
占位水印POST/v2/rtc/mcu/placeholdAPI 调试

云端录制服务

功能/文档页面方法API URL北极星 API 调试地址
开始录制POST/rtc/record/start.jsonAPI 调试
更改布局POST/rtc/record/config.jsonAPI 调试
结束录制POST/rtc/record/stop.jsonAPI 调试

云播放器服务

功能/文档页面方法API URL北极星 API 调试地址
开始播放POST/v2/rtc/cloudplayer/startAPI 调试
结束播放POST/v2/rtc/cloudplayer/stopAPI 调试
开始播放(旧版)POST/v2/rtc/cloudplayer/rtmp/start暂不支持「北极星」API 调试
结束播放(旧版)POST/v2/rtc/cloudplayer/rtmp/stop暂不支持「北极星」API 调试

内容审核服务

功能/文档页面具体接口名/文档方法API URL北极星 API 调试地址
任务管理开始审核POST/rtc/contentcensor/start.jsonAPI 调试
任务管理结束审核POST/rtc/contentcensor/stop.jsonAPI 调试