- Transfer Node
- REST API request:
Create Outbound Calls via API Request
Send an HTTP POST request to the Voice Gateway API to generate an outbound call. When the call is answered, the specified webhook will be invoked to manage the call. Authorization is established via a Bearer token. This token is filled with an API key value generated in the Voice Gateway Self-Service Portal.Request
Basic Configuration Request
The basic configuration provides details for initiating and managing calls, enabling the system to establish a connection between the caller and the callee. It also includes call duration, handling unanswered calls, and attaching relevant metadata.- cURL
- JSON
Advanced Configuration Request
The advanced configuration provides a range of features to enhance call handling and management. It includes notifications, interaction hooks, header manipulation and transcription capabilities. In the example below, we enable the Answering Machine Detection feature using theamd
parameter
and use the actionHook
parameter to send the events to the Webhook site.
Via timeout
, we define a maximum ringing time. If the call is not answered within this time, Voice Gateway stops calling (see the NO_ANSWER event).
We include tags in the tag
parameter to send custom information about the user,
such as a custom object, as well as headers
to send custom headers.
- cURL
- JSON
Response
The server responds with HTTP201
and provides the session identifier (sid
) of the outbound call session and the call identifier (callid
) of the INVITE
.
Use Cases
Use cases for creating outbound calls may vary. As examples, consider the following use cases:Transfer Calls
The voice agent orchestrates a transfer (outbound call) to the call center. Sequence of interactions:- A user initiates an inbound call.
- Voice Gateway passes the call to the voice agent.
- The voice agent initiates a transfer to the call center via Voice Gateway.
- The call center receives the transferred call.
Make Follow-up Calls
The voice agent triggers an outbound call to the user for follow-up purposes, for example, to provide additional troubleshooting steps, offer a resolution to the user issue, or follow up on their satisfaction with the support received. Sequence of interactions:- A user provides information during an inbound call to the voice agent.
- The voice agent triggers an outbound call to the user via a third-party service and Voice Gateway.
- The user receives the outbound call initiated by the voice agent.