Creating an event

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

The parameters for the POST request:

PARAMETER	TYPE	IMPORTANCE	DESCRIPTION
`title`	string	REQUIRED	Event title
`description`	string	REQUIRED	Event description
`date`	string	REQUIRED	Date in YYYY-MM-DD format. e.g. 2020-07-31
`time`	string	REQUIRED	Time in HH:MM format. e.g. 16:50
`timezone`	string	REQUIRED	See supported timezones
`repeat`	string	OPTIONAL	One of “never”, “daily”, “weekly”. default “never”
`repeat_days`	string	OPTIONAL	Valid names: `"Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday"` Required if repeat is “weekly”, days MUST be separated by commas
`duration`	integer	REQUIRED	Event 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
Copy to clipboard

Possible error responses:

HTTP response code	Error Description
403	Resource ownership mismatch
404	Resource not found
429	Too many requests (Read more)

Listing Events

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

The query parameters for the Listing Events GET request:

PARAMETER	TYPE	IMPORTANCE	DESCRIPTION
`page`	integer	OPTIONAL	Requested page number (value is 1 by default)
`pagesize`	integer	OPTIONAL	Requested 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",
Copy to clipboard

Possible error responses:

HTTP response code	Error Description
403	Resource ownership mismatch
404	Resource not found
429	Too many requests (Read more)

Listing Specific Event

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

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,
Copy to clipboard

Possible error responses:

HTTP response code	Error Description
400	Field validation failed
403	Resource ownership mismatch
404	Resource not found
429	Too many requests (Read more)

Event deletion

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

Success response

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

Error responses

Possible error responses:

HTTP response code	Error Description
403	Resource ownership mismatch
404	Resource not found
429	Too many requests (Read more)

Updating an event

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

The parameters for the POST request:

PARAMETER	TYPE	IMPORTANCE	DESCRIPTION
`title`	string	REQUIRED	Event title
`description`	string	REQUIRED	Event description
`date`	string	REQUIRED	Date in YYYY-MM-DD format. e.g. 2020-07-31
`time`	string	REQUIRED	Time in HH:MM format. e.g. 16:50
`timezone`	string	REQUIRED	See supported timezones
`repeat`	string	OPTIONAL	One of “never”, “daily”, “weekly”. default “never”
`repeat_days`	string	OPTIONAL	Valid names: `"Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday"` Required if repeat is “weekly”, days MUST be separated by commas
`duration`	integer	REQUIRED	Event 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 code	Error Description
400	Field validation failed
403	Resource ownership mismatch
404	Resource not found
429	Too many requests (Read more)

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
Copy to clipboard

Parameters

The query parameters for the GET request:

PARAMETER	TYPE	IMPORTANCE	DESCRIPTION
`page`	integer	OPTIONAL	Requested page number (value is 1 by default)
`pagesize`	integer	OPTIONAL	Requested 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.

KEY	TYPE	DESCRIPTION
`id`	string	Unique ID of the event
`title`	string	Event title
`description`	string	Event description
`start`	number	The date and time when the event starts (Unix timestamp)
`duration`	number	Expected 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,
        },
Copy to clipboard

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"
  }
}
Copy to clipboard

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
404 Not Found	`not_found`	Channel was not found
503 Service Unavailable		There 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
Copy to clipboard

Edit this page on GitHub

IBM Captioning for Live Streaming

Virtual Events: Basics