Skip to content

Commit 86120b6

Browse files
bryantandersonhumford
authored andcommitted
Update docs on voice fallback plans (#216)
* update voice fallback docs * update docs * Update voice-fallback-plan.mdx --------- Co-authored-by: Henry Williams <[email protected]>
1 parent 2a840b8 commit 86120b6

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

fern/voice-fallback-plan.mdx

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ slug: voice-fallback-plan
1010

1111
## Introduction
1212

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.
13+
Voice fallback plans give you the ability to continue your call in the event that your primary voice fails. Your assistant will sequentially fallback to only the voices you configure within your plan, in the exact order you specify.
1414

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.
15+
<Note>
16+
Without a fallback plan configured, your call will end with an error in the event that your chosen voice provider fails.
17+
</Note>
1618

1719
## How It Works
1820

@@ -22,10 +24,6 @@ When a voice failure occurs, Vapi will:
2224
- Switch to the first fallback voice in your plan
2325
- Continue through your specified list if subsequent failures occur
2426
- 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
2927

3028
## Configuration
3129

@@ -54,25 +52,11 @@ Add the `fallbackPlan` property to your assistant's voice configuration, and spe
5452
}
5553
```
5654

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-
7155
## Best practices
7256

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

7660
## How will pricing work?
7761

78-
There is no change to the pricing of the voices. Your call will not incur any extra fees while using fallback voices, and you will be able to see the cost for each voice in your end-of-call report.
62+
There is no change to the pricing of the voices. Your call will not incur any extra fees while using fallback voices, and you will be able to see the cost for each voice in your end-of-call report.

0 commit comments

Comments
 (0)