You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/calls/call-outbound.mdx
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
## Introduction to Outbound Calling
2
2
3
-
Vapi provides robust support for outbound calling, enabling programmatic initiation of calls to phone numbers. Through Vapi's outbound calling API, you can initiate both single and batch outbound calls to any phone number. For time-sensitive communications, you can schedule calls for future execution at specific dates and times. The platform provides comprehensive monitoring capabilities, allowing you to track call status in real-time and collect detailed analytics about your calling operations. Just like inbound calls, outbound calls support recording and automatic transcription, providing complete access to call content and conversation history.
4
-
5
-
Whether you're implementing appointment reminders, automated surveys, or outbound call campaigns, Vapi's API enables straightforward integration of outbound calling functionality into your applications.
3
+
Vapi’s outbound calling API lets you programmatically initiate single or batch calls to any phone number. You can schedule calls for specific dates and times, ideal for time-sensitive communications. Easily integrate outbound calling into your app for appointment reminders, automated surveys, and call campaigns.
6
4
7
5
## Prerequisites
8
6
@@ -17,20 +15,20 @@ You can place an outbound call from one of your phone numbers using the [`/call`
17
15
18
16
1.**Specify an Assistant:** you must specify either a transient assistant in the `assistant` field or reuse a saved assistant in the `assistantId` field.
19
17
2.**Get a Phone Number:** provide the `phoneNumberId` of the imported number or free Vapi number you wish to call from.
20
-
3.**Provide a Destination:** Finally, pass the customer's phone number or SIP URI in [`customer`](api-reference/calls/create#request.body.customer).
18
+
3.**Provide a Destination:** Finally, pass the customer's phone number or SIP URI in [`customer`](api-reference/calls/create-phone-call#request.body.customer).
21
19
22
20
Provide your authorization token and now we're ready to issue the API call!
23
21
24
22
## Scheduling Outbound Calls
25
23
26
-
To schedule a call for the future, use the [`schedulePlan`](api-reference/calls/create#request.body.schedulePlan) parameter and pass a future ISO date-time string to `earliestAt`. This will be the earliest time Vapi will attempt to trigger the outbound call. You may also provider `latestAt`, which will be the latest time Vapi will attempt to trigger the call.
24
+
To schedule a call for the future, use the [`schedulePlan`](api-reference/calls/create-phone-call#request.body.schedulePlan) parameter and pass a future ISO date-time string to `earliestAt`. This will be the earliest time Vapi will attempt to trigger the outbound call. You may also provider `latestAt`, which will be the latest time Vapi will attempt to trigger the call.
27
25
28
26
When you schedule a call, we will save the Assistant, Phone Number, and Customer Number resources and refetch them at the time of the call. If you choose to provide a saved assistant through `assistantId`, we will pick up the most up-to-date version of your assistant at the call time. Likewise, if you delete your saved assistant, the call will fail! To ensure the call is issued with a static version of an assistant, pass it as a transient assistant through the `assistant` parameter.
29
27
30
28
31
29
## Batch Calling
32
30
33
-
To call more than one number at a time, use the [`customers`](api-reference/calls/create#request.body.customers) parameter to pass an array of `customer`. To provide customer specific assistant overrides, please call the endpoint separately for each destination number.
31
+
To call more than one number at a time, use the [`customers`](api-reference/calls/create-phone-call#request.body.customers) parameter to pass an array of `customer`. To provide customer specific assistant overrides, please call the endpoint separately for each destination number.
34
32
35
33
Use both `customers` and `schedulePlan` together to schedule batched calls.
0 commit comments