Rate this page:

2. HTTP API – Starting and managing sessions

A Voximplant cloud JavaScript session can be started programmatically via the StartScenarios or StartConference method that accepts the Voximplant application rule identifier.

The rule identifier can be viewed in the Routing section inside each particular application:

Given the account ID, API key and rule ID, a request to start a new JavaScript scenario will look like this:

StartScenarios

StartScenarios

Scenarios started via the HTTP API can then initiate one or more outgoing calls; it's also possible to automate mass outbound calls via the CreateCallList method that accepts a list of data items and creates multiple JavaScript sessions in parallel, passing individual data items to sessions so JavaScript code can initiate calls to the specified numbers and use other data to process such calls.

The media_session_access_url is returned in response to let developer control the created session. When developer makes HTTP request to media_session_access_url, the AppEvents.HttpRequest event is triggered in the scenario. A developer can process it and return some data right away or use httpRequest to notify external webservice about some event that can happen later.