Skip to main contentIBM Video Streaming Developers

Events

Creating an event

POST https://api.video.ibm.com/v2/channels/CHANNEL_ID/events.json

The parameters for the POST request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
titlestringREQUIREDEvent title
descriptionstringREQUIREDEvent description
datestringREQUIREDDate in YYYY-MM-DD format. e.g. 2020-07-31
timestringREQUIREDTime in HH:MM format. e.g. 16:50
timezonestringREQUIREDSee supported timezones
repeatstringOPTIONALOne of “never”, “daily”, “weekly”. default “never”
repeat_daysstringOPTIONALValid names: "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday" Required if repeat is “weekly”, days MUST be separated by commas
durationintegerREQUIREDEvent duration in minutes. Valid values: 15, 30, 60, 90, 120, 180, 240

Success response of Creating an event:

HTTP/1.1 201 Created
Location: https://api.video.ibm.com/v2/channels/CHANNEL_ID/events/4552.json

Listing Events

GET https://api.video.ibm.com/v2/channels/CHANNEL_ID/events.json

The query parameters for the Listing Events GET request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
pageintegerOPTIONALRequested page number (value is 1 by default)
pagesizeintegerOPTIONALRequested page size (value is 20 by default)

Upon success a response with HTTP status “200 OK” is returned with the following response:

{
"events": [
{
"id": 4552,
"title": "All hands",
"description": "Company all hands meeting",
"date": "2020-07-31",
"time": "14:47",
"timezone": "Europe/Budapest",

Possible error responses:

HTTP response codeError Description
403Resource ownership mismatch
404Resource not found

Listing Specific Event

GET https://api.video.ibm.com/v2/channels/CHANNEL_ID/events/EVENT_ID.json

Upon success a response with HTTP status “200 OK” is returned with the following response:

{
"event": {
"id": 769115,
"title": "Test Event Title",
"description": "Desc",
"date": "2020-12-09",
"time": "16:28",
"timezone": "Indian/Cocos",
"start_ts": 1607531280,

Event deletion

DELETE https://api.video.ibm.com/v2/channels/CHANNEL_ID/events/EVENT_ID.json

Success response

Upon success a response with HTTP status “200 OK” is returned.

Error responses

Possible error responses:

HTTP response codeError Description
403Resource ownership mismatch
404Resource not found

Updating an event

PUT https://api.video.ibm.com/v2/channels/CHANNEL_ID/events/EVENT_ID.json

The parameters for the POST request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
titlestringREQUIREDEvent title
descriptionstringREQUIREDEvent description
datestringREQUIREDDate in YYYY-MM-DD format. e.g. 2020-07-31
timestringREQUIREDTime in HH:MM format. e.g. 16:50
timezonestringREQUIREDSee supported timezones
repeatstringOPTIONALOne of “never”, “daily”, “weekly”. default “never”
repeat_daysstringOPTIONALValid names: "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday" Required if repeat is “weekly”, days MUST be separated by commas
durationintegerREQUIREDEvent duration in minutes. Valid values: 15, 30, 60, 90, 120, 180, 240

Success response

Upon success a response with HTTP status “200 OK” is returned.

Error responses

Possible error responses:

HTTP response codeError Description
400Field validation failed
403Resource ownership mismatch
404Resource not found

Get list of upcoming events on a channel

Returns data of upcoming events on a channel.

GET https://api.video.ibm.com/channels/{channel_id}/upcoming-events.json

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCEDESCRIPTION
pageintegerOPTIONALRequested page number (value is 1 by default)
pagesizeintegerOPTIONALRequested page size (value is 50 by default, max. 50)

Success response

Upon success a response with HTTP status “200 OK” is returned with the following key-value pairs under an events key.

KEYTYPEDESCRIPTION
idstringUnique ID of the event
titlestringEvent title
descriptionstringEvent description
startnumberThe date and time when the event starts (Unix timestamp)
durationnumberExpected duration of the event in seconds

Example of a success response:

{
"events": [
{
"id": "111",
"title": "Title of the event",
"description": "Description of the event",
"start": 1399388736,
"duration": 900,
},

The paging information can be found under the paging key. Example:

{
"paging": {
"previous": "https://api.video.ibm.com/CHANNEL_ID/upcoming-events.json?pagesize=PAGE_SIZE&page=PREVIOUS_PAGE",
"next": "https://api.video.ibm.com/channels/CHANNEL_ID/upcoming-events.json?pagesize=PAGE_SIZE&page=NEXT_PAGE"
}
}

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
404 Not Foundnot_foundChannel was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

List of supported time zones

Africa/Abidjan
Africa/Accra
Africa/Addis_Ababa
Africa/Algiers
Africa/Asmara
Africa/Asmera
Africa/Bamako
Africa/Bangui
Africa/Banjul