Page History: LiveManagementService 1.0 Home
Compare Page Revisions
Page Revision: 2017/04/01 20:12
Live Management Service 1.0
The Company Webcast Live Management Service is a REST service that can be used to Start and Stop a Live Webcast, as well as activate and de-activate resources such as topics and speakers.
Methods
Live Management Service is a REST service, meaning you interact with it through regular web requests such as GET and POST.
For each Method below, a description is given of how to craft the web request, and what the response will be.
URIs to individual Methods are assembled like this:
"https://6slhrilj6k.execute-api.eu-west-1.amazonaws.com/development/" + Path
hasstream
Determines whether a Webcast has an active stream.
Webcasts without an active stream cannot be started or stopped.
Request Method
GET
Path
"webcast/" + webcastId + "/hasstream"
Required Request Headers
"Accept", "application/json"
Returns
Boolean. True if the stream is available, false if it's not.
authorize
Use your API credentials to retrieve a token.
You'll need this token for further interaction with Live Management Service.
Request Method
POST
Path
"webcast/" + webcastId + "/authorize"
Required Request Headers
"Accept", "application/json"
"Content-Type", "application/json"
Post Data
Credentials
Returns
Token. Contains an authorization token.
start
Start a Webcast.
An authorization token, retrieved through the
authorize Method, needs to be included in the request.
Request Method
POST
Path
"webcast/" + webcastId + "/start"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request. An object that describes the state of this Method request. Use it here to retrieve the Request Id.
stop
Stop a Webcast.
An authorization token, retrieved through the
authorize Method, needs to be included in the request.
Request Method
POST
Path
"webcast/" + webcastId + "/stop"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request. An object that describes the state of this Method request. Use it here to retrieve the Request Id.
activate
Activates a Resource.
An authorization token, retrieved through the
authorize Method, needs to be included in the request.
Request Method
POST
Path
"webcast/" + webcastId + "/" + resourceType + "/" + resourceId + "/activate"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request. An object that describes the state of this Method request. Use it here to retrieve the Request Id.
request
Retrieves the state of a Request.
As most Methods of this service are asynchronous, this Method enables state monitoring of individual Method requests.
An authorization token, retrieved through the
authorize Method, needs to be included in the request.
Request Method
POST
Path
"webcast/" + webcastId + "/request/" + requestId
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request. An object that describes the state of the Method request. Use it here to retrieve state of a Method request.
Data Types
Credentials
username
A string. Your Company Webcast provided API username
password
A string. Your Company Webcast provided API password
Request
id
A string. The id of the Request.
intent
A string. Describes the intent of the Method request.
Is either "request.webcast.start", "request.webcast.stop" or "request.webcast.resource.activate".
state
A string. Describes the state of the Method request.
Is "created" immediatelly after the Method request, then either "success" or "error".
message
A string. When state equals "error", message describes the error.
Token
token
A string.