Skip to content

Commit 29994c0

Browse files
committed
add more docs
1 parent d4252d0 commit 29994c0

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

fern/call-forwarding.mdx

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,19 @@ The `transferCall` tool includes a list of destinations and corresponding messag
9999
}
100100
```
101101

102+
You can also specify the `extension` parameter to forward the call to an extension.
103+
104+
```json
105+
"destinations": [
106+
{
107+
"type": "number",
108+
"number": "+1234567890",
109+
"extension": "4603",
110+
"message": "I am forwarding your call to Department A. Please stay on the line."
111+
}
112+
]
113+
```
114+
102115
### 2. Using the `transferCall` Function
103116

104117
When the assistant needs to forward a call, it uses the `transferCall` function with the appropriate destination:
@@ -312,7 +325,7 @@ In this mode, Vapi executes TwiML instructions on the destination call leg befor
312325
- Provide the TwiML instructions in the `twiml` property.
313326
- Supports only `Play`, `Say`, `Gather`, and `Pause` verbs.
314327
- Maximum TwiML length is 4096 characters.
315-
- TwiML must be provided as a single-line string without line breaks or tabs.
328+
- TwiML must be provided as a single-line string without line breaks or tabs, and must be a valid XML string. For example: `<Say>Hello</Say>` is valid, but `<Say>Hello\n</Say>` is not.
316329

317330
- **Example:**
318331

@@ -349,4 +362,7 @@ Here is a full example of a `transferCall` payload using the warm transfer with
349362
}
350363
```
351364

352-
**Note:** In all warm transfer modes, the `{{transcript}}` variable contains the full transcript of the call and can be used within the `summaryPlan`.
365+
**Notes:**
366+
367+
- In all warm transfer modes, the `{{transcript}}` variable contains the full transcript of the call and can be used within the `summaryPlan`.
368+
- For more details about transfer plans and configuration options, please refer to the [transferCall API documentation](https://docs.vapi.ai/api-reference/tools/create#request.body.transferCall.destinations.number.transferPlan)

0 commit comments

Comments
 (0)