Skip to content

Commit 2f7d553

Browse files
refactor docs
1 parent 5a54d89 commit 2f7d553

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

fern/voice-fallback-plan.mdx

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
44
slug: voice-fallback-plan
55
---
66

@@ -10,23 +10,28 @@ slug: voice-fallback-plan
1010

1111
## Introduction
1212

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.
1414

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.
1616

1717
## How It Works
1818

1919
When a voice failure occurs, Vapi will:
2020
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
2429

2530
## Configuration
2631

2732
Add the `fallbackPlan` property to your assistant's voice configuration, and specify the fallback voices within the `voices` property.
2833
- 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.
3035

3136
```json
3237
{
@@ -37,7 +42,7 @@ Add the `fallbackPlan` property to your assistant's voice configuration, and spe
3742
"voices": [
3843
{
3944
"provider": "cartesia",
40-
"voiceId": "248be419-c632-4f23-adf1-5324ed7dbf1d",
45+
"voiceId": "248be419-c632-4f23-adf1-5324ed7dbf1d"
4146
},
4247
{
4348
"provider": "playht",
@@ -49,10 +54,24 @@ Add the `fallbackPlan` property to your assistant's voice configuration, and spe
4954
}
5055
```
5156

57+
Although **not recommended**, you may choose to disable the default fallback behavior by providing an empty list of voices in your fallback plan:
58+
59+
```json
60+
{
61+
"voice": {
62+
"provider": "openai",
63+
"voiceId": "shimmer",
64+
"fallbackPlan": {
65+
"voices": []
66+
}
67+
}
68+
}
69+
```
70+
5271
## Best practices
5372

5473
- Use <b>different providers</b> for your fallback voices to protect against provider-wide outages.
55-
- Select voices with similar characteristics (tone, accent, gender) to maintain consistency in the user experience.
74+
- Select voices with **similar characteristics** (tone, accent, gender) to maintain consistency in the user experience.
5675

5776
## How will pricing work?
5877

0 commit comments

Comments
 (0)