Skip to content

Commit 8ff1b16

Browse files
docs: free telephony (#190)
1 parent 388f875 commit 8ff1b16

File tree

12 files changed

+37
-45
lines changed

12 files changed

+37
-45
lines changed

fern/examples/inbound-support.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,14 @@ As a bonus, we also want the assistant to remember by the phone number of the ca
5151
For this example, we're going to store the conversation on our server between calls and use the [Server URL's `assistant-request`](/server-url#retrieving-assistants) to fetch a new configuration based on the caller every time someone calls.
5252

5353
</Step>
54-
<Step title="Buy a phone number">
55-
We'll buy a phone number for inbound calls using the [Phone Numbers API](/api-reference/phone-numbers/buy-phone-number).
54+
<Step title="Create a phone number">
55+
We'll create a phone number for inbound calls using the [Phone Numbers API](/api-reference/phone-numbers/create).
5656

5757
```json
5858
{
5959
"id": "c86b5177-5cd8-447f-9013-99e307a8a7bb",
6060
"orgId": "aa4c36ba-db21-4ce0-9c6e-99e307a8a7bb",
61+
"provider": "vapi",
6162
"number": "+11234567890",
6263
"createdAt": "2023-09-29T21:44:37.946Z",
6364
"updatedAt": "2023-12-08T00:57:24.706Z",

fern/examples/outbound-sales.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,14 @@ We want this agent to be able to call a list of leads and schedule appointments.
7272
We'll then make a POST request to the [Create Assistant](/api-reference/assistants/create-assistant) endpoint to create the assistant.
7373

7474
</Step>
75-
<Step title="Buy a phone number">
76-
We'll buy a phone number for outbound calls using the [Phone Numbers API](/phone-calling#set-up-a-phone-number).
75+
<Step title="Create a phone number">
76+
We'll create a phone number for outbound calls using the [Phone Numbers API](/phone-calling#set-up-a-phone-number).
7777

7878
```json
7979
{
8080
"id": "c86b5177-5cd8-447f-9013-99e307a8a7bb",
8181
"orgId": "aa4c36ba-db21-4ce0-9c6e-99e307a8a7bb",
82+
"provider": "vapi",
8283
"number": "+11234567890",
8384
"createdAt": "2023-09-29T21:44:37.946Z",
8485
"updatedAt": "2023-12-08T00:57:24.706Z",

fern/phone-calling.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ slug: phone-calling
77

88

99
<Accordion title="Set up a Phone Number">
10-
You can set up a phone number to place and receive phone calls. Phone numbers can be bought directly through Vapi, or you can use your own from Twilio.
10+
You can set up a phone number to place and receive phone calls. Phone numbers can be created directly through Vapi, or you can use your own from Twilio.
1111

12-
You can buy a phone number through the dashboard or use the [`/phone-numbers/buy`](/api-reference/phone-numbers/buy-phone-number)` endpoint.
12+
You can create a free phone number through the dashboard or use the [`/phone-numbers`](/api-reference/phone-numbers/create) endpoint.
1313

1414
If you want to use your own phone number, you can also use the dashboard or the [`/phone-numbers/import`](/api-reference/phone-numbers/import-twilio-number) endpoint. This will use your Twilio credentials to verify the number and configure it with Vapi services.
1515

fern/pricing.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,6 @@ slug: pricing
3131
>
3232
Bring your own API keys for providers, Vapi makes requests on your behalf.
3333
</Card>
34-
<Card
35-
title="$2/mo for Phone Numbers"
36-
icon="phone-office"
37-
iconType="solid"
38-
color="#fcba03"
39-
>
40-
Phone numbers purchased through Vapi bill at $2/mo.
41-
</Card>
4234
</CardGroup>
4335

4436
### Starter Credits

fern/quickstart/inbound.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ An inbound call is a phone call that comes **"in"** towards a phone number, & in
2222
There are **4 steps** we will cover to handle our first inbound phone call:
2323

2424
1. **Create an Assistant:** we will create an [assistant](/assistants) & instruct it on how to conduct the call
25-
2. **Get a Phone Number:** we can either import existing numbers we own, or purchase one through Vapi
25+
2. **Get a Phone Number:** we can either import existing numbers we own, or create a free one through Vapi
2626
3. **Attach Our Assistant:** we will put our assistant behind the phone number to pick up calls
2727
4. **Call the Number:** we can then call the number & talk to our assistant
2828

fern/quickstart/outbound.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ An outbound call is a phone call that is dialed and goes **"out"** from a phone
2222
There are **3 steps** we will cover to send our first outbound phone call:
2323

2424
1. **Create an Assistant:** we will create an [assistant](/assistants) & instruct it on how to conduct itself during the call
25-
2. **Get a Phone Number:** we can either import existing numbers we own, or purchase one through Vapi
25+
2. **Get a Phone Number:** we can either import existing numbers we own, or create a free one through Vapi
2626
3. **Call Your Number:** we will set our assistant as the dialer, set the destination phone number, then make the call
2727

2828
We can then send the outbound call, hopefully someone picks up!

fern/server-url/setting-server-urls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Here's a breakdown of where you can set server URLs in Vapi:
3939
Phone numbers can have a server URL attached to them via the [phone number API](/api-reference/phone-numbers).
4040

4141
The server URL for phone numbers can be set **3 ways**:
42-
- **At Time of Purchase:** when you [buy a number](/api-reference/phone-numbers/buy-phone-number) through Vapi
42+
- **At Time of Creation:** when you [create a free number](/api-reference/phone-numbers/create) through Vapi
4343
- **At Import:** when you [import from Twilio](/api-reference/phone-numbers/import-twilio-number) or [Vonage](/api-reference/phone-numbers/import-vonage-number)
4444
- **Via Update:** you can [update a number](/api-reference/phone-numbers/update-phone-number) already in your account
4545

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
The quickest way to secure a phone number for your assistant is to purchase a phone number directly through Vapi.
1+
The quickest way to secure a phone number for your assistant is to create a phone number directly through Vapi.
22

3-
<Info>
4-
Ensure you have a card on file that Vapi can bill before proceeding, you can add your billing
5-
information in your dashboard at [dashboard.vapi.ai/billing](https://dashboard.vapi.ai/billing)
6-
</Info>
7-
8-
Navigate to the "Phone Numbers" section & click the "Buy number" button:
3+
Navigate to the "Phone Numbers" section & click the "Create Phone Number" button:
94

105
<Frame caption="Make sure you are in the 'Phone Numbers' dashboard tab.">
11-
<img src="/static/images/quickstart/dashboard/buy-a-phone-number.png" />
6+
<img src="/static/images/quickstart/dashboard/create-vapi-phone-number.png" />
127
</Frame>
138

149
We will use the area code `415` for our phone number (these are area codes domestic to the US & Canada).
1510

1611
<Frame caption="Choose an area code for your phone number.">
17-
<img src="/static/images/quickstart/dashboard/buy-phone-number-modal.png" />
12+
<img src="/static/images/quickstart/dashboard/buy-vapi-phone-number-modal.png" />
1813
</Frame>
1914

2015
<Info>
21-
Currently, only US & Canada phone numbers can be directly purchased through Vapi. Phone numbers in
16+
Currently, only US & Canada phone numbers can be directly created through Vapi. Phone numbers in
2217
other regions must be imported, see our [phone calling](/phone-calling) guide.
2318
</Info>
2419

25-
Click "Buy", after purchasing a phone number you should see something like this:
20+
Click "Create", after creating a phone number you should see something like this:
2621

2722
<Frame caption="Here we can attach an assistant to the number for inbound calls (or perform an outbound call, with a select assistant).">
28-
<img src="/static/images/quickstart/dashboard/phone-number-config.png" />
23+
<img src="/static/images/quickstart/dashboard/vapi-phone-number-config.png" />
2924
</Frame>
3025

31-
The phone number is now ready to be used (either for inbound or outbound calling).
26+
<Note>
27+
It takes a couple of minutes for the phone number to be fully activated. During this period, calls will not be functional.
28+
</Note>
29+
30+
Once activated, the phone number will be ready for use (either for inbound or outbound calling).

fern/snippets/quickstart/phone/get-a-phone-number.mdx

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,44 @@
11
There are **2 ways** we can get a phone number into our Vapi account:
22

3-
1. **Purchase a Number Through Vapi:** we can directly purchase phone numbers through Vapi.
3+
1. **Create a Number Through Vapi:** we can directly create phone numbers through Vapi.
44

5-
- Vapi will provision the phone number for us via Twilio
5+
- Vapi will provision the phone number for us
66
- This can be done in the dashboard, or via the API (we will use the dashboard)
77

88
2. **Import from Twilio or Vonage:** if we already have a phone number with an external telephony provider (like Twilio or Vonage), we can import them into our Vapi account.
99

1010
<AccordionGroup>
1111
<Accordion title="Provision via Vapi (faster)" icon="v" iconType="solid">
12-
The quickest way to secure a phone number for your assistant is to purchase a phone number directly through Vapi.
12+
The quickest way to secure a phone number for your assistant is to create a phone number directly through Vapi.
1313

14-
<Info>
15-
Ensure you have a card on file that Vapi can bill before proceeding, you can add your billing
16-
information in your dashboard at [dashboard.vapi.ai/billing](https://dashboard.vapi.ai/billing)
17-
</Info>
18-
19-
Navigate to the "Phone Numbers" section & click the "Buy number" button:
14+
Navigate to the "Phone Numbers" section & click the "Create Phone Number" button:
2015

2116
<Frame caption="Make sure you are in the 'Phone Numbers' dashboard tab.">
22-
<img src="/static/images/quickstart/dashboard/buy-a-phone-number.png" />
17+
<img src="/static/images/quickstart/dashboard/create-vapi-phone-number.png" />
2318
</Frame>
2419

2520
We will use the area code `415` for our phone number (these are area codes domestic to the US & Canada).
2621

2722
<Frame caption="Choose an area code for your phone number.">
28-
<img src="/static/images/quickstart/dashboard/buy-phone-number-modal.png" />
23+
<img src="/static/images/quickstart/dashboard/buy-vapi-phone-number-modal.png" />
2924
</Frame>
3025

3126
<Info>
32-
Currently, only US & Canada phone numbers can be directly purchased through Vapi. Phone numbers in
27+
Currently, only US & Canada phone numbers can be directly created through Vapi. Phone numbers in
3328
other regions must be imported, see our [phone calling](/phone-calling) guide.
3429
</Info>
3530

36-
Click "Buy", after purchasing a phone number you should see something like this:
31+
Click "Create", after creating a phone number you should see something like this:
3732

3833
<Frame caption="Here we can attach an assistant to the number for inbound calls (or perform an outbound call, with a select assistant).">
39-
<img src="/static/images/quickstart/dashboard/phone-number-config.png" />
34+
<img src="/static/images/quickstart/dashboard/vapi-phone-number-config.png" />
4035
</Frame>
4136

42-
The phone number is now ready to be used (either for inbound or outbound calling).
37+
<Note>
38+
It takes a couple of minutes for the phone number to be fully activated. During this period, calls will not be functional.
39+
</Note>
40+
41+
Once activated, the phone number will be ready for use (either for inbound or outbound calling).
4342
</Accordion>
4443
<Accordion title="Import from Twilio or Vonage" icon="hashtag" iconType="regular">
4544
We can also import an existing phone number we already own with either Twilio or Vonage.
400 KB
Loading

0 commit comments

Comments
 (0)