From fe34242f18f7dd78136233fc61296d03802e241a Mon Sep 17 00:00:00 2001 From: Sri Date: Thu, 6 Nov 2025 13:58:27 -0800 Subject: [PATCH] Added docs on customizing hold audio on transfer --- fern/calls/assistant-based-warm-transfer.mdx | 36 ++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/fern/calls/assistant-based-warm-transfer.mdx b/fern/calls/assistant-based-warm-transfer.mdx index 60da644af..0b9db4d40 100644 --- a/fern/calls/assistant-based-warm-transfer.mdx +++ b/fern/calls/assistant-based-warm-transfer.mdx @@ -107,6 +107,42 @@ The `function.name` property identifies your transfer tool. Use this name when i Assistant configuration including provider, model, and system messages that control the transfer assistant's behavior +### Customizing hold audio + +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. + + +```json title="Custom Hold Music" +{ + "type": "transferCall", + "function": { + "name": "transferCall" + }, + "destinations": [ + // ... destination configuration + ], + "messages": [ + { + "type": "request-start", + "content": "I'll transfer you now. Please hold." + }, + { + "type": "request-complete", + "content": "https://your-domain.com/assets/custom-hold-music.mp3" // Custom hold audio URL + }, + { + "type": "request-failed", + "content": "I couldn't complete the transfer." + } + ] +} +``` + + + +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. + + ## Built-in tools The transfer assistant has access to two built-in tools: