Skip to content

Commit 0f11197

Browse files
committed
example
1 parent a0cb8a2 commit 0f11197

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

fern/calls/call-outbound.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,59 @@ You can place an outbound call from one of your phone numbers using the [`/call`
1919

2020
Provide your authorization token and now we're ready to issue the API call!
2121

22+
```jsx
23+
{
24+
"assistantId": "assistant-id",
25+
"phoneNumberId": "phone-number-id",
26+
"customer": {
27+
"number": "+11231231234"
28+
}
29+
}
30+
```
31+
2232
## Scheduling Outbound Calls
2333

2434
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.
2535

2636
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.
2737

38+
```jsx
39+
{
40+
"assistantId": "assistant-id",
41+
"phoneNumberId": "phone-number-id",
42+
"customer": {
43+
"number": "+11231231234"
44+
},
45+
"schedulePlan": {
46+
"earliestAt": "2025-05-30T00:00:00Z"
47+
}
48+
}
49+
```
2850

2951
## Batch Calling
3052

3153
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.
3254

3355
Use both `customers` and `schedulePlan` together to schedule batched calls.
3456

57+
```jsx
58+
{
59+
"assistantId": "assistant-id",
60+
"phoneNumberId": "phone-number-id",
61+
"customers": [
62+
{
63+
"number": "+11231231234"
64+
},
65+
{
66+
"number": "+12342342345"
67+
}
68+
],
69+
"schedulePlan": {
70+
"earliestAt": "2025-05-30T00:00:00Z"
71+
}
72+
}
73+
```
74+
3575
Note: Vapi free numbers have limited number of outbound calls per day. Import a number from Twilio, Vonage, or Telnyx to scale without limits.
3676

3777
<Warning>

0 commit comments

Comments
 (0)