Skip to content

Commit 517552c

Browse files
authored
Workflow documentation (#453)
* feat: add phone support agent workflow example * feat: update navigation to link new customer support hotline example * feat: add screenshots for customer support hotline example * fix: customer support hotline intro paragraph * fix(customer-support-hotline): image URLs * fix(customer-support-hotline): remove broken link from outro * chore (customer-support-hotline): refine copy, add videos * chore(customer-support-hotline): delete unnecessary screenshots * fix(customer-support-hotline): slug * feat(appointment-scheduling): initial commit * feat(banking-customer-support): update example to cover a banking use case * chore(inbound-support): address review feedback, fix system prompt * feat(appointment-scheduling): new workflow example * feat(clinic-triage-scheduling): new workflow example * feat(ecommerce-order-management): new workflow example * feat(outbound-sales): new workflow example * chore: delete pizza example * fix: broken video URLs * chore: update navigation to include new workflow examples * fix(inbound-support): broken video URL * chore: update `overview.mdx` to display new examples * feat(call-forwarding): update doc to incentivize use of dashboard * feat(using-query-tool): update doc to incentivize use of dashboard * feat(custom-tools): update doc to incentivize use of dashboard * feat(workflows/overview): add doc * feat(workflows/quickstart): add doc * feat(workflows): move docs, add new videos * chore: update nav to include workflow docs
1 parent 9ca59f8 commit 517552c

34 files changed

+2019
-425
lines changed

fern/call-forwarding.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,21 @@ Vapi's call forwarding functionality allows you to redirect calls to different p
1818

1919
## Setting Up Call Forwarding
2020

21-
### 1. Defining Destinations and Messages
21+
### 1. Create a Transfer Call Tool in the Dashboard
2222

23-
The `transferCall` tool includes a list of destinations and corresponding messages to notify the caller:
23+
The recommended approach is to create your transfer call tool in the Vapi dashboard:
24+
25+
1. Navigate to **Tools** in your Vapi dashboard
26+
2. Click **Create Tool**
27+
3. Select **Transfer Call** as the tool type
28+
4. Configure your destinations:
29+
- **Department A**: `+1234567890` with message "I am forwarding your call to Department A. Please stay on the line."
30+
- **Department B**: `+0987654321` with message "I am forwarding your call to Department B. Please stay on the line."
31+
- **Department C**: `+1122334455` with message "I am forwarding your call to Department C. Please stay on the line."
32+
33+
### 2. Alternative: API Configuration
34+
35+
You can also define the tool via API with destinations and corresponding messages:
2436

2537
```json
2638
{
@@ -112,7 +124,7 @@ You can also specify the `extension` parameter to forward the call to an extensi
112124
]
113125
```
114126

115-
### 2. Using the `transferCall` Function
127+
### 3. Using the `transferCall` Function
116128

117129
When the assistant needs to forward a call, it uses the `transferCall` function with the appropriate destination:
118130

@@ -127,7 +139,7 @@ When the assistant needs to forward a call, it uses the `transferCall` function
127139
}
128140
```
129141

130-
### 3. Customizing Messages
142+
### 4. Customizing Messages
131143

132144
Customize the messages for each destination to provide clear information to the caller:
133145

fern/docs.yml

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,19 +116,37 @@ navigation:
116116
- page: Inbound support
117117
path: examples/inbound-support.mdx
118118
icon: fa-light fa-phone-volume
119-
- page: Outbound sales
120-
path: examples/outbound-sales.mdx
121-
icon: fa-light fa-money-bill-wave
122-
- page: Pizza website
123-
path: examples/pizza-website.mdx
124-
icon: fa-light fa-pizza-slice
125119
- page: Voice widget
126120
path: examples/voice-widget.mdx
127121
icon: fa-light fa-window-maximize
128122
- page: Documentation agent
129123
path: examples/docs-agent.mdx
130124
icon: fa-light fa-microphone
131125

126+
- section: Workflows
127+
contents:
128+
- page: Quickstart
129+
path: workflows/quickstart.mdx
130+
icon: fa-light fa-bolt-lightning
131+
- page: Overview
132+
path: workflows/overview.mdx
133+
icon: fa-light fa-book
134+
- section: Examples
135+
icon: fa-light fa-code
136+
contents:
137+
- page: Appointment scheduling
138+
path: workflows/examples/appointment-scheduling.mdx
139+
icon: fa-light fa-calendar-check
140+
- page: Outbound sales
141+
path: workflows/examples/outbound-sales.mdx
142+
icon: fa-light fa-money-bill-wave
143+
- page: Medical triage
144+
path: workflows/examples/clinic-triage-scheduling.mdx
145+
icon: fa-light fa-stethoscope
146+
- page: Order management
147+
path: workflows/examples/ecommerce-order-management.mdx
148+
icon: fa-light fa-shopping-cart
149+
132150
- section: Assistant customization
133151
contents:
134152
- section: Conversation behaviour
@@ -722,7 +740,9 @@ redirects:
722740
- source: "/technical_support"
723741
destination: "/examples/inbound-support"
724742
- source: "/pizza_website"
725-
destination: "/examples/pizza-website"
743+
destination: "/examples/inbound-support"
744+
- source: "/examples/pizza-website"
745+
destination: "/examples/inbound-support"
726746
- source: "/outbound_call_python"
727747
destination: "/examples/outbound-call-python"
728748
- source: "/voice_widget"

fern/examples/inbound-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ We will be creating a customer support agent for VapiBank, a bank that wants to
5151
</Step>
5252
</Steps>
5353

54-
<video autoPlay loop muted src="../static/videos/inbound-support/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
54+
<video autoPlay loop muted src="../static/videos/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
5555

5656
---
5757

fern/examples/outbound-sales.mdx

Lines changed: 0 additions & 158 deletions
This file was deleted.

0 commit comments

Comments
 (0)