You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: call-forwarding.mdx
+101-1Lines changed: 101 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -158,4 +158,104 @@ Use the system prompt to guide the assistant on when to utilize each forwarding
158
158
- Ensure you have written the function description properly to indicate where you want to forward the call
159
159
- Test the call forwarding setup thoroughly to confirm its functionality.
160
160
161
-
By following these guidelines and utilizing the `transferCall` tool, you can effectively manage call routing and provide a seamless experience for your users.
161
+
## Call Transfers Mode
162
+
163
+
Vapi supports two types of call transfers:
164
+
165
+
1.**Blind Transfer** (default): Directly transfers the call to another agent without providing any prior information to the recipient.
166
+
2.**Warm Transfer**: Transfers the call to another agent after providing context about the call. The context can be either a full transcript or a summary, based on your configuration.
167
+
168
+
### Warm Transfer
169
+
170
+
To implement a warm transfer, add a `transferPlan` object to the `transferCall` tool syntax and specify the transfer mode.
171
+
172
+
#### Modes of Warm Transfer
173
+
174
+
##### 1. Warm Transfer with Summary
175
+
176
+
In this mode, Vapi provides a summary of the call to the recipient before transferring.
177
+
178
+
***Configuration:**
179
+
* Set the `mode` to `"warm-transfer-with-summary"`.
180
+
* Define a `summaryPlan` specifying how the summary should be generated.
181
+
* Use the `{{transcript}}` variable to include the call transcript.
182
+
183
+
***Example:**
184
+
185
+
```json
186
+
"transferPlan": {
187
+
"mode": "warm-transfer-with-summary",
188
+
"summaryPlan": {
189
+
"enabled": true,
190
+
"messages": [
191
+
{
192
+
"role": "system",
193
+
"content": "Please provide a summary of the call."
194
+
},
195
+
{
196
+
"role": "user",
197
+
"content": "Here is the transcript:\n\n{{transcript}}\n\n"
198
+
}
199
+
]
200
+
}
201
+
}
202
+
```
203
+
204
+
##### 2. Warm Transfer with Message
205
+
206
+
In this mode, Vapi delivers a custom static message to the recipient before transferring the call.
207
+
208
+
***Configuration:**
209
+
* Set the `mode` to `"warm-transfer-with-message"`.
210
+
* Provide the custom message in the `message` property.
211
+
* Note that the `{{transcript}}` variable is not available in this mode.
212
+
213
+
***Example:**
214
+
215
+
```json
216
+
"transferPlan": {
217
+
"mode": "warm-transfer-with-message",
218
+
"message": "Hey, this call has been forwarded through Vapi."
219
+
}
220
+
```
221
+
222
+
#### Complete Example
223
+
224
+
Here is a full example of a `transferCall` payload using the warm transfer with summary mode:
225
+
226
+
```json
227
+
{
228
+
"type": "transferCall",
229
+
"messages": [
230
+
{
231
+
"type": "request-start",
232
+
"content": "I'll transfer you to someone who can help."
233
+
}
234
+
],
235
+
"destinations": [
236
+
{
237
+
"type": "number",
238
+
"number": "+918936850777",
239
+
"description": "Transfer the call",
240
+
"transferPlan": {
241
+
"mode": "warm-transfer-with-summary",
242
+
"summaryPlan": {
243
+
"enabled": true,
244
+
"messages": [
245
+
{
246
+
"role": "system",
247
+
"content": "Please provide a summary of the call."
248
+
},
249
+
{
250
+
"role": "user",
251
+
"content": "Here is the transcript:\n\n{{transcript}}\n\n"
252
+
}
253
+
]
254
+
}
255
+
}
256
+
}
257
+
]
258
+
}
259
+
```
260
+
261
+
**Note:** In all warm transfer modes, the `{{transcript}}` variable contains the full transcript of the call and can be used within the `summaryPlan`.
0 commit comments