Create Call

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",
  "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_sid": "<string>",
  "call_from": "<string>",
  "call_to": "<string>",
  "call_direction": "<string>",
  "workspace": "<string>",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_dynamic_variables": {}
}
'

{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_sid": "<string>",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ai_agent_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,
    "cost": 123,
    "price_unit": "<string>",
    "latency": 123,
    "disconnect_reason": "<string>",
    "analysis_sentiment": "<string>",
    "agent_task_status": "<string>",
    "agent_task_feedback": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "workspace_id": "<string>",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_feedback": "<string>",
    "record_url": "<string>",
    "transcript": "<string>",
    "transcript_object": {},
    "transcript_language": "<string>",
    "metadata": {},
    "agent_dynamic_variables": {},
    "agent_post_call_outcomes": {},
    "notes": "<string>",
    "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"
  }
}

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",
  "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_sid": "<string>",
  "call_from": "<string>",
  "call_to": "<string>",
  "call_direction": "<string>",
  "workspace": "<string>",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_dynamic_variables": {}
}
'

{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_sid": "<string>",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ai_agent_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,
    "cost": 123,
    "price_unit": "<string>",
    "latency": 123,
    "disconnect_reason": "<string>",
    "analysis_sentiment": "<string>",
    "agent_task_status": "<string>",
    "agent_task_feedback": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "workspace_id": "<string>",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "call_feedback": "<string>",
    "record_url": "<string>",
    "transcript": "<string>",
    "transcript_object": {},
    "transcript_language": "<string>",
    "metadata": {},
    "agent_dynamic_variables": {},
    "agent_post_call_outcomes": {},
    "notes": "<string>",
    "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"
  }
}

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

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.

Show child attributes

data.id

string<uuid>

required

Unique identifier for the call

data.call_sid

string

required

Call SID from the provider (e.g., Twilio SID)

data.company_id

string<uuid>

required

Identifier of the company associated with this call

data.ai_agent_id

string<uuid>

required

Identifier of the AI agent that handled or is related to this call

data.call_provider

string

required

Name of the call provider (e.g., Twilio, Vonage)

data.call_from

string

required

Caller's phone number or identifier

data.call_to

string

required

Recipient's phone number or identifier

data.call_duration

integer<int32>

required

Duration of the call in seconds. For non-completed calls, this might be 0 or current duration.

data.call_status

string

required

Current status of the call (e.g., ringing, in-progress, completed, failed, busy, no-answer)

data.call_direction

string

required

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

data.is_test

boolean

required

Flag indicating if this is a test call

data.call_rating

integer<int32>

required

Rating assigned to the call (e.g., 1-5 stars)

data.cost

number<double>

required

Cost incurred for this call

data.price_unit

string

required

Currency or unit of the price (e.g., USD)

data.latency

integer<int32>

required

Network or processing latency associated with the call in milliseconds

data.disconnect_reason

string

required

Reason for call disconnection if it did not complete normally

data.analysis_sentiment

string

required

Overall sentiment analysis result for the call (e.g., positive, neutral, negative)

data.agent_task_status

string

required

Status of any automated agent task associated with the call

data.agent_task_feedback

string

required

Feedback or result from the agent's task

data.created_at

string<date-time>

required

Timestamp indicating when the call record was created in the system

data.updated_at

string<date-time>

required

Timestamp indicating when the call record was last updated

data.workspace_id

string

required

Identifier for the workspace this call belongs to

data.campaign_id

string<uuid> | null

Identifier of the campaign this call belongs to, if any

data.contact_id

string<uuid> | null

Identifier of the contact involved in this call, if any

data.call_feedback

string | null

Textual feedback provided for the call

data.record_url

string<uri> | null

URL of the call recording, if available

data.transcript

string | null

Full text transcript of the call

data.transcript_object

object

Structured transcript object (e.g., JSON array of segments with speaker and text)

data.transcript_language

string | null

Detected language of the transcript (e.g., 'en-US')

data.metadata

object

Additional custom key-value data associated with the call

data.agent_dynamic_variables

object

Dynamic variables used or populated by the AI agent during the call

data.agent_post_call_outcomes

object

Structured outcomes or data points recorded by the agent after the call

data.notes

string | null

User-added notes related to the call

data.deleted_at

string<date-time> | null

Timestamp indicating when the call record was soft-deleted, if applicable

data.started_at

string<date-time> | null

Timestamp indicating when the call actually started (e.g., when answered)

data.ended_at

string<date-time> | null

Timestamp indicating when the call actually ended

data.retry_at

string<date-time> | null

Timestamp for the next scheduled retry attempt, if applicable

⌘I

API Documentation

Calls API

Phone Numbers

Company Users

Contacts

Campaigns

AI Agents

Workspaces

Webhooks

integrations

Modules

Authorizations

Body

Response