Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
API endpoints for retrieving call logs, live calls, recordings, and call statistics.
GET /api/v1/calls
| Parameter | Type | Description |
|---|---|---|
limit | number | Records per page (1-200, default: 20) |
offset | number | Records to skip |
direction | string | Filter: inbound, outbound, or internal |
disposition | string | Filter: ANSWERED, NO ANSWER, FAILED, BUSY |
from | string | Filter by caller number |
to | string | Filter by destination number |
date_from | string | Start date (ISO format) |
date_to | string | End date (ISO format) |
search | string | Search across all fields |
curl -X GET "https://your-server:8000/api/v1/calls?limit=10&direction=inbound" \
-H "X-API-Key: ak_your_api_key"
{
"data": [
{
"id": "123",
"from_number": "9944421125",
"to_number": "1001",
"direction": "inbound",
"status": "ANSWERED",
"duration": 145,
"talk_time": 120,
"started_at": "2026-04-13T10:30:00Z",
"ended_at": "2026-04-13T10:32:25Z",
"recording_url": "/api/v1/calls/123/recording"
}
],
"total": 150,
"page": 1,
"pages": 15
}
GET /api/v1/calls/live
curl -X GET https://your-server:8000/api/v1/calls/live \
-H "X-API-Key: ak_your_api_key"
[
{
"channel_id": "PJSIP/1001-00000001",
"from": "9944421125",
"to": "1001",
"direction": "inbound",
"status": "answered",
"duration": 45
}
]
GET /api/v1/calls/count
GET /api/v1/calls/stats
{
"total_calls": 1250,
"inbound": 800,
"outbound": 350,
"internal": 100,
"answered": 1100,
"missed": 150,
"avg_duration": 180,
"weekly": [
{"date": "2026-04-07", "inbound": 120, "outbound": 50},
{"date": "2026-04-08", "inbound": 115, "outbound": 55}
]
}
GET /api/v1/calls/{callId}/recording
calls.recording permission. Returns the audio file directly.
curl -X GET "https://your-server:8000/api/v1/calls/123/recording" \
-H "X-API-Key: ak_your_api_key" \
-o recording.wav
GET /api/v1/calls/{linkedId}/journey
{
"linkedid": "abc-123",
"caller": "9944421125",
"destination": "1001",
"status": "answered",
"total_duration": 145,
"answered_by": "1001",
"steps": [
{
"time": "2026-04-13T10:30:00Z",
"action": "Queue",
"from": "9944421125",
"to": "5001",
"duration": 25,
"status": "queued"
},
{
"time": "2026-04-13T10:30:25Z",
"action": "Bridged",
"from": "9944421125",
"to": "1001",
"duration": 120,
"status": "answered"
}
]
}
POST /api/v1/calls/transfer
{
"call_id": "PJSIP/1001-00000001",
"destination": "1002",
"type": "blind"
}
POST /api/v1/calls/hangup-channel
{
"channel_id": "PJSIP/1001-00000001",
"reason": "normal"
}