Handoffs configure SIP call transfers for voice agents. They define how and where a call should be transferred, or whether it should be ended.
Handoffs are used when an agent needs to escalate, transfer, or terminate a voice interaction in a controlled way.Location
Handoffs are defined in:handoffs key.
What a handoff contains
Each handoff includes the following fields:| Field | Description |
|---|---|
name | Identifier for the handoff. Referenced in rules as {{ho:handoff_name}}. |
description | Explains what the handoff does. |
is_default | Whether this is the default handoff. |
sip_config | Transfer method configuration. |
sip_headers | Optional custom SIP headers as key/value pairs. |
SIP config types
A handoff uses one of three SIP methods:| Method | Use | Fields |
|---|---|---|
invite | Start an outbound new call | phone_number, outbound_endpoint, outbound_encryption |
refer | Transfer an existing call | phone_number |
bye | End the call | No extra fields |
Notes
phone_numbershould use E.164 formatoutbound_encryptioncan beTLS/SRTPorUDP/RTP
Example
How handoffs are used
In code
Call a handoff directly with
conv.call_handoff(...).In rules
Refer to a handoff using
{{ho:handoff_name}}.In topics and flows
Instruct the model to call a function that performs the handoff.
In code
You can trigger a handoff directly in code:In rules
A handoff can be referenced inrules.txt using:
In topics and flows
Topics and flows should generally not perform raw transfer logic directly in prompt text. Instead, they should guide the model toward calling a function that performs the handoff. For example:Round-trip behavior
After a push and pull,sip_headers: [] may be added to handoff entries that did not originally define it. This is injected by the platform and does not affect runtime behavior — the empty list is equivalent to no SIP headers. Expect this field to appear on round-trip if you did not include it yourself.
Best practices
- use clear, descriptive handoff names
- use E.164 format for phone numbers
- create one handoff definition per transfer purpose
- keep
sip_headersminimal - only add custom SIP headers when the receiving system actually requires them
Related pages
Functions
See how handoffs are typically triggered from deterministic logic.
Agent settings
Learn how handoffs are referenced in rules.
Conversation object reference (platform)
Full reference for
conv.call_handoff — destination, reason, utterance, and SIP header overrides.
