How it Works

The Outbound API uses HTTP or HTTPS POST requests supplying a specific set of JSON as described here JSON Request Format.

The POST request has to be sent to:

http://<brm>:<port>/api/v1/bvr/outbound

or

https://<brm>:<port>/api/v1/bvr/outbound

Where <brm> is the address of the BRM machine and <port> is the HTTP or HTTPS port configured in BRM here: HTTP API Configuration Options.

The Outbound API supports either:

  1. Making an outbound call and then passing control to a VXML or CCXML applications.
  2. Invoking a CCXML application and not making an outbound call.

The second option allows finer control of the outbound call, including use of the Call Progress Detection functionality: Call Progress Detection

The application to invoke or start is identified in the JSON by the use of a unique key. These keys have to be defined, prior to using the API, and assigned to an application using BAM as described here: BAM Command Line Utility HTTP API Keys Panel

Outbound calls can also be controlled using an allow/deny list to specificall allow or deny certain phone numbers in the platform. All phone numbers are allowed by default.

For further details see here: BAM Command Line Utility Outbound Allow/Deny List Panel

The Outbound API also supports a status request to determine if the API is available on the BRM or not.

The availability of the HTTP API can be checked by sending a request to

http://<brm>:<port>/api/v1/bvr/status

or

https://<brm>:<port>/api/v1/bvr/status

If the request is accepted and BRM is running a 200 OK response will be returned.