Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Active Session

Fetch details of an active session
client.realtimeKit.activeSession.getActiveSession(stringmeetingID, ActiveSessionGetActiveSessionParams { account_id, app_id } params, RequestOptionsoptions?): ActiveSessionGetActiveSessionResponse { data, success }
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session
Kick participants from an active session
client.realtimeKit.activeSession.kickParticipants(stringmeetingID, ActiveSessionKickParticipantsParams { account_id, app_id, custom_participant_ids, participant_ids } params, RequestOptionsoptions?): ActiveSessionKickParticipantsResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick
Kick all participants
client.realtimeKit.activeSession.kickAllParticipants(stringmeetingID, ActiveSessionKickAllParticipantsParams { account_id, app_id } params, RequestOptionsoptions?): ActiveSessionKickAllParticipantsResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all
Create a poll
client.realtimeKit.activeSession.createPoll(stringmeetingID, ActiveSessionCreatePollParams { account_id, app_id, options, 3 more } params, RequestOptionsoptions?): ActiveSessionCreatePollResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll
ModelsExpand Collapse
ActiveSessionGetActiveSessionResponse { data, success }
data?: Data { id, associated_id, created_at, 11 more }
id: string

ID of the session

associated_id: string

ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl

created_at: string

timestamp when session created

live_participants: number

number of participants currently in the session

max_concurrent_participants: number

number of maximum participants that were in the session

meeting_display_name: string

Title of the meeting this session belongs to

minutes_consumed: number

number of minutes consumed since the session started

organization_id: string

App id that hosted this session

started_at: string

timestamp when session started

status: "LIVE" | "ENDED"

current status of session

One of the following:
"LIVE"
"ENDED"
type: "meeting" | "livestream" | "participant"

type of session

One of the following:
"meeting"
"livestream"
"participant"
updated_at: string

timestamp when session was last updated

breakout_rooms?: Array<unknown>
ended_at?: string

timestamp when session ended

success?: boolean
ActiveSessionKickParticipantsResponse { data, success }
data?: Data { action, participants }
action?: string
participants?: Array<Participant>
id: string

ID of the session participant

created_at: string
updated_at: string
email?: string

Email of the session participant.

name?: string

Name of the session participant.

picture?: string

A URL pointing to a picture of the participant.

success?: boolean
ActiveSessionKickAllParticipantsResponse { data, success }
data?: Data { action, kicked_participants_count }
action?: string
kicked_participants_count?: number
success?: boolean
ActiveSessionCreatePollResponse { data, success }
data?: Data { action, poll }
action?: string
poll?: Poll { id, options, question, 4 more }
id: string

ID of the poll

options: Array<Option>

Answer options

count: number
text: string

Text of the answer option

votes: Array<Vote>
id: string
name: string
question: string

Question asked by the poll

anonymous?: boolean
created_by?: string
hide_votes?: boolean
voted?: Array<string>
success?: boolean