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
{{ message }}
Repository navigation
Commit 3dd18d7
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: fern/assistants/call-recording.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ The consent assistant runs without generating artifacts, while the main assistan
136
136
</Step>
137
137
138
138
<Steptitle="Publish the assistant">
139
-
Select **publish** in the unsaved-changes message to apply the update.
139
+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish**to make the assistant version current.
Copy file name to clipboardExpand all lines: fern/assistants/end-call-phrases.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Avoid unnecessary punctuation and whitespace inside a phrase. A short phrase suc
33
33
</Step>
34
34
35
35
<Steptitle="Find the end call settings">
36
-
In the assistant editor, open the **Advanced** tab and find**End Call Message** and **End Call Phrases**.
36
+
Open the **Advanced** tab and expand **Messaging**. Find**End Call Message** and **End Call Phrases**.
37
37
38
38
<Framecaption="End Call Message and End Call Phrases in the Advanced tab">
39
39
<imgsrc="/static/images/tools/hang-up/06-end-call-phrases.png"alt="Vapi Dashboard Advanced tab with End Call Message set to Goodbye and End Call Phrases set to Thanks for calling. Goodbye." />
Copy file name to clipboardExpand all lines: fern/calls/assistant-based-warm-transfer.mdx
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,8 +57,16 @@ Create a reusable transfer call tool, configure a phone-number destination, and
57
57
Enter the **Message to Operator**. Under **Fallback Plan**, set the message spoken to the customer when the transfer fails and choose whether to end the call. Under **Summary Plan**, choose whether to generate a conversation summary for the operator.
58
58
</Step>
59
59
60
-
<Steptitle="Save and add the tool to the assistant">
61
-
Click **Save**. Open **Assistants**, select the original assistant, and add the tool from the assistant's **Tools** section. Update the system prompt with the conditions for starting the transfer, then save the assistant.
60
+
<Steptitle="Publish the tool">
61
+
Select **Publish** in the tool header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the tool version current.
62
+
</Step>
63
+
64
+
<Steptitle="Add the tool to the assistant">
65
+
Open **Assistants** and select the original assistant. In the assistant's **Tools** section, select **Add tool** and choose the transfer call tool. Update the system prompt with the conditions for starting the transfer.
66
+
</Step>
67
+
68
+
<Steptitle="Publish the assistant">
69
+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the assistant version current.
Copy file name to clipboardExpand all lines: fern/calls/voicemail-detection.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ All three providers — **Vapi, Google, and OpenAI** — support **interruption
68
68
</Step>
69
69
70
70
<Steptitle="Publish the assistant">
71
-
Select **publish** in the unsaved-changes message to apply the update.
71
+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish**to make the assistant version current.
Copy file name to clipboardExpand all lines: fern/chat/quickstart.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,17 +49,14 @@ We'll create a customer support chat for "TechFlow", a software company that wan
49
49
## 2. Create or Select an Assistant
50
50
51
51
<Steps>
52
-
<Steptitle="Navigate to Assistants">
53
-
In your Vapi dashboard, click `Assistants` in the left sidebar.
52
+
<Steptitle="Open Assistants">
53
+
In the [Vapi Dashboard](https://dashboard.vapi.ai), select **Assistants**.
54
54
</Step>
55
-
<Steptitle="Create a new assistant (or use existing)">
56
-
- Click `Create Assistant` if you need a new one
57
-
- Select `Blank Template` as your starting point
58
-
- Name it `TechFlow Support`
59
-
- Set the first message to: `Hello! I'm here to help with TechFlow questions. What can I assist you with today?`
55
+
<Steptitle="Create or select an assistant">
56
+
Select **Create Assistant** to create a blank assistant, or open an existing assistant. For a new assistant, select **Edit** beside its name, enter `TechFlow Support`, then select **Save**. On the **Assistant** tab, enter `Hello! I'm here to help with TechFlow questions. What can I assist you with today?` in **First message**.
60
57
</Step>
61
58
<Steptitle="Configure the system prompt">
62
-
Update the system prompt to:
59
+
On the **Assistant** tab, enter the following in **System prompt**:
63
60
64
61
```txt title="System Prompt" maxLines=8
65
62
You are a helpful customer support agent for TechFlow, a software company.
@@ -72,8 +69,11 @@ We'll create a customer support chat for "TechFlow", a software company that wan
72
69
Keep responses concise and helpful. Always maintain a friendly, professional tone.
73
70
```
74
71
</Step>
72
+
<Steptitle="Publish the assistant">
73
+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
74
+
</Step>
75
75
<Steptitle="Copy the Assistant ID">
76
-
After publishing, copy the Assistant ID from the URL or assistant details. You'll need this for API calls.
76
+
Select the copy button beside the Assistant ID in the assistant header. You'll need this ID for API calls.
77
77
</Step>
78
78
</Steps>
79
79
@@ -357,7 +357,7 @@ The chat API supports the following webhook events through server messaging:
357
357
-**`chat.created`** - Triggered when a new chat conversation is initiated
358
358
-**`chat.deleted`** - Triggered when a chat conversation is deleted
359
359
360
-
To receive these webhooks, go to your Assistant page in the Dashboard and navigate to "ServerMessaging" and select the events you want to receive.
360
+
To receive these webhooks, open the assistant in the [Vapi Dashboard](https://dashboard.vapi.ai). On **Advanced**, enter your endpoint in **Webhook Server** → **Server URL**. Under **Messaging** → **Server Messages**, select `chat.created`and `chat.deleted`. Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
361
361
362
362
These webhooks are useful for tracking conversation analytics, maintaining conversation history in your own database, and triggering follow-up actions.
Copy file name to clipboardExpand all lines: fern/chat/session-management.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -259,7 +259,7 @@ Sessions support the following webhook events through server messaging:
259
259
-**`session.updated`** - Triggered when a session is updated
260
260
-**`session.deleted`** - Triggered when a session is deleted
261
261
262
-
To receive these webhooks, go to your Assistant page in the Dashboard and navigate to "ServerMessaging" and select the events you want to receive.
262
+
To receive these webhooks, open the assistant in the [Vapi Dashboard](https://dashboard.vapi.ai). On **Advanced**, enter your endpoint in **Webhook Server** → **Server URL**. Under **Messaging** → **Server Messages**, select `session.created`, `session.updated`, and `session.deleted`. Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
263
263
264
264
These webhooks are useful for tracking session lifecycle, managing session state in your own database, and triggering workflows based on session changes.
Copy file name to clipboardExpand all lines: fern/outbound-campaigns/build-personalized-appointment-campaign.mdx
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,15 +87,23 @@ For more formatting rules and limits, see [Campaign contact data](/outbound-camp
87
87
<Tabtitle="Dashboard">
88
88
<Steps>
89
89
<Steptitle="Create the voicemail tool">
90
-
In the [Vapi Dashboard](https://dashboard.vapi.ai), go to **Tools** and select **Create Tool**. Choose **Voicemail**, name it `leave_voicemail_for_appointment`, and add a description. Select **Use custom script** and paste the **voicemail script** above, then save the tool.
90
+
In the [Vapi Dashboard](https://dashboard.vapi.ai), select **Tools**, then **Create Tool**. Select **Leave Voicemail** under **Phone Call Tools**. Name it `leave_voicemail_for_appointment` and add a description. Under **Voicemail Script**, select **Use custom script** and paste the voicemail script above.
91
+
</Step>
92
+
93
+
<Steptitle="Publish the voicemail tool">
94
+
Select **Publish** to save the tool configuration.
91
95
</Step>
92
96
93
97
<Steptitle="Create the assistant">
94
-
Go to **Assistants** and create an assistant. Set **First Message Mode** to **Assistant waits for user**, leave the first-message text empty, and paste the **system prompt** above.
98
+
Select **Assistants**, then **Create Assistant**. On the **Assistant** tab, select **Assistant waits for user** under **First message**, leave the first-message text empty, and paste the system prompt above into **System prompt**.
99
+
</Step>
100
+
101
+
<Steptitle="Add the voicemail tool">
102
+
On the assistant's **Tools** tab, select **Add tool** and choose `leave_voicemail_for_appointment`. On **Advanced**, under **Voicemail Detection**, set **Voicemail Detection Provider** to **Off** so automatic detection does not compete with the tool.
95
103
</Step>
96
104
97
-
<Steptitle="Add the tool and publish">
98
-
Open the assistant's **Tools** section and add the `leave_voicemail_for_appointment` tool. Keep automatic voicemail detection disabled so the two approaches do not compete, then publish the assistant.
105
+
<Steptitle="Publish the assistant">
106
+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
Copy file name to clipboardExpand all lines: fern/outbound-campaigns/quickstart.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,11 +42,11 @@ answer.
42
42
</Step>
43
43
44
44
<Steptitle="Add the system prompt">
45
-
In the assistant's **Model**section, paste the **system prompt** above into the system prompt field.
45
+
On the **Assistant**tab, paste the prompt above into **System prompt**.
46
46
</Step>
47
47
48
48
<Steptitle="Publish the assistant">
49
-
Publishthe assistant so the campaign can use it.
49
+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**. The campaign can use the published assistant.
Copy file name to clipboardExpand all lines: fern/phone-numbers/didww.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,15 +37,15 @@ slug: phone-numbers/didww
37
37
</Step>
38
38
39
39
<Steptitle="Enter the DIDWW number">
40
-
Enter the number in E.164 format, including the `+` prefix. Leave **Allow non-E164 phone numbers** off, select the **DIDWW Inbound Trunk** credential, and optionally add a label. Then click**Import SIP Phone Number**.
40
+
Enter the number in E.164 format, including the `+` prefix. Leave **Allow non-E164 phone numbers** off, select the **DIDWW Inbound Trunk** credential created in the [DIDWW SIP integration](/advanced/sip/didww), and optionally add a label. Then select**Import SIP Phone Number**.
41
41
42
42
<Framecaption="Import the DIDWW number with the DIDWW SIP trunk credential.">
43
-
<imgsrc="../static/images/quickstart/phone/import-didww-number-dashboard.png"alt="Vapi Create Phone Number form with BYO SIP Trunk Number selected and the DIDWW Inbound Trunk credential chosen" />
43
+
<imgsrc="../static/images/quickstart/phone/import-didww-number-dashboard.png"alt="Vapi Create Phone Number form with BYO SIP Trunk Number selected and an inbound SIP trunk credential chosen" />
44
44
</Frame>
45
45
</Step>
46
46
47
47
<Steptitle="Assign an assistant">
48
-
Open the imported number, select an assistant under **Inbound Settings**, and click**Save**.
48
+
Open the imported number, select an assistant under **Inbound Settings**, and select**Save**.
49
49
50
50
<Framecaption="Assign an assistant to handle inbound calls to the DIDWW number.">
51
51
<imgsrc="../static/images/quickstart/phone/didww-number-assign-assistant.png"alt="Vapi phone number Inbound Settings with an assistant selected to handle inbound calls" />
Copy file name to clipboardExpand all lines: fern/phone-numbers/telnyx.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,8 @@ This guide shows you how to import your existing Telnyx phone numbers to the Vap
28
28
Select **Create Phone Number**, then choose **Import Telnyx** under **Phone Number Options**.
29
29
</Step>
30
30
31
-
<Steptitle="Enter the Telnyx number and API key">
32
-
Enter the number, including its country code, in **Telnyx Phone Number**. Enter your key in **API Key** and, optionally, enter a descriptive **Label**. Then select **Import from Telnyx**.
31
+
<Steptitle="Enter the Telnyx number">
32
+
Enter the number, including its country code, in **Telnyx Phone Number**. If your organization has no Telnyx credential, enter your Telnyx key in **API Key**. When a Telnyx credential already exists, Vapi uses it for the import and omits **API Key**. Optionally, enter a descriptive **Label**. Then select **Import from Telnyx**.
0 commit comments