メインコンテンツまでスキップ

VOD Assets

To retrieve a list of VODs based on specific criteria, you can send a GET request to the following API:

GET /bv/cms/v1/vods

The available query parameters are:

FilterTypeDescription
current_pageintegerThe current page number of the pagination. The default value is 1.
filter.namestringThe value to filter VODs by name. The API returns only VODs that match the specified name.
filter.statusstringThe value to filter VODs by status. The API returns only the VODs that match the specified status.
items_per_pageintegerThe number of items to return per page. The default value is 10.

The possible VOD statuses are:

  • VOD_STATUS_CREATED
  • VOD_STATUS_INGESTED
  • VOD_STATUS_QUEUED
  • VOD_STATUS_ENCODED
  • VOD_STATUS_DEPLOYED
  • VOD_STATUS_SUCCEEDED
  • VOD_STATUS_FAILED
  • VOD_STATUS_CANCELLED
  • VOD_STATUS_DELETED

Here's an example of querying with the name "VOD_NAME" and status VOD_STATUS_CREATED, with 10 items per page:

/bv/cms/v1/vod?filter.name=VOD_NAME&filter.status=VOD_STATUS_CREATED&items_per_page=10