Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Calls
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
    • Create Broadcast
    • Get Broadcast Details
    • Update Broadcast
    • Partial Update Broadcast
    • Delete Broadcast
  • Conversation
    • Calls
      • Get Calls List
        GET
      • Get Call By ID
        GET
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. Calls

Get Calls List

GET
https://platform-api.convirza.com/v3/conversations/calls
Calls
Last modified:2026-04-20 16:23:14
Returns a paginated list of inbound and outbound calls within a specified date range, with optional filtering and enrichment via the include parameter.
Date range (optional, defaults to last 7 days)
start and end are optional ISO 8601 timestamps (UTC). If omitted, the API returns calls from the last 7 days. The range must not exceed 31 days. end must be strictly greater than start.
Pagination
Use limit (1–200, required) and offset (0-based, default 0) to page through results. The response includes a total count so clients can calculate total pages.
Filtering
All filters are optional and can be combined:
org_unit_id — scope to a specific organizational unit (must be within your account hierarchy).
campaign_id — scope to a specific campaign.
provisioned_route_id — scope to a specific call flow / tracking number configuration.
call_id — retrieve a single call record by its unique identifier (forces single-record mode, ignores date range and pagination).
caller_id — filter by caller phone number (E.164 format, e.g. +15551234567).
phone_number — filter by the phone number the call came in on.
ring_to — filter by the destination number the call was routed to.
disposition — filter by one or more call outcomes. Accepted values: ANSWERED, NO ANSWER, BUSY, FAILED, VOICEMAIL, ABANDONED, TRANSFERRED.
Optional module datasets (include)
Attach supplemental data blocks to each call record by listing module names (comma-separated or repeated param):
tags — call tags attached by agents or automation rules.
comments — agent notes and disposition comments.
custom_sources — UTM and custom tracking parameters captured at call time.
call_flow — the call flow configuration the call was processed through.
recordings — Signed URLs to call recording audio files. Each URL is valid for 7 days from the time of fetch (see expires_at Unix timestamp in recording_details). Accessing an expired URL returns HTTP 410 Gone with the message "Recording URL has expired. Please re-fetch the call to get a fresh link." — re-request the call with include=recordings to get a new URL.
transcription — AI-generated call transcription text.
Authorization
Results are automatically scoped to the organizational units accessible to the authenticated user. Requesting an org_unit_id outside your account scope returns a 403 error.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

🟢200
application/json
Calls returned successfully
Body

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://platform-api.convirza.com/v3/conversations/calls?start&end&limit&offset&call_id&org_unit_id&campaign_id&provisioned_route_id&disposition&caller_id&phone_number&ring_to&include' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "Success",
    "data": {
        "total": 42,
        "calls": [
            {
                "call_id": 987654,
                "provisioned_route_id": 1022,
                "org_unit_id": 1200,
                "disposition": "ANSWERED",
                "duration": 182,
                "caller_id": "18015551234",
                "phone_number": "18015557654",
                "ring_to": "18015550000",
                "default_ring_to": "18015550000",
                "repeat_call": false,
                "call_started": "2026-02-14T18:20:12.000Z",
                "campaign_id": 311,
                "campaign_name": "Roofing Q1",
                "campaign_ext_id": "EXT-001",
                "user_id": 1001,
                "group_name": "Roofing Division",
                "ai_caller_identity": "Jane Smith",
                "voiceagent_data": {
                    "voiceagent_id": 42,
                    "voiceagent_name": "Customer Support Agent",
                    "outcome": true,
                    "summary": "Customer scheduled appointment for roof inspection",
                    "first_name": "John",
                    "last_name": "Doe",
                    "phone_number": "+15551234567",
                    "requested_time": "2026-03-20T14:30:00.000Z",
                    "appointment_date": "2026-03-20",
                    "appointment_time": "14:30",
                    "additional_info": {
                        "service_type": "roof_inspection",
                        "notes": "Prefer morning appointments"
                    }
                },
                "recording_details": {
                    "recording_id": 1000,
                    "filename": "76c1U4NX_1720457390749",
                    "url": "https://api.convirza.com/v3/recordings/987654?secret=...&access=...&expires=...&file_name=76c1U4NX_1720457390749.mp3",
                    "expires_at": 1775462400,
                    "channel_layout": "mono",
                    "frequency": "8000 Hz",
                    "format": "wav",
                    "duration": "00:41:36.60",
                    "bitrate": "128 kb/s",
                    "size": "39009kB"
                },
                "call_detail": {
                    "bill_second": 210,
                    "call_value": 75,
                    "dni_log_id": "9d5f...",
                    "is_outbound": false,
                    "cdr_source": "CE",
                    "call_ended": "2026-02-14T18:23:14.000Z",
                    "analytic_status": "complete",
                    "call_mine_status": "mined",
                    "call_created": "2026-02-14T18:20:12.000Z",
                    "mined_timestamp": "2026-02-14T18:25:00.000Z",
                    "ring_to_name": "Sales Team",
                    "channel_id": 4,
                    "channel_category": "Digital",
                    "channel_sub_category": "Paid Search",
                    "channel": "Digital > Paid Search"
                },
                "custom_sources": {
                    "custom_source_type_1": {
                        "custom_source_id": 445,
                        "custom_source_name": "Google Ads",
                        "custom_source_created": "2026-01-10T12:00:00.000Z"
                    },
                    "custom_source_type_2": {
                        "custom_source_id": 445,
                        "custom_source_name": "Google Ads",
                        "custom_source_created": "2026-01-10T12:00:00.000Z"
                    },
                    "custom_source_type_3": {
                        "custom_source_id": 445,
                        "custom_source_name": "Google Ads",
                        "custom_source_created": "2026-01-10T12:00:00.000Z"
                    },
                    "custom_source_type_4": {
                        "custom_source_id": 445,
                        "custom_source_name": "Google Ads",
                        "custom_source_created": "2026-01-10T12:00:00.000Z"
                    },
                    "custom_source_type_5": {
                        "custom_source_id": 445,
                        "custom_source_name": "Google Ads",
                        "custom_source_created": "2026-01-10T12:00:00.000Z"
                    }
                },
                "tags": [
                    {
                        "tag_id": 1,
                        "ct_user_id": 1001,
                        "call_tag_created": "2026-02-14T18:30:00.000Z",
                        "tag_name": "Lead",
                        "tag_created": "2026-01-01T12:00:00.000Z",
                        "tag_active": true
                    }
                ],
                "comments": [
                    {
                        "note_id": 123,
                        "call_id": 987654,
                        "note": "Customer asked for pricing details.",
                        "created_on": "2026-02-14T18:40:00.000Z",
                        "updated_on": "2026-02-14T18:42:00.000Z",
                        "ct_user_id": 2001,
                        "first_name": "Alex",
                        "last_name": "Smith"
                    }
                ],
                "indicators": [
                    {
                        "indicator_id": 18,
                        "score_id": 4567,
                        "score_value": 82,
                        "indicator_name": "Conversion",
                        "external_id": "conv-01",
                        "indicator_active": true,
                        "indicator_created": "2025-12-01T00:00:00.000Z",
                        "agent": "agent@email.com",
                        "scorecard": "Sales Scorecard",
                        "outcome": "won"
                    }
                ],
                "summary": "Customer asked about financing.",
                "transcription": "Caller: I need a roof inspection..."
            }
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}
Modified at 2026-04-20 16:23:14
Previous
Delete Broadcast
Next
Get Call By ID
Built with