Merge branch 'main' into adithya/delete-onprem

Author: AdiSai

fern/call-forwarding.mdx

@@ -386,14 +386,18 @@ In this mode, Vapi dials the destination number and places the caller on hold (w
   - Provide a `message` to be spoken to the operator when they answer.
   - Optionally define a `summaryPlan` that will take precedence over the message if enabled.
   - Configure a `fallbackPlan` with a message and whether to end the call if transfer fails.
-  - When voicemail detection is enabled in the assistant configuration (with either Google or OpenAI provider), it will use that configuration to detect if a human answered the call. Note that only Google or OpenAI providers are supported for voicemail detection with transfer plans, even if the assistant configuration supports other providers like Twilio or Vapi.
+  - Configure `voicemailDetectionType` to customize how human voice detection is performed (only applies when the provider is Google or OpenAI):
+    - `"audio"` (default): Supports a wide range of machine detection including beep detection and other audio cues
+    - `"transcript"`: Uses transcript-based detection with the lowest latency and faster transfer processing times
+  - Note that only Google or OpenAI providers are supported for voicemail detection with transfer plans, even if the assistant configuration supports other providers like Twilio or Vapi.
 
 - **Example:**
 
 ```json
 "transferPlan": {
   "mode": "warm-transfer-experimental",
   "message": "Transferring a customer to you.",
+  "voicemailDetectionType": "transcript",
   "fallbackPlan": {
     "message": "Could not transfer your call, goodbye.",
     "endCallEnabled": true
@@ -414,6 +418,8 @@ In this mode, Vapi dials the destination number and places the caller on hold (w
 }
 ```
 
+<Note>This example uses `"transcript"` for the fastest transfer processing. For wider machine detection capabilities, use `"audio"` instead.</Note>
+
 Here is a full example of a `transferCall` payload using the experimental warm transfer mode:
 
 ```json
@@ -430,6 +436,7 @@ Here is a full example of a `transferCall` payload using the experimental warm t
       "transferPlan": {
         "mode": "warm-transfer-experimental",
         "message": "Transferring a customer to you.",
+        "voicemailDetectionType": "audio",
         "fallbackPlan": {
           "message": "Could not transfer your call, goodbye.",
           "endCallEnabled": true
@@ -453,7 +460,12 @@ Here is a full example of a `transferCall` payload using the experimental warm t
 }
 ```
 
+<Note>This example uses `"audio"` for comprehensive machine detection including beep detection. This is the default option if not specified.</Note>
+
 **Notes:**
 
 - In all warm transfer modes, the `{{transcript}}` variable contains the full transcript of the call and can be used within the `summaryPlan`.
+- The `voicemailDetectionType` parameter allows you to optimize the detection method based on your needs:
+  - Use `"transcript"` for the fastest transfer processing with lowest latency
+  - Use `"audio"` (default) for comprehensive machine detection including beep detection and other audio cues
 - For more details about transfer plans and configuration options, please refer to the [transferCall API documentation](/api-reference/tools/create#request.body.transferCall.destinations.number.transferPlan)