Getting Started with 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.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
enabled | boolean | Chat is enabled |
is_default_interactive_module | boolean | Chat 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 CODE | ERROR VALUE | ERROR CONDITIONS |
|---|---|---|
| 400 Bad Request | bad_request | Invalid value was supplied |
| 401 Unauthorized | invalid_token | The provided access token is missing, revoked, expired or malformed |
| 403 Unauthorized | lack_of_ownership | The provided access token could not access the given channel |
| 503 Service Unavailable | There 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
| KEY | TYPE | IMPORTANCE | DESCRIPTION |
|---|---|---|---|
enable | string | REQUIRED | true/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.1Host: api.video.ibm.comAuthorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950Content-Type: application/x-www-form-urlencodedenable=true
Success response
Upon success the response body is empty with an HTTP Status code of 204.
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 |
| 403 Unauthorized | lack_of_ownership | The provided access token could not access the given channel |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |