Fetch details of an active session

realtime_kit.active_session.get_active_session(, ) -> ActiveSessionGetActiveSessionResponse

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session

Returns details of an ongoing active session for the given meeting ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

account_id: str

The account identifier tag.

maxLength32

app_id: str

The app identifier tag.

meeting_id: str

ReturnsExpand 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]

Fetch details of an active session

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.active_session.get_active_session(
    meeting_id="meeting_id",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="14a396e7-ca44-4937-bf1f-050a69118543",
)
print(response.data)

{
  "data": {
    "associated_id": "6bf2b8be-04dd-4191-b602-1128921a306b",
    "created_at": "2022-01-12T14:21:34.398Z",
    "ended_at": "null",
    "id": "813432c7-3c5a-45e2-9acf-eef7061c7584",
    "live_participants": 1,
    "max_concurrent_participants": 2,
    "meeting_display_name": "Test Meeting",
    "minutes_consumed": 2.3434,
    "organization_id": "",
    "started_at": "2022-01-12T14:21:34.388Z",
    "status": "LIVE",
    "type": "meeting",
    "updated_at": "2022-01-12T14:26:00.784Z"
  },
  "success": true
}

{
  "error": {
    "code": 404,
    "message": "No active session found for meeting_id 6bf2b8be-04dd-4191-b602-1128921a306b"
  },
  "success": false
}

Returns Examples

{
  "data": {
    "associated_id": "6bf2b8be-04dd-4191-b602-1128921a306b",
    "created_at": "2022-01-12T14:21:34.398Z",
    "ended_at": "null",
    "id": "813432c7-3c5a-45e2-9acf-eef7061c7584",
    "live_participants": 1,
    "max_concurrent_participants": 2,
    "meeting_display_name": "Test Meeting",
    "minutes_consumed": 2.3434,
    "organization_id": "",
    "started_at": "2022-01-12T14:21:34.388Z",
    "status": "LIVE",
    "type": "meeting",
    "updated_at": "2022-01-12T14:26:00.784Z"
  },
  "success": true
}

{
  "error": {
    "code": 404,
    "message": "No active session found for meeting_id 6bf2b8be-04dd-4191-b602-1128921a306b"
  },
  "success": false
}