---
title: Active Session
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Active Session

##### [Fetch details of an active session](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit/subresources/active-session/methods/get%5Factive%5Fsession)

client.realtimeKit.activeSession.getActiveSession(stringmeetingID, ActiveSessionGetActiveSessionParams { account\_id, app\_id } params, RequestOptionsoptions?): [ActiveSessionGetActiveSessionResponse](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit#%28resource%29%20realtime%5Fkit.active-session%20%3E%20%28model%29%20active%5Fsession%5Fget%5Factive%5Fsession%5Fresponse%20%3E%20%28schema%29) { data, success } 

GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session

##### [Kick participants from an active session](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit/subresources/active-session/methods/kick%5Fparticipants)

client.realtimeKit.activeSession.kickParticipants(stringmeetingID, ActiveSessionKickParticipantsParams { account\_id, app\_id, custom\_participant\_ids, participant\_ids } params, RequestOptionsoptions?): [ActiveSessionKickParticipantsResponse](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit#%28resource%29%20realtime%5Fkit.active-session%20%3E%20%28model%29%20active%5Fsession%5Fkick%5Fparticipants%5Fresponse%20%3E%20%28schema%29) { data, success } 

POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session/kick

##### [Kick all participants](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit/subresources/active-session/methods/kick%5Fall%5Fparticipants)

client.realtimeKit.activeSession.kickAllParticipants(stringmeetingID, ActiveSessionKickAllParticipantsParams { account\_id, app\_id } params, RequestOptionsoptions?): [ActiveSessionKickAllParticipantsResponse](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit#%28resource%29%20realtime%5Fkit.active-session%20%3E%20%28model%29%20active%5Fsession%5Fkick%5Fall%5Fparticipants%5Fresponse%20%3E%20%28schema%29) { data, success } 

POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session/kick-all

##### [Create a poll](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit/subresources/active-session/methods/create%5Fpoll)

client.realtimeKit.activeSession.createPoll(stringmeetingID, ActiveSessionCreatePollParams { account\_id, app\_id, options, 3 more } params, RequestOptionsoptions?): [ActiveSessionCreatePollResponse](https://developers.cloudflare.com/api/typescript/resources/realtime%5Fkit#%28resource%29%20realtime%5Fkit.active-session%20%3E%20%28model%29%20active%5Fsession%5Fcreate%5Fpoll%5Fresponse%20%3E%20%28schema%29) { 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