Skip to main contentIBM Video Streaming Developers

Manage selected videos

Get Selected Videos

Returns the currently select videos on a channel.

GET https://api.video.ibm.com/channels/{channelId}/settings/off-air/selected.json

Success response

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

KEYTYPEDESCRIPTION
videosint[]Selected video ids

Example of a success response:

{
  "videos": [
    54321,
    64321
  ]
}

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Set Selected Videos

PUT https://api.video.ibm.com/channels/{channelId}/settings/off-air/selected.json

Parameters

KEYTYPEIMPORTANCEDESCRIPTION
videosint[]REQUIREDVideo ids (only published videos allowed)

The Content-Type of the request should be application/x-www-form-urlencoded.

Example of the request:

PUT /channels/1234/settings/off-air/selected.json HTTP/1.1
Host: api.video.ibm.com
Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
Content-Type: application/x-www-form-urlencoded


videos[]=123979122&videos[]=124044209&videos[]=128385174&videos[]=12344321

Note that the token in the above call is only an example.

Success response

Upon success the response body is empty with an HTTP Status code of 204.

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
400 Bad Requestbad_requestInvalid videos (eg. one of the videos is not on the channel or it is not published)
401 Unauthorizedinvalid_tokenThe provided access token is missing, revoked, expired or malformed
403 Unauthorizedlack_of_ownershipThe provided access token could not access the given channel
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request
Edit this page on GitHub
Previous
Off Air Settings: Overview
Next
Off Air Settings: Manage slideshow