How it Works

The Outbound API uses HTTP or HTTPS with a GET or POST request.

The GET/POST request has to be sent to:

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

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.

When using a GET request the attributes are passed as part of the URI. This takes the form of:

http://<brm>:<port>/api/v1/bvr/outbound?action=<action>&to=<to>&apiKey=<apiKey>&callerId=<callerId>&<name>=<value>&headers:<header_name>=<header_value>&hints:<hint_name>=<hint_value>

<action> is either makeCall or startApplication.
<to> is the destination to call, this is mandatory for makeCall.
<apiKey> is the configured API key for the application.
<callerId> is an optional callerId presented in the SIP From header.
<name> and <value> are name/value pairs that are passed to the application as application data.
<header_name> and <header_value> are SIP header/value pairs that are passed in the SIP INVITE. This entry must be prefixed with headers:
<hint_name> and <hint_value> are BVR specific name/value hints pairs that are passed to outbound make call processor. This entry must be prefixed with hints:

When using a POST request the content must contain a specific set of JSON as described here JSON Request Format.

A From header can be supplied as one of the SIP header/value pairs. If supplied this must be a fully formed SIP header, for example sip:user@mymachine.

The callerId and From header/value pair interact with the SIP From header with the following precedence

From header in custom headers in SIP proxy
Caller id in SIP proxy
Outbound API From header/value pair
Outbound API caller id
Configuration caller id
"bvr" if none of the above are used

The Outbound API supports either:

Making an outbound call and then passing control to a VXML or CCXML applications.
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