POST
/
calls
cURL
curl --request POST \
  --url https://api.callab.ai/v1/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_sid": "<string>",
  "call_from": "<string>",
  "call_to": "<string>",
  "agent_dynamic_variables": {},
  "call_direction": "<string>",
  "workspace": "<string>"
}'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_sid": "<string>",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_provider": "<string>",
    "call_from": "<string>",
    "call_to": "<string>",
    "call_duration": 123,
    "call_status": "<string>",
    "call_direction": "<string>",
    "is_test": true,
    "call_rating": 123,
    "call_feedback": "<string>",
    "record_url": "<string>",
    "transcript": "<string>",
    "transcript_object": {},
    "transcript_language": "<string>",
    "cost": 123,
    "price_unit": "<string>",
    "latency": 123,
    "disconnect_reason": "<string>",
    "analysis_sentiment": "<string>",
    "agent_task_status": "<string>",
    "agent_task_feedback": "<string>",
    "metadata": {},
    "agent_dynamic_variables": {},
    "agent_post_call_outcomes": {},
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "retry_at": "2023-11-07T05:31:56Z",
    "workspace_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

call to add to the store

Data required to create a new call.

​
campaign_id
string<uuid>
required

Identifier of the campaign this call is part of

​
ai_agent_id
string<uuid>
required

Identifier of the AI agent to be used for the call

​
call_sid
string
required

Call SID identifier from the provider

​
call_from
string
required

The phone number or identifier to call from

​
call_to
string
required

The phone number or identifier to call to

​
call_direction
string
required

Direction of the call (e.g., outbound, inbound)

​
workspace
string
required

Identifier for the workspace where this call is being made

​
contact_id
string<uuid> | null

Optional: Identifier of the contact to be called

​
agent_dynamic_variables
object | null

Optional: Initial dynamic variables for the AI agent

Response

call response

​
status
string
required

Status of the response, e.g., 'ok' or 'error'

​
message
string
required

A descriptive message for the response

​
data

The data payload, which can be the created call or an error string. Detailed information about a call.