DYdyte-io
Live streams

Fetch all livestreams

Changed on

Returns details of livestreams associated with the given organization ID. It includes livestreams created by your organization and Dyte meetings that are livestreamed by your organization. If you only want details of livestreams created by your organization and not Dyte meetings, you can use the exclude_meetings query parameter.

get/livestreams

Request

  • Base URL
    https://api.dyte.io/v2
  • Auth
    HTTP basic

Query parameters

exclude_meetingsboolean

Exclude the Dyte meetings that are livestreamed.

per_pageinteger

Number of results per page.

page_nointeger

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

status'LIVE' | 'IDLE' | 'ERRORED' | 'INVOKED'

Specifies the status of the operation.

start_timestring date-time

Specify the start time range in ISO format to access the live stream.

end_timestring date-time

Specify the end time range in ISO format to access the live stream.

sort_order'ASC' | 'DSC'

Specifies the sorting order for the results.

Response

OK

successboolean

Example response

{
  "data": {
    "id": "3fd739f4-3c41-456e-bfba-6ebd51e16d2d",
    "name": "test",
    "ingest_server": "rtmps://2ec802dd47b0.global-contribute.live-video.net:443/app/",
    "stream_key": "sk_ap-south-1_fiETVh5SNa3V_MAs0NlNCkJqTokqrMbrdWyA2naII25",
    "playback_url": "https://2ec802dd47b0.ap-south-1.playback.live-video.net/api/video/v1/ap-south-1.944908621410.channel.mA2dNqrBulpi.m3u8",
    "created_at": "2023-07-15T11:48:34.753Z",
    "updated_at": "2023-07-15T11:48:34.753Z",
    "paging": {
      "total_count": 1,
      "start_offset": 1,
      "end_offset": 1
    }
  }
}

Changes

  • v2cb67ff854c71Revision changes
    • breaking

      the / response's property type changed from no type to string for status

    • info

      the endpoint scheme security Authorization was added to the API

  • v268b9e665bfccRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • info

      the endpoint scheme security Authorization was removed from the API