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
Copy file name to clipboardExpand all lines: fern/voice-fallback-plan.mdx
+28-9Lines changed: 28 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Voice Fallback Plan
3
-
subtitle: You can configure your assistants to fallback to other voices when your primary voice fails.
3
+
subtitle: Configure fallback voices that activate automatically if your primary voice fails.
4
4
slug: voice-fallback-plan
5
5
---
6
6
@@ -10,23 +10,28 @@ slug: voice-fallback-plan
10
10
11
11
## Introduction
12
12
13
-
Prior to the addition of fallback plans, calls would terminate if an assistant's voice experienced any failure, regardless of whether the issue originated from the voice provider or Vapi.
13
+
By default, if an assistant's primary voice experiences any failure, Vapi will automatically attempt to use other available voices to continue the call. While this ensures call continuity, you might want more control over which specific voices are used as fallbacks.
14
14
15
-
Fallback plans allow your assistant to continue the call in the scenario that your primary voice fails. Your assistant will sequentially fallback to the voices you configure within your plan, until there are no voices left.
15
+
Fallback plans give you precise control over the fallback sequence. Your assistant will sequentially fallback to only the voices you configure within your plan, in the exact order you specify.
16
16
17
17
## How It Works
18
18
19
19
When a voice failure occurs, Vapi will:
20
20
1. Detect the failure of the primary voice
21
-
2. Automatically switch to the first fallback voice
22
-
3. Continue through the list of fallback voices if subsequent failures occur
23
-
4. Only terminate if the list of fallback voices has been exhausted, and all have failed
21
+
2. If a custom fallback plan exists:
22
+
- Switch to the first fallback voice in your plan
23
+
- Continue through your specified list if subsequent failures occur
24
+
- Terminate only if all voices in your plan have failed
25
+
3. If no custom fallback plan is configured:
26
+
- Automatically switch to other available voices
27
+
- Continue attempting different voices
28
+
- Terminate only if all available voices have failed
24
29
25
30
## Configuration
26
31
27
32
Add the `fallbackPlan` property to your assistant's voice configuration, and specify the fallback voices within the `voices` property.
28
33
- Please note that fallback voices must be valid JSON configurations, and not strings.
29
-
-Also note that the order matters. Vapi will choose fallback voices starting from the beginning of the list.
34
+
-The order matters. Vapi will choose fallback voices starting from the beginning of the list.
30
35
31
36
```json
32
37
{
@@ -37,7 +42,7 @@ Add the `fallbackPlan` property to your assistant's voice configuration, and spe
0 commit comments