Live Stream

GET /v1/live-streams

Retrieves a paginated list of live streams.

Name	Located in	Description	Required	Type
Name	query	Optional. Filter live streams by name.	No	string
CategoryId	query	Optional. Filter live streams by a list of category IDs.	No	integer
BundleId	query	Optional. Filter live streams associated with a specific bundle ID.	No	integer
TypeId	query	Optional. Filter live streams by types.	No	integer
SortBy	query	Optional. Sort live streams by specified field. Use 'name' for ascending or 'name_desc' for descending order by name. Defaults to ascending order by ID if not specified.	No	string
Include	query	Optional. The related data to include. Possible value is `categories`.	No	string
Page	query	Page number to retrieve. Default is 1.	No	integer
PageSize	query	Number of records per page. Default is 25.	No	integer

Code	Description
200	Success

Retrieves a live stream by ID.

Name	Located in	Description	Required	Type
id	path	The ID of the live stream to retrieve.	Yes	integer
include	query	The related data to include. Possible value is `categories`.	No	string

Code	Description
200	Success
422	Validation error if the input parameters are incorrect.

Retrieves a paginated list of live stream categories.

Name	Located in	Description	Required	Type
Page	query	Page number to retrieve. Default is 1.	No	integer
PageSize	query	Number of records per page. Default is 25.	No	integer

Code	Description
200	Success

Retrieves a list of live stream types.

Code	Description
200	Success

Retrieves URLs for accessing live streams.

{
  "streamId": 0,
  "subscriberId": 0,
  "https": true
}

Code	Description
200	Success
422	Validation error if the input parameters are incorrect.