API Reference

tip

This document helps you quickly understand the server APIs provided by RTC services. All APIs come with corresponding debugging links (developer account login required).

User Management Service

RC RTC shares user registration APIs with IM services for obtaining Tokens.

Feature/Document	Method	API URL	Polaris API Debugging Link
Register User	POST	/user/getToken.json	Redirect to IM service API Debug

Room Member Management

Feature/Document	Method	API URL	Polaris API Debugging Link
Query Room Members	POST	/rtc/room/query.json	API Debug
Kick User	POST	/rtc/user/kick.json	API Debug
Ban User	POST	/rtc/user/block.json	API Debug
Unban User	POST	/rtc/user/unblock.json	API Debug
Ban User in Specified Room	POST	/v2/rtc/rooms/{room_id}/block-users	API Debug
Unban User in Specified Room	DELETE	/v2/rtc/rooms/{room_id}/block-users	API Debug

Room Termination Service

Feature/Document	Method	API URL	Polaris API Debugging Link
Terminate RTC Room	DELETE	/v2/rtc/rooms/{room_id}	API Debug

Low-Latency Live Streaming

Feature/Document	Method	API URL	Polaris API Debugging Link
Live Stream Mixing	POST	/rtc/mcu/config.json	API Debug
Push to Third-Party CDN	POST	/rtc/mcu/config.json	API Debug
Placeholder Watermark	POST	/v2/rtc/mcu/placehold	API Debug

Cloud Recording

Feature/Document	Method	API URL	Polaris API Debugging Link
Start Recording	POST	/rtc/record/start.json	API Debug
Change Layout	POST	/rtc/record/config.json	API Debug
Stop Recording	POST	/rtc/record/stop.json	API Debug

Cloud Player

Feature/Document	Method	API URL	Polaris API Debugging Link
Start Playback	POST	/v2/rtc/cloudplayer/start	API Debug
Stop Playback	POST	/v2/rtc/cloudplayer/stop	API Debug

Content Moderation

Feature/Document	Specific API/Document	Method	API URL	Polaris API Debugging Link
Task Management	Start Moderation	POST	/rtc/contentcensor/start.json	API Debug
Task Management	Stop Moderation	POST	/rtc/contentcensor/stop.json	API Debug