List lives
GEThttps://api.one.blendvision.com/bv/cms/v1/lives
Lists Live
resources.
Request
Query Parameters
- LIST_LIVE_ORDER_BY_UPDATED_AT_ASC: Order by the updated time in ascending order.
- LIST_LIVE_ORDER_BY_UPDATED_AT_DESC: Order by the updated time in descending order.
- LIST_LIVE_ORDER_BY_STARTED_AT_ASC: Order by the started time in ascending order.
- LIST_LIVE_ORDER_BY_STARTED_AT_DESC: Order by the started time in descending order.
- LIST_LIVE_ORDER_BY_ENDED_AT_ASC: Order by the ended time in ascending order.
- LIST_LIVE_ORDER_BY_ENDED_AT_DESC: Order by the ended time in descending order.
- LIST_LIVE_ORDER_BY_VOD_STARTED_AT_ASC: Order by the vod started time in ascending order.
- LIST_LIVE_ORDER_BY_VOD_STARTED_AT_DESC: Order by the vod started time in descending order.
- LIST_LIVE_ORDER_BY_VOD_ENDED_AT_ASC: Order by the vod ended time in ascending order.
- LIST_LIVE_ORDER_BY_VOD_ENDED_AT_DESC: Order by the vod ended time in descending order.
Optional. Indicates the current page to shows. Default: 1.
Optional. Indicates the number of items to shows per page. Default: 1. Max: 100.
Optional. If set, filter with the lives which names contain the given string.
Possible values: [LIVE_STATUS_PREPARING
, LIVE_STATUS_SCHEDULED
, LIVE_STATUS_WAIT_FOR_PREVIEW
, LIVE_STATUS_INITIATING
, LIVE_STATUS_PREVIEW
, LIVE_STATUS_LIVE
, LIVE_STATUS_LIVE_END
, LIVE_STATUS_ENCODING
, LIVE_STATUS_VOD_READY
, LIVE_STATUS_VOD
, LIVE_STATUS_CLOSED
, LIVE_STATUS_CANCELING
, LIVE_STATUS_ARCHIVING
, LIVE_STATUS_ARCHIVED
, LIVE_STATUS_FAIL_TO_CREATE
, LIVE_STATUS_FAIL_TO_PREVIEW
, LIVE_STATUS_FAIL_TO_END
, LIVE_STATUS_FAIL_TO_VOD
, LIVE_STATUS_FAIL_TO_CANCEL
, LIVE_STATUS_FAIL_TO_ARCHIVE
]
Optional. If set, filter with the statuses.
Optional. If set, filter with the labels.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same or after the start.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the end.
Possible values: [LIST_LIVE_ORDER_BY_UPDATED_AT_ASC
, LIST_LIVE_ORDER_BY_UPDATED_AT_DESC
, LIST_LIVE_ORDER_BY_STARTED_AT_ASC
, LIST_LIVE_ORDER_BY_STARTED_AT_DESC
, LIST_LIVE_ORDER_BY_ENDED_AT_ASC
, LIST_LIVE_ORDER_BY_ENDED_AT_DESC
, LIST_LIVE_ORDER_BY_VOD_STARTED_AT_ASC
, LIST_LIVE_ORDER_BY_VOD_STARTED_AT_DESC
, LIST_LIVE_ORDER_BY_VOD_ENDED_AT_ASC
, LIST_LIVE_ORDER_BY_VOD_ENDED_AT_DESC
]
Optional. Indicates the order of the results.
Header Parameters
To invoke this API using api_token
, you need to set the x-bv-org-id
header to specify the organization for which you want to perform the action.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
lives object[]
pagination object
{
"lives": [
{
"broadcast_mode": "BROADCAST_MODE_TRADITIONAL_LIVE",
"cover_images": {
"close": null,
"current": null,
"end": null,
"player_pause": null,
"preview": null,
"ready_to_start": null,
"signal_interruption": null
},
"created_at": "2023-05-31T06:53:43Z",
"error_infos": [],
"id": "860d49b8-2ca8-4030-b5ff-f6ec3a1c6196",
"ingest_types": [
"LIVE_STREAM_INGEST_TYPE_RTMP"
],
"interaction": {
"chatroom": {
"live": {
"enabled": false,
"theme": "CHATROOM_THEME_UNSPECIFIED"
},
"vod": {
"enabled": false,
"theme": "CHATROOM_THEME_UNSPECIFIED"
}
},
"event_id": "",
"poll_enabled": false
},
"labels": [],
"name": "Amazing Live",
"resolution": "LIVE_RESOLUTION_HD",
"save_for_download_enabled": false,
"security": {
"domain_control": {
"domains": [],
"enabled": false
},
"geo_control": [],
"privacy": {
"token": null,
"type": "SECURITY_PRIVACY_TYPE_PUBLIC"
},
"protection": {
"type": "PROTECTION_TYPE_UNSPECIFIED"
},
"watermark": {
"enabled": false,
"position": "WATERMARK_POSITION_UNSPECIFIED",
"type": "WATERMARK_TYPE_UNSPECIFIED"
}
},
"setup": null,
"source": null,
"status": "LIVE_STATUS_WAIT_FOR_PREVIEW",
"stream": [],
"type": "LIVE_TYPE_LIVE",
"ull_enabled": false,
"updated_at": "2023-05-31T06:55:46Z"
}
],
"pagination": {
"current_page": 1,
"items_per_page": 1,
"total_items": 84
}
}
A bad request response.
The code
is 3
means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: authorization
name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
- curl
- python
- go
- nodejs
- php
- CURL
curl -L 'https://api.one.blendvision.com/bv/cms/v1/lives' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>'