Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Call Management

Retrieve All Calls

Retrieve a list of all calls (CDRs) for your account with optional filtering by date, status, and direction.

This endpoint returns a paginated list of call detail records (CDRs) for your account. You can filter results by date range, call direction, end time, and more. This is useful for generating reports, reconciling billing, or analyzing call patterns.

Note: Results are returned in reverse chronological order (newest first) by default. Use pagination parameters to retrieve large result sets efficiently.

Performance Tip: For better performance, always specify a date range usingend_time__gte andend_time__lte parameters.

HTTP Request

GEThttps://api.vobiz.ai/api/v1/Account/{auth_id}/Call/

Path Parameters

auth_idstringRequired

Your Vobiz authentication ID

Query Parameters

All parameters are optional and can be combined to filter results.

Filtering Parameters

NameTypeDescription
status
stringFilter by call status. Values: "queued", "ringing", "in-progress", "completed", "failed", "busy", "no-answer", "canceled".

Pagination Parameters

NameTypeDescription
limit
integerNumber of results to return. Default: 20. Maximum: 100.
offset
integerNumber of results to skip for pagination. Default: 0.

Response

Returns a paginated list of Call objects with metadata about the result set.

Response - 200 OK
{
  "api_id": "uuid-here",
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 150,
    "previous": null,
    "next": "/v1/Account/{auth_id}/Call/?limit=20&offset=20"
  },
  "objects": [
    {
      "call_uuid": "call-uuid-1",
      "from": "14155551234",
      "to": "14155555678",
      "status": "completed",
      "duration": 120,
      "created_at": "2025-01-15T10:30:00Z"
    }
  ]
}

Response Fields

api_id - Unique identifier for this API request
meta - Pagination metadata including total count and next/previous page URLs
objects - Array of Call objects (see Call Object for field descriptions)

Example Request

Retrieve All Calls

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?limit=20&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Filter Calls by Status

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?status=completed&limit=20&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Retrieve with Pagination

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?limit=50&offset=50" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Use Cases

  • •Generate monthly billing reports and reconcile charges
  • •Analyze call patterns to optimize routing and capacity
  • •Export CDRs for compliance and audit requirements
  • •Monitor call quality metrics across your infrastructure
  • •Identify high-cost destinations or unusual call volumes
  • •Build custom dashboards and analytics tools

Best Practice: When retrieving large datasets, use the next URL from the meta object to paginate through results efficiently. This ensures you don't miss any records.

Hangup a Call
Retrieve a Live Call