Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions fern/examples/inbound-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,14 @@ As a bonus, we also want the assistant to remember by the phone number of the ca
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.

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

```json
{
"id": "c86b5177-5cd8-447f-9013-99e307a8a7bb",
"orgId": "aa4c36ba-db21-4ce0-9c6e-99e307a8a7bb",
"provider": "vapi",
"number": "+11234567890",
"createdAt": "2023-09-29T21:44:37.946Z",
"updatedAt": "2023-12-08T00:57:24.706Z",
Expand Down
5 changes: 3 additions & 2 deletions fern/examples/outbound-sales.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,14 @@ We want this agent to be able to call a list of leads and schedule appointments.
We'll then make a POST request to the [Create Assistant](/api-reference/assistants/create-assistant) endpoint to create the assistant.

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

```json
{
"id": "c86b5177-5cd8-447f-9013-99e307a8a7bb",
"orgId": "aa4c36ba-db21-4ce0-9c6e-99e307a8a7bb",
"provider": "vapi",
"number": "+11234567890",
"createdAt": "2023-09-29T21:44:37.946Z",
"updatedAt": "2023-12-08T00:57:24.706Z",
Expand Down
4 changes: 2 additions & 2 deletions fern/phone-calling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ slug: phone-calling


<Accordion title="Set up a Phone Number">
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.
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.

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

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.

Expand Down
8 changes: 0 additions & 8 deletions fern/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,6 @@ slug: pricing
>
Bring your own API keys for providers, Vapi makes requests on your behalf.
</Card>
<Card
title="$2/mo for Phone Numbers"
icon="phone-office"
iconType="solid"
color="#fcba03"
>
Phone numbers purchased through Vapi bill at $2/mo.
</Card>
</CardGroup>

### Starter Credits
Expand Down
2 changes: 1 addition & 1 deletion fern/quickstart/inbound.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ An inbound call is a phone call that comes **"in"** towards a phone number, & in
There are **4 steps** we will cover to handle our first inbound phone call:

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

Expand Down
2 changes: 1 addition & 1 deletion fern/quickstart/outbound.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ An outbound call is a phone call that is dialed and goes **"out"** from a phone
There are **3 steps** we will cover to send our first outbound phone call:

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

We can then send the outbound call, hopefully someone picks up!
Expand Down
2 changes: 1 addition & 1 deletion fern/server-url/setting-server-urls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Here's a breakdown of where you can set server URLs in Vapi:
Phone numbers can have a server URL attached to them via the [phone number API](/api-reference/phone-numbers).

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
The quickest way to secure a phone number for your assistant is to purchase a phone number directly through Vapi.
The quickest way to secure a phone number for your assistant is to create a phone number directly through Vapi.

<Info>
Ensure you have a card on file that Vapi can bill before proceeding, you can add your billing
information in your dashboard at [dashboard.vapi.ai/billing](https://dashboard.vapi.ai/billing)
</Info>

Navigate to the "Phone Numbers" section & click the "Buy number" button:
Navigate to the "Phone Numbers" section & click the "Create Phone Number" button:

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

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

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

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

Click "Buy", after purchasing a phone number you should see something like this:
Click "Create", after creating a phone number you should see something like this:

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

The phone number is now ready to be used (either for inbound or outbound calling).
<Note>
It takes a couple of minutes for the phone number to be fully activated. During this period, calls will not be functional.
</Note>

Once activated, the phone number will be ready for use (either for inbound or outbound calling).
29 changes: 14 additions & 15 deletions fern/snippets/quickstart/phone/get-a-phone-number.mdx
Original file line number Diff line number Diff line change
@@ -1,45 +1,44 @@
There are **2 ways** we can get a phone number into our Vapi account:

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

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

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.

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

<Info>
Ensure you have a card on file that Vapi can bill before proceeding, you can add your billing
information in your dashboard at [dashboard.vapi.ai/billing](https://dashboard.vapi.ai/billing)
</Info>

Navigate to the "Phone Numbers" section & click the "Buy number" button:
Navigate to the "Phone Numbers" section & click the "Create Phone Number" button:

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

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

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

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

Click "Buy", after purchasing a phone number you should see something like this:
Click "Create", after creating a phone number you should see something like this:

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

The phone number is now ready to be used (either for inbound or outbound calling).
<Note>
It takes a couple of minutes for the phone number to be fully activated. During this period, calls will not be functional.
</Note>

Once activated, the phone number will be ready for use (either for inbound or outbound calling).
</Accordion>
<Accordion title="Import from Twilio or Vonage" icon="hashtag" iconType="regular">
We can also import an existing phone number we already own with either Twilio or Vonage.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading