List Calls

curl https://api.vozagent.ai/v1/calls \
  -H "Authorization: Bearer <token>"

[
  {
    "id": "call-a1b2c3d4-e5f6-a7b8-c9d0",
    "contact_id": "c1a2b3c4-d5e6-f7a8-b9c0",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "inbound",
    "call_status": "completed",
    "duration_seconds": 180,
    "call_started_at": "2024-01-15T10:30:00Z",
    "call_ended_at": "2024-01-15T10:33:00Z",
    "appointment_booked": true,
    "lead_qualification": "hot",
    "call_intent": "new_quote"
  },
  {
    "id": "call-b2c3d4e5-f6a7-b8c9-d0e1",
    "contact_id": "d2b3c4d5-e6f7-a8b9-c0d1",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "outbound",
    "call_status": "completed",
    "duration_seconds": 95,
    "call_started_at": "2024-01-15T11:00:00Z",
    "call_ended_at": "2024-01-15T11:01:35Z",
    "appointment_booked": false,
    "lead_qualification": "warm"
  }
]

GET

calls

curl https://api.vozagent.ai/v1/calls \
  -H "Authorization: Bearer <token>"

[
  {
    "id": "call-a1b2c3d4-e5f6-a7b8-c9d0",
    "contact_id": "c1a2b3c4-d5e6-f7a8-b9c0",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "inbound",
    "call_status": "completed",
    "duration_seconds": 180,
    "call_started_at": "2024-01-15T10:30:00Z",
    "call_ended_at": "2024-01-15T10:33:00Z",
    "appointment_booked": true,
    "lead_qualification": "hot",
    "call_intent": "new_quote"
  },
  {
    "id": "call-b2c3d4e5-f6a7-b8c9-d0e1",
    "contact_id": "d2b3c4d5-e6f7-a8b9-c0d1",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "outbound",
    "call_status": "completed",
    "duration_seconds": 95,
    "call_started_at": "2024-01-15T11:00:00Z",
    "call_ended_at": "2024-01-15T11:01:35Z",
    "appointment_booked": false,
    "lead_qualification": "warm"
  }
]

Retrieve your API Key from your VozAgent Dashboard.

Query parameters

number

default:"50"

Maximum number of calls to return. Range: 0-100.

number

Pagination offset.

string

Filter by status: completed, in-progress, failed.

string

Filter calls by contact ID.

string

Filter calls by assistant ID.

string

Filter by type: inbound or outbound.

Response

Returns an array of call records with summary information.

string

Unique call identifier.

string

Associated contact ID.

string

Assistant that handled the call.

string

inbound or outbound.

string

Current status of the call.

number

Call duration in seconds.

boolean

Whether an appointment was booked.

string

Lead score: hot, warm, or cold.

curl https://api.vozagent.ai/v1/calls \
  -H "Authorization: Bearer <token>"

[
  {
    "id": "call-a1b2c3d4-e5f6-a7b8-c9d0",
    "contact_id": "c1a2b3c4-d5e6-f7a8-b9c0",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "inbound",
    "call_status": "completed",
    "duration_seconds": 180,
    "call_started_at": "2024-01-15T10:30:00Z",
    "call_ended_at": "2024-01-15T10:33:00Z",
    "appointment_booked": true,
    "lead_qualification": "hot",
    "call_intent": "new_quote"
  },
  {
    "id": "call-b2c3d4e5-f6a7-b8c9-d0e1",
    "contact_id": "d2b3c4d5-e6f7-a8b9-c0d1",
    "assistant_id": "a1b2c3d4-e5f6-a7b8",
    "call_type": "outbound",
    "call_status": "completed",
    "duration_seconds": 95,
    "call_started_at": "2024-01-15T11:00:00Z",
    "call_ended_at": "2024-01-15T11:01:35Z",
    "appointment_booked": false,
    "lead_qualification": "warm"
  }
]

Overview

Contacts

Calls

Assistants

Phone Numbers

Webhooks

Query parameters

Response

​Query parameters

​Response

Query parameters

Response