RTC, SFU meeting, and collaboration APIs
This layer covers rooms, participants, publications, subscriptions, WHIP/WHEP, chat, whiteboards, screen sharing, moderation, and meeting archives. Issue short-lived tickets; never hand an administrator token to a browser.
This page covers 117 operations. Each row states the endpoint, purpose, timing, completion check, and caller identity. Use the matching OpenAPI file for exact field schemas.
Business APIs may be called by the WebUI or an authorized integration. Administrator APIs require an admin session. Internal APIs and callbacks are only for trusted product components.
RTC common capabilities
| Endpoint | Plain meaning | When to use it | How to confirm | Audience / permission | Main input |
|---|---|---|---|---|---|
GET /api/v2/rtc/capabilities |
Read rtc / capabilities. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
No business input |
POST /api/v2/rtc/media-sessions/{sessionId}/release |
Create or run rtc / media sessions / the selected sessionId / release. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
sessionId (required) |
POST /api/v2/rtc/participants/timeout-scan |
Create or run rtc / participants / timeout scan. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
No business input |
GET /api/v2/rtc/recordings |
Read rtc / recordings. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId, search, participantId, deviceSessionId, state, fromUtc, toUtc, page, pageSize |
GET /api/v2/rtc/resources |
Read rtc / resources. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
No business input |
GET /api/v2/rtc/room-state-model |
Read rtc / room state model. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
No business input |
GET /api/v2/rtc/session/rooms/{roomId} |
Read rtc / session / rooms / the selected roomId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
PUT /api/v2/rtc/session/rooms/{roomId}/access-policy |
Update rtc / session / rooms / the selected roomId / access policy. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), UpdateRtcRoomAccessRequest |
GET /api/v2/rtc/session/rooms/{roomId}/admission/status |
Read rtc / session / rooms / the selected roomId / admission / status. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.participate |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/chat/attachments |
Create or run rtc / session / rooms / the selected roomId / chat / attachments. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/chat/attachments/{attachmentId} |
Read rtc / session / rooms / the selected roomId / chat / attachments / the selected attachmentId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.participate |
roomId (required), attachmentId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/close |
Create or run rtc / session / rooms / the selected roomId / close. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/connection-settings |
Read rtc / session / rooms / the selected roomId / connection settings. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/endpoint-info |
Read rtc / session / rooms / the selected roomId / endpoint info. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.participate |
roomId (required) |
PUT /api/v2/rtc/session/rooms/{roomId}/endpoint-info |
Update rtc / session / rooms / the selected roomId / endpoint info. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), RtcEndpointTelemetry |
POST /api/v2/rtc/session/rooms/{roomId}/extend |
Create or run rtc / session / rooms / the selected roomId / extend. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), ExtendRtcMeetingRequest |
GET /api/v2/rtc/session/rooms/{roomId}/external-sources |
Read rtc / session / rooms / the selected roomId / external sources. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/external-sources |
Create or run rtc / session / rooms / the selected roomId / external sources. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), AddRtcExternalSourceRequest |
DELETE /api/v2/rtc/session/rooms/{roomId}/external-sources/{bindingId} |
Delete rtc / session / rooms / the selected roomId / external sources / the selected bindingId. | Use it only after the user has reviewed and confirmed the affected data. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), bindingId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/external-sources/candidates |
Read rtc / session / rooms / the selected roomId / external sources / candidates. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/external-sources/candidates/{grantId}/snapshot |
Read rtc / session / rooms / the selected roomId / external sources / candidates / the selected grantId / snapshot. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), grantId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/heartbeat |
Create or run rtc / session / rooms / the selected roomId / heartbeat. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/host/claim |
Create or run rtc / session / rooms / the selected roomId / host / claim. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), ClaimRtcHostRequest |
POST /api/v2/rtc/session/rooms/{roomId}/host/transfer |
Create or run rtc / session / rooms / the selected roomId / host / transfer. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), TransferRtcHostRequest |
GET /api/v2/rtc/session/rooms/{roomId}/invitations |
Read rtc / session / rooms / the selected roomId / invitations. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.participate |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/invitations |
Create or run rtc / session / rooms / the selected roomId / invitations. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), CreateRtcMeetingInvitationRequest |
POST /api/v2/rtc/session/rooms/{roomId}/invitations/{invitationId}/revoke |
Create or run rtc / session / rooms / the selected roomId / invitations / the selected invitationId / revoke. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), invitationId (required), RevokeRtcMeetingInvitationRequest |
POST /api/v2/rtc/session/rooms/{roomId}/join |
Create or run rtc / session / rooms / the selected roomId / join. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>专用流程 |
roomId (required), SecureJoinRtcRoomRequest |
GET /api/v2/rtc/session/rooms/{roomId}/leadership |
Read rtc / session / rooms / the selected roomId / leadership. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/leave |
Create or run rtc / session / rooms / the selected roomId / leave. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), SecureLeaveRtcRoomRequest |
GET /api/v2/rtc/session/rooms/{roomId}/participants |
Read rtc / session / rooms / the selected roomId / participants. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/participants/{participantId}/admission |
Create or run rtc / session / rooms / the selected roomId / participants / the selected participantId / admission. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), participantId (required), ReviewRtcAdmissionRequest |
POST /api/v2/rtc/session/rooms/{roomId}/participants/{participantId}/cohost |
Create or run rtc / session / rooms / the selected roomId / participants / the selected participantId / cohost. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), participantId (required), SetRtcCohostRequest |
POST /api/v2/rtc/session/rooms/{roomId}/participants/{participantId}/moderation |
Create or run rtc / session / rooms / the selected roomId / participants / the selected participantId / moderation. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), participantId (required), ModerateRtcParticipantRequest |
POST /api/v2/rtc/session/rooms/{roomId}/participants/{participantId}/whiteboard-access |
Create or run rtc / session / rooms / the selected roomId / participants / the selected participantId / whiteboard access. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), participantId (required), ReviewRtcWhiteboardAccessRequest |
POST /api/v2/rtc/session/rooms/{roomId}/playback-ticket |
Create or run rtc / session / rooms / the selected roomId / playback ticket. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/files/{fileId}/download |
Read rtc / session / rooms / the selected roomId / playback / files / the selected fileId / download. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required), fileId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/files/{fileId}/media |
Read rtc / session / rooms / the selected roomId / playback / files / the selected fileId / media. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.play |
roomId (required), fileId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/manifest |
Read rtc / session / rooms / the selected roomId / playback / manifest. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required), afterSequence, maxEvents |
GET /api/v2/rtc/session/rooms/{roomId}/playback/package |
Read rtc / session / rooms / the selected roomId / playback / package. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/attachments/{attachmentId}/content |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / attachments / the selected attachmentId / content. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required), recordingId (required), attachmentId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/attachments/{attachmentId}/download |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / attachments / the selected attachmentId / download. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required), recordingId (required), attachmentId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/files/{fileId}/download |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / files / the selected fileId / download. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required), recordingId (required), fileId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/files/{fileId}/media |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / files / the selected fileId / media. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.play |
roomId (required), recordingId (required), fileId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/full-exports |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / full exports. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required), recordingId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/full-exports/{exportId}/download |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / full exports / the selected exportId / download. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required), recordingId (required), exportId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/full-exports/{exportId}/media |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / full exports / the selected exportId / media. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.play |
roomId (required), recordingId (required), exportId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/manifest |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / manifest. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required), recordingId (required), afterSequence, maxEvents |
GET /api/v2/rtc/session/rooms/{roomId}/playback/recordings/{recordingId}/package |
Read rtc / session / rooms / the selected roomId / playback / recordings / the selected recordingId / package. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.download |
roomId (required), recordingId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/publications |
Read rtc / session / rooms / the selected roomId / publications. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/publications |
Create or run rtc / session / rooms / the selected roomId / publications. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), CreateRtcPublicationRequest |
POST /api/v2/rtc/session/rooms/{roomId}/publications/{publicationId}/rtmp-ticket |
Create or run rtc / session / rooms / the selected roomId / publications / the selected publicationId / rtmp ticket. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), publicationId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/publications/{publicationId}/stop |
Create or run rtc / session / rooms / the selected roomId / publications / the selected publicationId / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required), publicationId (required), StopRtcPublicationRequest |
POST /api/v2/rtc/session/rooms/{roomId}/publications/{publicationId}/telemetry |
Create or run rtc / session / rooms / the selected roomId / publications / the selected publicationId / telemetry. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), publicationId (required), ReportRtcPublicationTelemetryRequest |
POST /api/v2/rtc/session/rooms/{roomId}/publications/{publicationId}/whip |
Create or run rtc / session / rooms / the selected roomId / publications / the selected publicationId / whip. | Use it when the user submits this action or configuration change. | After the SDP response, verify ICE/DTLS and the media-session state. | Business API<br>rtc.participate |
roomId (required), publicationId (required), preferredTcp, candUdp, candTcp |
POST /api/v2/rtc/session/rooms/{roomId}/recording/continuous/{recordingId}/stop |
Create or run rtc / session / rooms / the selected roomId / recording / continuous / the selected recordingId / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required), recordingId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/recording/continuous/current |
Read rtc / session / rooms / the selected roomId / recording / continuous / current. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.participate |
roomId (required) |
GET /api/v2/rtc/session/rooms/{roomId}/recording/continuous/runs |
Read rtc / session / rooms / the selected roomId / recording / continuous / runs. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/recording/continuous/start |
Create or run rtc / session / rooms / the selected roomId / recording / continuous / start. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/recording/start |
Create or run rtc / session / rooms / the selected roomId / recording / start. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required), StartRtcRoomRecordingRequest |
POST /api/v2/rtc/session/rooms/{roomId}/recording/stop |
Create or run rtc / session / rooms / the selected roomId / recording / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required), StopRtcRoomRecordingRequest |
GET /api/v2/rtc/session/rooms/{roomId}/recording/targets |
Read rtc / session / rooms / the selected roomId / recording / targets. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), includeInactive |
GET /api/v2/rtc/session/rooms/{roomId}/signaling/ws |
Read rtc / session / rooms / the selected roomId / signaling / ws. | Use it when loading a page, refreshing state, or searching current data. | Handle authentication, disconnects, reconnects, and event sequence numbers after the WebSocket upgrade. | Business API<br>rtc.participate |
roomId (required), lastSequence, replayPageSize |
GET /api/v2/rtc/session/rooms/{roomId}/subscriptions |
Read rtc / session / rooms / the selected roomId / subscriptions. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/session/rooms/{roomId}/subscriptions |
Create or run rtc / session / rooms / the selected roomId / subscriptions. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), CreateRtcSubscriptionRequest |
POST /api/v2/rtc/session/rooms/{roomId}/subscriptions/{subscriptionId}/stop |
Create or run rtc / session / rooms / the selected roomId / subscriptions / the selected subscriptionId / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.participate |
roomId (required), subscriptionId (required), StopRtcSubscriptionRequest |
POST /api/v2/rtc/session/rooms/{roomId}/subscriptions/{subscriptionId}/whep |
Create or run rtc / session / rooms / the selected roomId / subscriptions / the selected subscriptionId / whep. | Use it when the user submits this action or configuration change. | After the SDP response, verify ICE/DTLS and the media-session state. | Business API<br>rtc.participate |
roomId (required), subscriptionId (required), preferredTcp, candUdp, candTcp |
POST /api/v2/rtc/session/rooms/{roomId}/token/refresh |
Create or run rtc / session / rooms / the selected roomId / token / refresh. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required) |
PUT /api/v2/rtc/session/rooms/{roomId}/video-quality |
Update rtc / session / rooms / the selected roomId / video quality. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), SetRtcVideoQualityRequest |
POST /api/v2/rtc/session/rooms/{roomId}/whiteboard/access-request |
Create or run rtc / session / rooms / the selected roomId / whiteboard / access request. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), RequestRtcWhiteboardAccessRequest |
POST /api/v2/rtc/session/rooms/{roomId}/whiteboard/lock |
Create or run rtc / session / rooms / the selected roomId / whiteboard / lock. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), SetRtcWhiteboardLockRequest |
DELETE /api/v2/rtc/webrtc |
Delete rtc / webrtc. | Use it only after the user has reviewed and confirmed the affected data. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
mediaServerId, id, token |
Rooms and collaboration
| Endpoint | Plain meaning | When to use it | How to confirm | Audience / permission | Main input |
|---|---|---|---|---|---|
GET /api/v2/rtc/rooms |
Read rtc / rooms. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
No business input |
POST /api/v2/rtc/rooms |
Create or run rtc / rooms. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
CreateRtcRoomRequest |
GET /api/v2/rtc/rooms/{roomId} |
Read rtc / rooms / the selected roomId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/rooms/{roomId}/access-tickets |
Create or run rtc / rooms / the selected roomId / access tickets. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), CreateRtcMeetingInvitationRequest |
POST /api/v2/rtc/rooms/{roomId}/announcement |
Create or run rtc / rooms / the selected roomId / announcement. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), BroadcastRtcAnnouncementRequest |
PUT /api/v2/rtc/rooms/{roomId}/capacity |
Update rtc / rooms / the selected roomId / capacity. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), UpdateRtcRoomCapacityRequest |
POST /api/v2/rtc/rooms/{roomId}/chat/messages |
Create or run rtc / rooms / the selected roomId / chat / messages. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), SendRtcChatMessageRequest |
POST /api/v2/rtc/rooms/{roomId}/close |
Create or run rtc / rooms / the selected roomId / close. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required) |
POST /api/v2/rtc/rooms/{roomId}/datachannel/events |
Create or run rtc / rooms / the selected roomId / datachannel / events. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), PostRtcDataChannelEventRequest |
GET /api/v2/rtc/rooms/{roomId}/events |
Read rtc / rooms / the selected roomId / events. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), channel, afterSequence, pageSize |
GET /api/v2/rtc/rooms/{roomId}/external-sources/available-channels |
Read rtc / rooms / the selected roomId / external sources / available channels. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
GET /api/v2/rtc/rooms/{roomId}/external-sources/grants |
Read rtc / rooms / the selected roomId / external sources / grants. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
POST /api/v2/rtc/rooms/{roomId}/external-sources/grants |
Create or run rtc / rooms / the selected roomId / external sources / grants. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), GrantRtcExternalSourceRequest |
DELETE /api/v2/rtc/rooms/{roomId}/external-sources/grants/{grantId} |
Delete rtc / rooms / the selected roomId / external sources / grants / the selected grantId. | Use it only after the user has reviewed and confirmed the affected data. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), grantId (required) |
POST /api/v2/rtc/rooms/{roomId}/join |
Create or run rtc / rooms / the selected roomId / join. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), JoinRtcRoomRequest |
GET /api/v2/rtc/rooms/{roomId}/media-sessions |
Read rtc / rooms / the selected roomId / media sessions. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), includeClosed |
POST /api/v2/rtc/rooms/{roomId}/moderation |
Create or run rtc / rooms / the selected roomId / moderation. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), ModerateRtcRoomRequest |
GET /api/v2/rtc/rooms/{roomId}/participants/{participantId}/endpoint |
Read rtc / rooms / the selected roomId / participants / the selected participantId / endpoint. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), participantId (required), screen (required) |
GET /api/v2/rtc/rooms/{roomId}/participants/{participantId}/events |
Read rtc / rooms / the selected roomId / participants / the selected participantId / events. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), participantId (required), channel, afterSequence, pageSize |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/heartbeat |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / heartbeat. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), participantId (required) |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/leave |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / leave. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), participantId (required) |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/media-state |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / media state. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), participantId (required), UpdateRtcParticipantMediaRequest |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/moderation |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / moderation. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), participantId (required), ModerateRtcParticipantRequest |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/screen-share |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / screen share. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), participantId (required), SetRtcScreenShareRequest |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/whep |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / whep. | Use it when the user submits this action or configuration change. | After the SDP response, verify ICE/DTLS and the media-session state. | Business API<br>rtc.participate |
roomId (required), participantId (required), screen, preferredTcp, candUdp, candTcp, string |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/whip |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / whip. | Use it when the user submits this action or configuration change. | After the SDP response, verify ICE/DTLS and the media-session state. | Business API<br>rtc.participate |
roomId (required), participantId (required), screen, preferredTcp, candUdp, candTcp, string |
POST /api/v2/rtc/rooms/{roomId}/participants/{participantId}/whiteboard-access |
Create or run rtc / rooms / the selected roomId / participants / the selected participantId / whiteboard access. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), participantId (required), ReviewRtcWhiteboardAccessRequest |
POST /api/v2/rtc/rooms/{roomId}/participants/{viewerParticipantId}/subscriptions/{publisherParticipantId}/whep |
Create or run rtc / rooms / the selected roomId / participants / the selected viewerParticipantId / subscriptions / the selected publisherParticipantId / whep. | Use it when the user submits this action or configuration change. | After the SDP response, verify ICE/DTLS and the media-session state. | Business API<br>rtc.participate |
roomId (required), viewerParticipantId (required), publisherParticipantId (required), screen, preferredTcp, candUdp, candTcp, string |
POST /api/v2/rtc/rooms/{roomId}/publications/{publicationId}/admin-stop |
Create or run rtc / rooms / the selected roomId / publications / the selected publicationId / admin stop. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), publicationId (required), StopRtcPublicationRequest |
PUT /api/v2/rtc/rooms/{roomId}/recording-policy |
Update rtc / rooms / the selected roomId / recording policy. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), RtcRecordingPolicyRequest |
POST /api/v2/rtc/rooms/{roomId}/recording/continuous/{recordingId}/composites/{compositeId}/retry |
Create or run rtc / rooms / the selected roomId / recording / continuous / the selected recordingId / composites / the selected compositeId / retry. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), recordingId (required), compositeId (required) |
POST /api/v2/rtc/rooms/{roomId}/recording/continuous/{recordingId}/full-exports |
Create or run rtc / rooms / the selected roomId / recording / continuous / the selected recordingId / full exports. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), recordingId (required), CreateRtcFullExportRequest |
POST /api/v2/rtc/rooms/{roomId}/recording/continuous/{recordingId}/full-exports/{exportId}/retry |
Create or run rtc / rooms / the selected roomId / recording / continuous / the selected recordingId / full exports / the selected exportId / retry. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.manage |
roomId (required), recordingId (required), exportId (required) |
POST /api/v2/rtc/rooms/{roomId}/recording/continuous/{recordingId}/stop |
Create or run rtc / rooms / the selected roomId / recording / continuous / the selected recordingId / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.manage |
roomId (required), recordingId (required) |
GET /api/v2/rtc/rooms/{roomId}/recording/continuous/current |
Read rtc / rooms / the selected roomId / recording / continuous / current. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required) |
GET /api/v2/rtc/rooms/{roomId}/recording/continuous/runs |
Read rtc / rooms / the selected roomId / recording / continuous / runs. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.recordings.view |
roomId (required) |
POST /api/v2/rtc/rooms/{roomId}/recording/continuous/start |
Create or run rtc / rooms / the selected roomId / recording / continuous / start. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.manage |
roomId (required) |
POST /api/v2/rtc/rooms/{roomId}/recording/start |
Create or run rtc / rooms / the selected roomId / recording / start. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.manage |
roomId (required), StartRtcRoomRecordingRequest |
POST /api/v2/rtc/rooms/{roomId}/recording/stop |
Create or run rtc / rooms / the selected roomId / recording / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>rtc.manage |
roomId (required), StopRtcRoomRecordingRequest |
GET /api/v2/rtc/rooms/{roomId}/recording/targets |
Read rtc / rooms / the selected roomId / recording / targets. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), includeInactive |
POST /api/v2/rtc/rooms/{roomId}/recordings/access |
Create or run rtc / rooms / the selected roomId / recordings / access. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.recordings.view |
roomId (required), RtcArchiveAccessRequest |
GET /api/v2/rtc/rooms/{roomId}/signaling/connections |
Read rtc / rooms / the selected roomId / signaling / connections. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required) |
GET /api/v2/rtc/rooms/{roomId}/signaling/ws |
Read rtc / rooms / the selected roomId / signaling / ws. | Use it when loading a page, refreshing state, or searching current data. | Handle authentication, disconnects, reconnects, and event sequence numbers after the WebSocket upgrade. | Business API<br>rtc.participate |
roomId (required), participantId, lastSequence, replayPageSize |
GET /api/v2/rtc/rooms/{roomId}/subscription-topology |
Read rtc / rooms / the selected roomId / subscription topology. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>rtc.view |
roomId (required), viewerParticipantId, includeSelf, includeInactive |
POST /api/v2/rtc/rooms/{roomId}/whiteboard/events |
Create or run rtc / rooms / the selected roomId / whiteboard / events. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>rtc.participate |
roomId (required), PostRtcWhiteboardEventRequest |
Fields and examples
This page keeps business purpose readable. When coding, use the OpenAPI and Postman assets shipped with the deployed version for request bodies, response bodies, enums, file types, and examples. Do not use a newer website contract against an older service.