Skip to main content
POST
/
agent
/
call
/
{agent_id}
Send AI Call
curl --request POST \
  --url https://api.getoutbox.ai/agent/call/{agent_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "full_name": "<string>",
  "agent_number": "<string>",
  "external_customer_id": "<string>",
  "context": {},
  "first_message": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "status": "<string>"
}

Authorizations

Authorization
string
header
required

Company API Key

Path Parameters

agent_id
string
required

The ID of the voicebot agent

Body

application/json

Call initiation details

phone_number
string
required

Phone number to call (E.164 format recommended)

full_name
string

Full name of the person being called

agent_number
string

Phone number to call from (must be assigned to the agent)

external_customer_id
string

External customer ID for tracking

context
object

Custom variables for the call that can be used in prompts with {{variable}} placeholders

first_message
string

Override the agent's default first message

scheduled_at
string<date-time>

ISO-8601 datetime string for scheduling the call (will be converted to UTC)

Response

Call initiated immediately

Call details when initiated immediately

id
string

Call ID

status
string

Call status