Fetch active livestream session details

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session

Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

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

Path ParametersExpand Collapse

account_id: string

The account identifier tag.

maxLength32

app_id: string

The app identifier tag.

livestream_id: string

ReturnsExpand Collapse

data: object { livestream, session }

livestream: object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

session: object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

The time duration for which the input was given or the meeting was streamed.

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

The total view time for which the viewers watched the stream.

success: boolean

Fetch active livestream session details

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/livestreams/$LIVESTREAM_ID/active-livestream-session \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "data": {
    "livestream": {
      "created_at": "2023-07-15T07:08:26.634Z",
      "disabled": false,
      "external_id": "7de6a3fec0f9c05bf1df140950d3a237",
      "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "ingest_server": "rtmps://live.cloudflare.com:443/live/",
      "manual_ingest": false,
      "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
      "name": "test",
      "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
      "status": "LIVE",
      "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4",
      "updated_at": "2023-07-15T07:08:40.726Z"
    },
    "session": {
      "created_at": "2023-07-15T07:08:40.742Z",
      "err_message": null,
      "id": "cf55a850-c3fd-46b5-b5d2-25b3b9aa1686",
      "ingest_seconds": 600,
      "invoked_time": "2023-07-15T07:08:26.634Z",
      "livestream_id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "started_time": "2023-07-15T07:08:39Z",
      "stopped_time": null,
      "updated_at": "2023-07-15T07:18:40.742Z",
      "viewer_seconds": 1200
    }
  },
  "success": true
}

Returns Examples

{
  "data": {
    "livestream": {
      "created_at": "2023-07-15T07:08:26.634Z",
      "disabled": false,
      "external_id": "7de6a3fec0f9c05bf1df140950d3a237",
      "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "ingest_server": "rtmps://live.cloudflare.com:443/live/",
      "manual_ingest": false,
      "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
      "name": "test",
      "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
      "status": "LIVE",
      "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4",
      "updated_at": "2023-07-15T07:08:40.726Z"
    },
    "session": {
      "created_at": "2023-07-15T07:08:40.742Z",
      "err_message": null,
      "id": "cf55a850-c3fd-46b5-b5d2-25b3b9aa1686",
      "ingest_seconds": 600,
      "invoked_time": "2023-07-15T07:08:26.634Z",
      "livestream_id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "started_time": "2023-07-15T07:08:39Z",
      "stopped_time": null,
      "updated_at": "2023-07-15T07:18:40.742Z",
      "viewer_seconds": 1200
    }
  },
  "success": true
}