API Reference

Realtime Kit

Livestreams

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Fetch livestream details using livestream ID

client.RealtimeKit.Livestreams.GetLivestreamSessionForLivestreamID(ctx, appID, livestreamID, params) (*LivestreamGetLivestreamSessionForLivestreamIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}

Returns details of a livestream with sessions 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

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

The app identifier tag.

maxLength32

livestreamID string

params LivestreamGetLivestreamSessionForLivestreamIDParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

PageNo param.Field[int64]Optional

Query param: The page number from which you want your page search results to be displayed.

PerPage param.Field[int64]Optional

Query param: Number of results per page.

ReturnsExpand Collapse

type LivestreamGetLivestreamSessionForLivestreamIDResponse struct{…}

Data LivestreamGetLivestreamSessionForLivestreamIDResponseDataOptional

Livestream LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamOptional

ID stringOptional

ID of the livestream.

CreatedAt stringOptional

Timestamp the object was created at. The time is returned in ISO format.

Disabled stringOptional

Specifies if the livestream was disabled.

IngestServer stringOptional

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

MeetingID stringOptional

The ID of the meeting.

Name stringOptional

Name of the livestream.

PlaybackURL stringOptional

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

Status LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusOptional

One of the following:

const LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusLive LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "LIVE"

const LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusIdle LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "IDLE"

const LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusErrored LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "ERRORED"

const LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusInvoked LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "INVOKED"

StreamKey stringOptional

Unique key for accessing each livestream.

UpdatedAt stringOptional

Timestamp the object was updated at. The time is returned in ISO format.

Paging LivestreamGetLivestreamSessionForLivestreamIDResponseDataPagingOptional

EndOffset int64Optional

StartOffset int64Optional

TotalCount int64Optional

Session LivestreamGetLivestreamSessionForLivestreamIDResponseDataSessionOptional

ID stringOptional

ID of the session.

CreatedAt TimeOptional

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

ErrMessage stringOptional

IngestSeconds float64Optional

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

InvokedTime TimeOptional

Timestamp the object was invoked. The time is returned in ISO format.

formatdate-time

LivestreamID stringOptional

StartedTime TimeOptional

Timestamp the object was started. The time is returned in ISO format.

formatdate-time

StoppedTime TimeOptional

Timestamp the object was stopped. The time is returned in ISO format.

formatdate-time

UpdatedAt TimeOptional

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

ViewerSeconds float64Optional

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

Success boolOptional

Fetch livestream details using livestream ID

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.Livestreams.GetLivestreamSessionForLivestreamID(
    context.TODO(),
    "app_id",
    "livestream_id",
    realtime_kit.LivestreamGetLivestreamSessionForLivestreamIDParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 example

{
  "data": {
    "livestream": {
      "id": "id",
      "created_at": "created_at",
      "disabled": "disabled",
      "ingest_server": "ingest_server",
      "meeting_id": "meeting_id",
      "name": "name",
      "playback_url": "playback_url",
      "status": "LIVE",
      "stream_key": "stream_key",
      "updated_at": "updated_at"
    },
    "paging": {
      "end_offset": 1,
      "start_offset": 1,
      "total_count": 1
    },
    "session": {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "err_message": "err_message",
      "ingest_seconds": 0,
      "invoked_time": "2019-12-27T18:11:19.117Z",
      "livestream_id": "livestream_id",
      "started_time": "2019-12-27T18:11:19.117Z",
      "stopped_time": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "viewer_seconds": 0
    }
  },
  "success": true
}

Returns Examples

200 example

{
  "data": {
    "livestream": {
      "id": "id",
      "created_at": "created_at",
      "disabled": "disabled",
      "ingest_server": "ingest_server",
      "meeting_id": "meeting_id",
      "name": "name",
      "playback_url": "playback_url",
      "status": "LIVE",
      "stream_key": "stream_key",
      "updated_at": "updated_at"
    },
    "paging": {
      "end_offset": 1,
      "start_offset": 1,
      "total_count": 1
    },
    "session": {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "err_message": "err_message",
      "ingest_seconds": 0,
      "invoked_time": "2019-12-27T18:11:19.117Z",
      "livestream_id": "livestream_id",
      "started_time": "2019-12-27T18:11:19.117Z",
      "stopped_time": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "viewer_seconds": 0
    }
  },
  "success": true
}