Skip to main content
GET
/
{phone_number_id}
/
calls
List calls
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{phone_number_id}/calls \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "call_id": "call_abc123",
      "direction": "inbound",
      "status": "completed",
      "duration_seconds": 180,
      "started_at": "2024-01-15T12:34:56.123456Z",
      "ended_at": "2024-01-15T12:37:56.123456Z",
      "session_started_at": "2024-01-15T12:34:58.123456Z",
      "created_at": "2024-01-15T12:34:56.000000Z",
      "updated_at": "2024-01-15T12:37:56.000000Z",
      "user_wa_id": "15551234567",
      "whatsapp_contact_id": "223e4567-e89b-12d3-a456-426614174001",
      "whatsapp_conversation_id": "323e4567-e89b-12d3-a456-426614174002",
      "project_id": "423e4567-e89b-12d3-a456-426614174003",
      "whatsapp_config_id": "523e4567-e89b-12d3-a456-426614174004",
      "config_display_name": "Support Line",
      "config_display_phone_number": "+1 (555) 123-4567",
      "voice_agent_id": "623e4567-e89b-12d3-a456-426614174005",
      "voice_agent_name": "Customer Support Agent",
      "phone_number_id": "110987654321",
      "voice_agent": {
        "id": "623e4567-e89b-12d3-a456-426614174005",
        "name": "Customer Support Agent"
      },
      "whatsapp_contact": {
        "id": "223e4567-e89b-12d3-a456-426614174001",
        "wa_id": "15551234567",
        "profile_name": "John Doe",
        "display_name": "John (VIP Customer)"
      },
      "whatsapp_conversation": {
        "id": "323e4567-e89b-12d3-a456-426614174002",
        "phone_number": "15551234567",
        "status": "active",
        "last_active_at": "2024-01-15T14:30:00.000000Z"
      }
    },
    {
      "id": "724e4567-e89b-12d3-a456-426614174006",
      "call_id": "call_def456",
      "direction": "outbound",
      "status": "failed",
      "duration_seconds": null,
      "started_at": "2024-01-15T10:20:15.123456Z",
      "ended_at": null,
      "session_started_at": null,
      "created_at": "2024-01-15T10:20:15.000000Z",
      "updated_at": "2024-01-15T10:20:30.000000Z",
      "user_wa_id": "15559876543",
      "whatsapp_contact_id": "824e4567-e89b-12d3-a456-426614174007",
      "whatsapp_conversation_id": null,
      "project_id": "423e4567-e89b-12d3-a456-426614174003",
      "whatsapp_config_id": "523e4567-e89b-12d3-a456-426614174004",
      "config_display_name": "Support Line",
      "config_display_phone_number": "+1 (555) 123-4567",
      "voice_agent_id": null,
      "voice_agent_name": null,
      "phone_number_id": "110987654321",
      "voice_agent": null,
      "whatsapp_contact": {
        "id": "824e4567-e89b-12d3-a456-426614174007",
        "wa_id": "15559876543",
        "profile_name": "Jane Smith",
        "display_name": null
      },
      "whatsapp_conversation": null
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNVQxMDoyMDoxNS4wMDAwMDBaIiwiNzI0ZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA2Il0sImNvbHVtbnMiOlsiY2FsbF90aW1lc3RhbXAiLCJpZCJdfQ=="
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Query Parameters

​
direction
enum<string>

Filter by call direction

Available options:
inbound,
outbound
​
status
enum<string>

Filter by call status

Available options:
initiated,
ringing,
answered,
completed,
failed
​
since
string<date-time>

Filter calls started on or after this time (ISO 8601)

​
until
string<date-time>

Filter calls started on or before this time (ISO 8601)

​
limit
integer
default:20

Maximum number of results per page (default 20, max 100)

Required range: 1 <= x <= 100
​
before
string

Cursor for previous page (Base64 encoded)

​
after
string

Cursor for next page (Base64 encoded)

​
fields
string

Filter response fields

Response

Successfully retrieved calls

​
data
object[]
required
​
paging
object