Skip to main content
POST
/
calls
/
start
Start an outbound call
curl --request POST \
  --url https://api.vocobase.com/api/v2/calls/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_number": "+919876543210",
  "provider": "mcube",
  "variables": {
    "callee_name": "Sajal",
    "mobile_number": "+919876543210"
  }
}
'
{
  "success": true,
  "data": {
    "call_id": "c1234567-abcd-1234-abcd-123456789012",
    "session_id": "s1234567-abcd-1234-abcd-123456789012",
    "status": "pending",
    "provider": "twilio",
    "from_number": "+14155551234",
    "to_number": "+919876543210",
    "agent_id": "a1234567-abcd-1234-abcd-123456789012"
  }
}

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.

Authorizations

​
Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Body

application/json
​
agent_id
string<uuid>
required

ID of the agent to use for this call.

​
to_number
string
required

Destination phone number in E.164 format.

Example:

"+919876543210"

​
provider
enum<string>
default:mcube

Telephony provider. Defaults to mcube if not specified. The provider must be in your partner's allowed_telephony_providers list and its credentials must be configured (see the /config/telephony/* endpoints). Supported carriers honor the agent's voicemail_detection_enabled and voicemail_message settings when account-level voicemail detection is enabled. sip requires "SIP" to be in allowed_telephony_providers and a SIP carrier connection to be configured for your account.

Available options:
mcube,
twilio,
exotel,
plivo,
vobiz,
sip
​
variables
object

Pre-call variable values. Keys must match variable names declared on the agent (Agent.variables). Substituted into the agent's prompt and greeting via {{name}} placeholders. Echoed in the session.completed webhook for partner-side audit. Missing variables render as empty strings.

Example:
{
  "callee_name": "Sajal",
  "mobile_number": "+919876543210"
}

Response

Call initiated successfully.

​
success
boolean
​
data
object