---
title: Active Session
---

[Skip to content](#_top)

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

[Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime_kit)

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_kit/subresources/active-session/methods/get_active_session)

client.realtimeKit.activeSession.getActiveSession(stringmeetingID, ActiveSessionGetActiveSessionParams {account\_id, app\_id } params, RequestOptionsoptions?): [ActiveSessionGetActiveSessionResponse](<https://developers.cloudflare.com/api/typescript/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)>) {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_kit/subresources/active-session/methods/kick_participants)

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_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)>) {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_kit/subresources/active-session/methods/kick_all_participants)

client.realtimeKit.activeSession.kickAllParticipants(stringmeetingID, ActiveSessionKickAllParticipantsParams {account\_id, app\_id } params, RequestOptionsoptions?): [ActiveSessionKickAllParticipantsResponse](<https://developers.cloudflare.com/api/typescript/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)>) {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_kit/subresources/active-session/methods/create_poll)

client.realtimeKit.activeSession.createPoll(stringmeetingID, ActiveSessionCreatePollParams {account\_id, app\_id, options, 3 more } params, RequestOptionsoptions?): [ActiveSessionCreatePollResponse](<https://developers.cloudflare.com/api/typescript/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)>) {data, success }

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

##### ModelsExpand Collapse

<details>

<summary>

ActiveSessionGetActiveSessionResponse {data, success }

</summary>

<details>

<summary>

data?: Data {id, associated\_id, created\_at, 11 more }

</summary>

id: string

ID of the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20id">Link to this property</a>

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 <code>abcdef-ghijkl</code>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20associated_id">Link to this property</a>

created\_at: string

timestamp when session created

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20created_at">Link to this property</a>

live\_participants: number

number of participants currently in the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20live_participants">Link to this property</a>

max\_concurrent\_participants: number

number of maximum participants that were in the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20max_concurrent_participants">Link to this property</a>

meeting\_display\_name: string

Title of the meeting this session belongs to

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20meeting_display_name">Link to this property</a>

minutes\_consumed: number

number of minutes consumed since the session started

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20minutes_consumed">Link to this property</a>

organization\_id: string

App id that hosted this session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20organization_id">Link to this property</a>

started\_at: string

timestamp when session started

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20started_at">Link to this property</a>

<details>

<summary>

status: "LIVE"| "ENDED"

current status of session

</summary>

One of the following:

"LIVE"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"ENDED"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status">Link to this property</a>

<details>

<summary>

type: "meeting"| "livestream"| "participant"

type of session

</summary>

One of the following:

"meeting"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"livestream"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"participant"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type">Link to this property</a>

updated\_at: string

timestamp when session was last updated

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20updated_at">Link to this property</a>

breakout\_rooms?: Array&lt;unknown&gt;

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20breakout_rooms">Link to this property</a>

ended\_at?: string

timestamp when session ended

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20ended_at">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)>)

<details>

<summary>

ActiveSessionKickParticipantsResponse {data, success }

</summary>

<details>

<summary>

data?: Data {action, participants }

</summary>

action?: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

participants?: Array&lt;Participant&gt;

</summary>

id: string

ID of the session participant

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

created\_at: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20created_at">Link to this property</a>

updated\_at: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20updated_at">Link to this property</a>

email?: string

Email of the session participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20email">Link to this property</a>

name?: string

Name of the session participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20name">Link to this property</a>

picture?: string

A URL pointing to a picture of the participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20picture">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)>)

<details>

<summary>

ActiveSessionKickAllParticipantsResponse {data, success }

</summary>

<details>

<summary>

data?: Data {action, kicked\_participants\_count }

</summary>

action?: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

kicked\_participants\_count?: number

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20kicked_participants_count">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)>)

<details>

<summary>

ActiveSessionCreatePollResponse {data, success }

</summary>

<details>

<summary>

data?: Data {action, poll }

</summary>

action?: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

poll?: Poll {id, options, question, 4 more }

</summary>

id: string

ID of the poll

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

options: Array&lt;Option&gt;

Answer options

</summary>

count: number

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20count">Link to this property</a>

text: string

Text of the answer option

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20text">Link to this property</a>

<details>

<summary>

votes: Array&lt;Vote&gt;

</summary>

id: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

name: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes%20%3E%20(items)%20%3E%20(property)%20name">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options">Link to this property</a>

question: string

Question asked by the poll

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20question">Link to this property</a>

anonymous?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20anonymous">Link to this property</a>

created\_by?: string

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20created_by">Link to this property</a>

hide\_votes?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20hide_votes">Link to this property</a>

voted?: Array&lt;string&gt;

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20voted">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success?: boolean

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)>)