Livestreams

Create an independent livestream

POST/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Fetch all livestreams

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

Stop livestreaming a meeting

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop

Start livestreaming a meeting

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams

Fetch complete analytics data for your livestreams

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall

Fetch day-wise session and recording analytics data for an App

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise

Fetch active livestreams for a meeting

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

Fetch livestream session details using livestream session ID

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}

Fetch active livestream session details

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

Fetch livestream details using livestream ID

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

ModelsExpand Collapse

LivestreamCreateIndependentLivestreamResponse = object { data, success }

data: optional object { id, disabled, ingest_server, 5 more }

id: optional string

The livestream ID.

disabled: optional boolean

Specifies if the livestream was disabled.

ingest_server: optional string

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

meeting_id: optional string

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

success: optional boolean

LivestreamGetAllLivestreamsResponse = object { data, success }

data: optional object { id, created_at, disabled, 8 more }

id: optional string

The ID of the livestream.

formatuuid

created_at: optional string

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

formatdate-time

disabled: optional string

Specifies if the livestream was disabled.

ingest_server: optional string

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

meeting_id: optional string

ID of the meeting.

Name of the livestream.

paging: optional object { end_offset, start_offset, total_count }

end_offset: optional number

start_offset: optional number

total_count: optional number

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

updated_at: optional string

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

formatdate-time

success: optional boolean

LivestreamStopLivestreamingAMeetingResponse = object { data, success }

data: optional object { message }

message: optional string

success: optional boolean

LivestreamStartLivestreamingAMeetingResponse = object { data, success }

data: optional object { id, ingest_server, playback_url, 2 more }

id: optional string

The livestream ID.

ingest_server: optional string

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

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

success: optional boolean

LivestreamGetLivestreamAnalyticsCompleteResponse = object { data, success }

data: optional object { count, total_ingest_seconds, total_viewer_seconds }

Count of total livestreams.

total_ingest_seconds: optional number

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

total_viewer_seconds: optional number

Total view time for which the viewers watched the stream.

success: optional boolean

LivestreamGetOrgAnalyticsResponse = object { data, success }

data: optional object { recording_stats, session_stats }

recording_stats: optional object { day_stats, recording_count, recording_minutes_consumed }

Recording statistics of an App during the range specified

day_stats: optional array of object { day, total_recording_minutes, total_recordings }

Day wise recording stats

day: optional string

total_recording_minutes: optional number

Total recording minutes for a specific day

total_recordings: optional number

Total number of recordings for a specific day

recording_count: optional number

Total number of recordings during the range specified

recording_minutes_consumed: optional number

Total recording minutes during the range specified

session_stats: optional object { day_stats, sessions_count, sessions_minutes_consumed }

Session statistics of an App during the range specified

day_stats: optional array of object { day, total_session_minutes, total_sessions }

Day wise session stats

day: optional string

total_session_minutes: optional number

Total session minutes for a specific day

total_sessions: optional number

Total number of sessions for a specific day

sessions_count: optional number

Total number of sessions during the range specified

sessions_minutes_consumed: optional number

Total session minutes during the range specified

success: optional boolean

LivestreamGetMeetingActiveLivestreamsResponse = object { data, success }

data: optional object { id, created_at, disabled, 7 more }

id: optional string

The livestream ID.

created_at: optional string

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

formatdate-time

disabled: optional string

Specifies if the livestream was disabled.

ingest_server: optional string

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

meeting_id: optional string

Name of the livestream.

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

updated_at: optional string

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

formatdate-time

success: optional boolean

LivestreamGetLivestreamSessionDetailsForSessionIDResponse = object { data, success }

data: optional object { id, created_at, err_message, 6 more }

id: optional string

The livestream ID.

created_at: optional string

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

formatdate-time

err_message: optional string

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

ingest_seconds: optional number

Name of the livestream.

livestream_id: optional string

started_time: optional string

Unique key for accessing each livestream.

stopped_time: optional string

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

updated_at: optional string

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

viewer_seconds: optional number

Specifies if the livestream was disabled.

success: optional boolean

LivestreamGetActiveLivestreamsForLivestreamIDResponse = object { data, success }

data: optional object { livestream, session }

livestream: optional object { id, created_at, disabled, 7 more }

id: optional string

created_at: optional string

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

formatdate-time

disabled: optional string

Specifies if the livestream was disabled.

ingest_server: optional string

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

meeting_id: optional string

ID of the meeting.

Name of the livestream.

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

updated_at: optional string

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

formatdate-time

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

id: optional string

created_at: optional string

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

formatdate-time

err_message: optional string

ingest_seconds: optional string

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

invoked_time: optional string

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

formatdate-time

livestream_id: optional string

started_time: optional string

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

formatdate-time

stopped_time: optional string

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

formatdate-time

updated_at: optional string

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

formatdate-time

viewer_seconds: optional string

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

success: optional boolean

LivestreamGetLivestreamSessionForLivestreamIDResponse = object { data, success }

data: optional object { livestream, paging, session }

livestream: optional object { id, created_at, disabled, 7 more }

id: optional string

ID of the livestream.

created_at: optional string

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

disabled: optional string

Specifies if the livestream was disabled.

ingest_server: optional string

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

meeting_id: optional string

The ID of the meeting.

Name of the livestream.

playback_url: optional string

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

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key: optional string

Unique key for accessing each livestream.

updated_at: optional string

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

paging: optional object { end_offset, start_offset, total_count }

end_offset: optional number

start_offset: optional number

total_count: optional number

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

id: optional string

ID of the session.

created_at: optional string

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

formatdate-time

err_message: optional string

ingest_seconds: optional number

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

invoked_time: optional string

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

formatdate-time

livestream_id: optional string

started_time: optional string

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

formatdate-time

stopped_time: optional string

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

formatdate-time

updated_at: optional string

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

formatdate-time

viewer_seconds: optional number

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

success: optional boolean