Q&A Initialization
Initialization
GET https://api.video.ibm.com/channels/{channelId}/qna.json
Success response
Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the qna
root object.
KEY | TYPE | DESCRIPTION |
---|---|---|
stream_data | object | Data for connect |
stream_data .api_base_url | string | Service base url |
stream_data .api_key | string | Api key for the service |
stream_data .channel_id | string | Channel id for the connection |
stream_data .channel_type | string | Channel type |
stream_data .team | string | Team identifier |
user | object | User related data |
user .default_name | string¦null | Default name based on the token |
user .id | string | User identifier |
user .has_verified_user | boolean | Is the user known based on the access token or generated randomly |
user .token | string | Token for the service |
Example of a success response:
{"qna": {"stream_data": {"api_base_url": "https://chat-proxy-us-east.stream-io-api.com","api_key": "abc123","channel_id": "qna_12345678","channel_type": "qna","team": "team_12345678"},
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 |
402 Payment Required | invalid_request | The user does not have the streamqna benefit |
404 Not Found | not_found | Channel not found |
503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |