start_outbound_call
Place a REAL outbound call now: the agent calls the "to" number and talks to whoever answers. Bills voice minutes. Confirm the number with the user first. channel=phone (default) is a normal phone call from the agent's assigned number. channel=whatsapp is a WhatsApp voice call from one of the agent's WhatsApp numbers (it needs voice calling switched on, see whatsapp_numbers_write set_voice_calling). WhatsApp only lets a business call someone who has allowed it: if they have not, they are sent a permission prompt in the chat and NO call is placed (the result status is "permission_requested"; call again once they accept). WhatsApp allows 1 permission prompt per customer per 24 hours and 2 per 7 days, and the prompt only works within 24 hours of the customer last messaging the number. For many leads at once use contact_leads or a campaign (campaigns_write).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"agentId": "<agentId>",
"to": "<to>"
},
"name": "start_outbound_call"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Number to call, E.164 (e.g. +15551234567). | |
| from | No | Optional: one of the agent's numbers (a phone number for channel=phone, a WhatsApp number for channel=whatsapp), in E.164 with a leading +. Defaults to the agent's primary number. | |
| mode | No | compact (default) = light mode: long text is cut and bulky blobs are replaced by a size marker. full = complete API response. | |
| agentId | Yes | ||
| channel | No | How to place the call. phone (default): a normal phone call. whatsapp: a WhatsApp voice call; the customer must have allowed calls from your business, otherwise they get a permission prompt and no call is placed. | |
| options | No | Optional per-call agent overrides (e.g. initialPrompt, variables). | |
| leadInfo | No | Optional details about the person (username, email, address, company, notes…) the agent can use to personalize. | |
| campaignId | No | Optional: attribute the call to a campaign. | |
| permissionMessage | No | channel=whatsapp only. Text of the permission prompt the customer sees, for example "May we call you about your booking?" (max 1024 characters). A default message is used when empty. | |
| requestPermission | No | channel=whatsapp only. When the customer has not allowed calls yet, send them the permission prompt in the chat (default true). false sends nothing and returns status "no_permission". |