Page History: LiveManagementService 1.0 Home
Compare Page Revisions
Page Revision: 2017/04/01 12:39
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
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
start
Start a Webcast.
Request Method
POST
Path
"webcast/" + webcastId + "/start"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request
stop
Stop a Webcast.
Request Method
POST
Path
"webcast/" + webcastId + "/stop"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request
activate
Activates a Resource.
Request Method
POST
Path
"webcast/" + webcastId + "/" + resourceType + "/" + resourceId + "/activate"
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
Request
request
Something something.
Request Method
POST
Path
"webcast/" + webcastId + "/request/" + requestId
Required Request Headers
"Accept", "application/json"
"Authorization", token
Returns
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.
state
A string.
message
A string.
Token
token
A string.