Cloudflare API | Realtime Kit

Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.

Realtime Kit

Livestreams

realtime_kit.livestreams

Methods

Create An Independent Livestream -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.

Fetch All Livestreams -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

Stop Livestreaming A Meeting -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop

Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

Start Livestreaming A Meeting -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

Fetch Complete Analytics Data For Your Livestreams -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall

Returns livestream analytics for the specified time range.

Fetch Day Wise Session And Recording Analytics Data For An App -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise

Fetch Active Livestreams For A Meeting -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream

Returns details of all active livestreams for the given meeting ID.

Fetch Livestream Session Details Using Livestream Session ID -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}

Returns livestream session details for the given livestream session ID. Retrieve the livestream_session_idusing the Fetch livestream session details using a session ID API.

Fetch Active Livestream Session Details -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session

Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

Fetch Livestream Details Using Livestream ID -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}

Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

Realtime Kit

Meetings

realtime_kit.meetings

Methods

Fetch All Meetings For An App -> { data, paging, success }

get/accounts/{account_id}/realtime/kit/{app_id}/meetings

Returns all meetings for the given App ID.

Create A Meeting -> { success, data }

post/accounts/{account_id}/realtime/kit/{app_id}/meetings

Create a meeting for the given App ID.

Fetch A Meeting For An App -> { success, data }

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Returns a meeting details in an App for the given meeting ID.

Update A Meeting -> { success, data }

patch/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Updates a meeting in an App for the given meeting ID.

Replace A Meeting -> { success, data }

put/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Replaces all the details for the given meeting ID.

Fetch All Participants Of A Meeting -> { data, paging, success }

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Returns all participants detail for the given meeting ID.

Add A Participant -> { success, data }

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Adds a participant to the given meeting ID.

Fetch A Participant S Detail -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Returns a participant details for the given meeting and participant ID.

Edit A Participant S Detail -> { success, data }

patch/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Updates a participant's details for the given meeting and participant ID.

Delete A Participant -> { success, data }

delete/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Deletes a participant for the given meeting and participant ID.

Refresh Participant S Authentication Token -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token

Regenerates participant's authentication token for the given meeting and participant ID.

Realtime Kit

Presets

realtime_kit.presets

Methods

Fetch All Presets -> { data, paging, success }

get/accounts/{account_id}/realtime/kit/{app_id}/presets

Fetches all the presets belonging to an App.

Create A Preset -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/presets

Creates a preset belonging to the current App

Fetch Details Of A Preset -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Fetches details of a preset using the provided preset ID

Delete A Preset -> { data, success }

delete/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Deletes a preset using the provided preset ID

Update A Preset -> { data, success }

patch/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Update a preset by the provided preset ID

Realtime Kit

Recordings

realtime_kit.recordings

Methods

Fetch All Recordings For An App -> { data, paging, success }

get/accounts/{account_id}/realtime/kit/{app_id}/recordings

Returns all recordings for an App. If the meeting_id parameter is passed, returns all recordings for the given meeting ID.

Start Recording A Meeting -> { success, data }

post/accounts/{account_id}/realtime/kit/{app_id}/recordings

Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

Fetch Active Recording -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}

Returns the active recording details for the given meeting ID.

Fetch Details Of A Recording -> { success, data }

get/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}

Returns details of a recording for the given recording ID.

Start Recording Audio And Video Tracks ->

post/accounts/{account_id}/realtime/kit/{app_id}/recordings/track

Starts a track recording in a meeting. Track recordings consist of "layers". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the Track Recordings Guide Page.

Realtime Kit

Sessions

realtime_kit.sessions

Methods

Fetch All Sessions Of An App -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions

Returns details of all sessions of an App.

Fetch Details Of A Session -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}

Returns data of the given session ID including recording details.

Fetch Participants List Of A Session -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants

Returns a list of participants for the given session ID.

Fetch Details Of A Participant -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}

Returns details of the given participant ID along with call statistics for the given session ID.

Fetch All Chat Messages Of A Session -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat

Returns a URL to download all chat messages of the session ID in CSV format.

Fetch The Complete Transcript For A Session -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript

Returns a URL to download the transcript for the session ID in CSV format.

Fetch Summary Of Transcripts For A Session -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.

Generate Summary Of Transcripts For The Session ->

post/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Trigger Summary generation of Transcripts for the session ID.

Fetch Details Of Peer -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}

Returns details of the given peer ID along with call statistics for the given session ID.

Realtime Kit

Webhooks

realtime_kit.webhooks

Methods

Fetch All Webhooks Details -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Returns details of all webhooks for an App.

Add A Webhook -> { data, success }

post/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Adds a new webhook to an App.

Fetch Details Of A Webhook -> { data, success }

get/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Returns webhook details for the given webhook ID.

Replace A Webhook -> { data, success }

put/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Replace all details for the given webhook ID.

Edit A Webhook -> { data, success }

patch/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Edits the webhook details for the given webhook ID.

Delete A Webhook -> { data, success }

delete/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Removes a webhook for the given webhook ID.