Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Active Session

Fetch details of an active session
realtime_kit.active_session.get_active_session(strmeeting_id, ActiveSessionGetActiveSessionParams**kwargs) -> ActiveSessionGetActiveSessionResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session
Kick participants from an active session
realtime_kit.active_session.kick_participants(strmeeting_id, ActiveSessionKickParticipantsParams**kwargs) -> ActiveSessionKickParticipantsResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick
Kick all participants
realtime_kit.active_session.kick_all_participants(strmeeting_id, ActiveSessionKickAllParticipantsParams**kwargs) -> ActiveSessionKickAllParticipantsResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all
Create a poll
realtime_kit.active_session.create_poll(strmeeting_id, ActiveSessionCreatePollParams**kwargs) -> ActiveSessionCreatePollResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll
Mute participants of an active session
realtime_kit.active_session.mute_participants(strmeeting_id, ActiveSessionMuteParticipantsParams**kwargs) -> ActiveSessionMuteParticipantsResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute
Mute all participants
realtime_kit.active_session.mute_all_participants(strmeeting_id, ActiveSessionMuteAllParticipantsParams**kwargs) -> ActiveSessionMuteAllParticipantsResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute-all
ModelsExpand Collapse
class ActiveSessionGetActiveSessionResponse: …
data: Optional[Data]
id: str

ID of the session

associated_id: str

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: str

timestamp when session created

live_participants: float

number of participants currently in the session

max_concurrent_participants: float

number of maximum participants that were in the session

meeting_display_name: str

Title of the meeting this session belongs to

minutes_consumed: float

number of minutes consumed since the session started

organization_id: str

App id that hosted this session

started_at: str

timestamp when session started

status: Literal["LIVE", "ENDED"]

current status of session

One of the following:
"LIVE"
"ENDED"
type: Literal["meeting", "livestream", "participant"]

type of session

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

timestamp when session was last updated

breakout_rooms: Optional[List[object]]
ended_at: Optional[str]

timestamp when session ended

success: Optional[bool]
class ActiveSessionKickParticipantsResponse: …
data: Optional[Data]
action: Optional[str]
participants: Optional[List[DataParticipant]]
id: str

ID of the session participant

created_at: str
updated_at: str
email: Optional[str]

Email of the session participant.

name: Optional[str]

Name of the session participant.

picture: Optional[str]

A URL pointing to a picture of the participant.

success: Optional[bool]
class ActiveSessionKickAllParticipantsResponse: …
data: Optional[Data]
action: Optional[str]
kicked_participants_count: Optional[float]
success: Optional[bool]
class ActiveSessionCreatePollResponse: …
data: Optional[Data]
action: Optional[str]
poll: Optional[DataPoll]
id: str

ID of the poll

options: List[DataPollOption]

Answer options

count: float
text: str

Text of the answer option

votes: List[DataPollOptionVote]
id: str
name: str
question: str

Question asked by the poll

anonymous: Optional[bool]
created_by: Optional[str]
hide_votes: Optional[bool]
voted: Optional[List[str]]
success: Optional[bool]
class ActiveSessionMuteParticipantsResponse: …
data: Optional[Data]
action: Optional[str]
participants: Optional[List[DataParticipant]]
id: str

ID of the session participant

created_at: str
updated_at: str
email: Optional[str]

Email of the session participant.

name: Optional[str]

Name of the session participant.

picture: Optional[str]

A URL pointing to a picture of the participant.

success: Optional[bool]
class ActiveSessionMuteAllParticipantsResponse: …
data: Optional[Data]
action: Optional[str]
muted_participants_count: Optional[float]
success: Optional[bool]