Documentation Index
Fetch the complete documentation index at: https://docs.vocobase.com/llms.txt
Use this file to discover all available pages before exploring further.
Call Transfer & Behavior
Vocobase agents can transfer live calls to a human agent mid-conversation. When a caller asks to speak to a human, the agent announces the transfer and the caller is bridged to the configured human number. You can also configure the agent to end calls automatically when the conversation goal is reached.How call transfer works
- The agent detects a trigger condition — e.g., the caller says “let me speak to a manager”
- The agent speaks the configured transfer announcement
- Vocobase transfers the caller to the configured human phone number
- The
session.completedwebhook includes transfer metadata so you can identify the handoff
The number you transfer to must be in E.164 format (e.g.,
+14155551234).Enabling call transfer on an agent
SettransferEnabled to true when creating or updating an agent. Provide the phone number the caller should be transferred to. The transfer_instructions field is plain English guidance for when the agent should transfer:
Transfer agent fields
| Field | Type | Description |
|---|---|---|
transferEnabled | boolean | Master toggle. Defaults to false. |
transferNumber | string | E.164 phone number to transfer to. Max 32 characters. Required when transferEnabled is true. |
transferMessage | string | Announcement spoken right before transferring. Max 500 characters. If empty, the bot uses a platform default. |
transfer_instructions | string (≤2000 chars) | Free-text natural-language instructions for when to transfer. Pass null or empty to skip the section. |
Writing transfer instructions
transfer_instructions is plain English. There’s no fixed taxonomy — write conditions specific to your use case:
Hard cutover — the prior
transferTriggers: string[] array of fixed keys (CALLER_ASKS_HUMAN, FRUSTRATED, etc.) has been removed. If you were posting that field, replace it with transfer_instructions containing the equivalent prose. Existing agents were auto-migrated.End-call behavior
Configure the agent to end calls automatically when certain conditions are met. Same free-form pattern as transfer:End-call agent fields
| Field | Type | Description |
|---|---|---|
endCallEnabled | boolean | Master toggle. Defaults to true. |
endCallMessage | string | Farewell message spoken before hanging up. Max 500 characters. |
end_call_instructions | string (≤2000 chars) | Free-text natural-language instructions for when to end the call. Pass null or empty to skip the section. |
What happens when a call is transferred
When a transfer happens:- The agent speaks the configured
transferMessage. - Vocobase transfers the caller to
transferNumber. - The
session.completedwebhook includesdata.call.transferred: true.
session.completed partner webhook fires when the agent-handled portion ends. Distinguish a transferred call from a normal hangup via data.call.transferred on the webhook payload — see session.completed payload.
duration_seconds reflects only the bot leg. recording_url, when present, is the bot-leg recording — the human side is not recorded.
Initiating a transfer from the API
You can programmatically transfer an active call to a human number using the transfer endpoint:Request
| Field | Type | Required | Description |
|---|---|---|---|
to | string | No | E.164 number to transfer to. If omitted, the agent’s transferNumber is used. |
Response
| Field | Type | Description |
|---|---|---|
success | boolean | Whether the transfer was queued successfully |
data.message | string | Status message |
data.callId | string | The call identifier |
data.sessionId | string | The Vocobase session ID |
Testing the transfer flow
Enable transfer on your agent
Set
transferEnabled: true, a valid E.164 transferNumber, and clear transfer_instructions.Place a test call
Make a call to your agent. During the conversation, say something that matches your transfer instructions, like “Can I talk to a real person?”
Next steps
Inbound Calls
Set up inbound call handling with Twilio.
Custom Functions
Create custom LLM-callable API functions for your agents.
Webhooks
Configure webhook notifications for call events.
Billing (₹)
Understand how call ₹ is calculated, including 15s buckets and tier pricing.