Skip to content
Start here

Active Session

Fetch details of an active session
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session
Kick participants from an active session
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick
Kick all participants
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all
Create a poll
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll
ModelsExpand Collapse
ActiveSessionGetActiveSessionResponse = object { data, success }
data: optional object { id, associated_id, created_at, 12 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" or "ENDED"

current status of session

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

type of session

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

timestamp when session was last updated

breakout_rooms: optional array of unknown
ended_at: optional string

timestamp when session ended

meta: optional unknown

Any meta data about session.

success: optional boolean
ActiveSessionKickParticipantsResponse = object { data, success }
data: optional object { action, participants }
action: optional string
participants: optional array of object { id, created_at, updated_at, 3 more }
id: string

ID of the session participant

created_at: string
updated_at: string
email: optional string

Email of the session participant.

name: optional string

Name of the session participant.

picture: optional string

A URL pointing to a picture of the participant.

success: optional boolean
ActiveSessionKickAllParticipantsResponse = object { data, success }
data: optional object { action, kicked_participants_count }
action: optional string
kicked_participants_count: optional number
success: optional boolean
ActiveSessionCreatePollResponse = object { data, success }
data: optional object { action, poll }
action: optional string
poll: optional object { id, options, question, 4 more }
id: string

ID of the poll

options: array of object { count, text, votes }

Answer options

count: number
text: string

Text of the answer option

votes: array of object { id, name }
id: string
name: string
question: string

Question asked by the poll

anonymous: optional boolean
created_by: optional string
hide_votes: optional boolean
voted: optional array of string
success: optional boolean