POST
/
call
curl --request POST \
  --url https://api.bolna.dev/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_id": "123e4567-e89b-12d3-a456-426655440000",
  "recipient_phone_number": "+10123456789",
  "from_phone_number": "+19876543007",
  "user_data": {
    "variable1": "value1",
    "variable2": "value2",
    "variable3": "some phrase as value"
  }
}'
{
  "message": "done",
  "status": "queued",
  "execution_id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
Make a phone call from agent
​
agent_id
string
required

Agent id which will initiate the outbound call

​
recipient_phone_number
string
required

Phone number of the recipient alongwith country code (in E.164 format)

​
from_phone_number
string

Phone number of the sender alongwith country code (in E.164 format)

​
user_data
object

Additional user dynamic variables as defined in the agent prompt

Response

200
application/json
agent status response
​
message
string

Response message for the call initiated

Example:

"done"

​
status
enum<string>

Status of the call.

Available options:
queued
Example:

"queued"

​
execution_id
string

Unique execution_id or call_id identifier of the call.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Previous
Overview
Next