Outbound Calls

🚧

Comply with your local regulations regarding automated calls

In many regions, it is a violation of law to create automated outbound calls without consent. This may lead to your Twilio number or account being suspended and potentially incur fines.

• Twilio Phone Number Regulations
• Twilio Voice Guidelines

📘

Alpha Version

Outbound calls are currently in an alpha version and the API endpoint, /v1alpha1/ may be subject to change during development.

By calling an API endpoint, your Voiceflow agent will initiate a call with a provided outbound number. This is powerful when used with scripts, or automation tools like zapier to trigger upon external events (i.e. when a user signs up, send an outbound call).

Under Integration > Telephony after assigning a number to an agent, you can "View" the outbound call API for that number. Each assigned number will have a unique API URL, corresponding to their internal ID.

The API is presented in a curl format. It must include an Authorization header with the associated API Key of the agent. This is under Integration > API Keys

API Information

POST https://runtime-api.voiceflow.com/v1alpha1/phone-number/<PHONE_NUMBER_ID>/outbound

Headers

• Authorization: <DM API Key>

Body

{
  "to": string,
  "variables": {} // object containing any voiceflow variables you want to assign during launch
}

You can use the variables property in the body of the request to provide additional context or metadata about the particular user the call is being made to.

The number of outbound calls you can make concurrently is limited by your plan and is in a shared pool with inbound calls.