Skip to main contentIBM Video Streaming Developers

Chat

Check chat is enabled

GET https://api.video.ibm.com/channels/{channelId}/settings/chat.json

Success response

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

KEYTYPEDESCRIPTION
enabledbooleanChat is enabled
is_default_interactive_modulebooleanChat is the default interactive module on the channel page

Example of a success response:

{
"enabled": true,
"is_default_interactive_module": false
}

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR VALUEERROR CONDITIONS
400 Bad Requestbad_requestInvalid value was supplied
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

Turn on/off chat

PUT https://api.video.ibm.com/channels/{channelId}/settings/chat.json

Parameters

KEYTYPEIMPORTANCEDESCRIPTION
enablestringREQUIREDtrue/false

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

Example of the request:

POST /channels/1234/settings/chat.json HTTP/1.1
Host: api.video.ibm.com
Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
Content-Type: application/x-www-form-urlencoded
enable=true

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
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