SIGN UP

HTTP Control API is now available

HTTP Control API is now available

Most of the apps built using VoxImplant have some client application that uses our Web or Mobile SDK , or other type of the endpoint communicating with VoxImplant (like SIP client), but there are couple of scenarios when there is no client application involved. The most common one is callback scenario, when platform makes calls to different destination and join these calls while required. Or another one - automated notifications or surveys, when you want call to your customer and playback some important message or get the feedback.

We are happy to announce our new API available for VoxImplant developers that makes this scenarios possible and easy to implement. We call it Control API (since it's created for controlling sessions, unlike Provisioning API created to let you add/edit/delete different VoxImplant entities, like app Users, Rules, etc.). Description of the API is available here , "How To" is available at here. If you want you can easily implement REST API for calls on top of the Control API platforms like Twilio or Plivo offer, but you can make even more interesting things using it, since you can control your javascript app running in the VoxImplant Cloud and even transfer data in POST body. Here is how it works:

  1. Developer makes HTTP request to Voximplant Cloud using StartScenarios function of HTTP API specifying rule_id. Rule_id is the identifier of some Rule in one of your applications. You can obtain it by calling GetRules function of HTTP API.
  2. Session is created in the cloud and AppEvents.Started event is dispatched in your scenario. You can start making calls in the event handler or after the event was dispatched.
  3. media_session_access_url is returned in response to let developer control the created session.
  4. When developer makes HTTP request to media_session_access_url AppEvents.HttpRequest event is dispatched in the scenario. Developer can process it and return some data right away or use httpRequest to notify external webservice about some event that can happen later.

We are going to prepare some tutorials in addition to How To to let you see how fast and easy you can implement different scenarios using HTTP Control API.

Tags:voximplanthttpapicontrolcallbacksurveysnotifications
B6A24216-9891-45D1-9D1D-E7359CEB8282 Created with sketchtool.

Comments(0)

Add your comment

Please complete this field.

Recommended

Get your free developer account or talk with our sales team to learn more about Voximplant solutions
SIGN UP