Skip to content

Commit fdffc3d

Browse files
authored
Added docs on customizing hold audio on transfer (#786)
1 parent 1d8c79d commit fdffc3d

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

fern/calls/assistant-based-warm-transfer.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,42 @@ The `function.name` property identifies your transfer tool. Use this name when i
107107
Assistant configuration including provider, model, and system messages that control the transfer assistant's behavior
108108
</ParamField>
109109

110+
### Customizing hold audio
111+
112+
You can customize the audio played to the customer while they're on hold during the transfer process using the `request-complete` message type. If not specified, Vapi's default ringtone will be used.
113+
114+
<CodeBlocks>
115+
```json title="Custom Hold Music"
116+
{
117+
"type": "transferCall",
118+
"function": {
119+
"name": "transferCall"
120+
},
121+
"destinations": [
122+
// ... destination configuration
123+
],
124+
"messages": [
125+
{
126+
"type": "request-start",
127+
"content": "I'll transfer you now. Please hold."
128+
},
129+
{
130+
"type": "request-complete",
131+
"content": "https://your-domain.com/assets/custom-hold-music.mp3" // Custom hold audio URL
132+
},
133+
{
134+
"type": "request-failed",
135+
"content": "I couldn't complete the transfer."
136+
}
137+
]
138+
}
139+
```
140+
</CodeBlocks>
141+
142+
<Tip>
143+
The `request-complete` message with an audio URL will be played as hold music on the customer's side of the call while the transfer assistant connects with the operator. If you don't specify this message, Vapi's default ringtone will play.
144+
</Tip>
145+
110146
## Built-in tools
111147

112148
The transfer assistant has access to two built-in tools:

0 commit comments

Comments
 (0)