GET /accounts/{account_id}/realtimekit/livestreams

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

Servers

Path parameters

Name Type Required Description
account_id String Yes

Query parameters

Name Type Required Description
sort_order String No

Specifies the sorting order for the results.

Valid values:

  • "ASC"
  • "DSC"
start_time String No

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

per_page Integer No

Number of results per page.

exclude_meetings Boolean No

Exclude the RealtimeKit meetings that are livestreamed.

Default value: false

status String No

Specifies the status of the operation.

Valid values:

  • "LIVE"
  • "IDLE"
  • "INVOKED"
  • "ERRORED"
page_no Integer No

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

end_time String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.