Skip to main content
GET
/
whatsapp_calls
List WhatsApp calls
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_calls \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "call-123abc",
      "project_id": "project-456def",
      "whatsapp_config_id": "config-789ghi",
      "config_display_name": "Customer Support Line",
      "config_display_phone_number": "+1234567890",
      "voice_agent_id": "agent-101jkl",
      "voice_agent_name": "Support Agent",
      "call_id": "wa-call-xyz123",
      "direction": "inbound",
      "status": "completed",
      "duration_seconds": 180,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "session_started_at": "2023-11-07T05:31:56Z",
      "user_wa_id": "1234567890",
      "whatsapp_contact_id": "contact-202mno",
      "whatsapp_conversation_id": "conversation-303pqr",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
status
string

Filter by call status

​
direction
enum<string>

Filter by call direction

Available options:
inbound,
outbound
​
voice_agent_id
string<uuid>

Filter by voice agent ID

​
whatsapp_config_id
string<uuid>

Filter by WhatsApp configuration ID

​
period
enum<string>

Filter by time period

Available options:
today,
week,
month,
custom
​
start_date
string<date-time>

Start date for custom period (ISO 8601 format)

​
end_date
string<date-time>

End date for custom period (ISO 8601 format)

Response

A list of WhatsApp calls

​
data
object[]
​
meta
object