v1

latestSwagger 2.02026-08-06114161439.7 KB

call

List of calls including the detail record

Retrieves call records with extended detail fields beyond the basic call list. Returns comprehensive call data including duration, cost, routing path, recording URLs, transcription data, custom fields, tags, and campaign information. Supports pagination and advanced filtering.

get/call/detail

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

recordURLboolean

Boolean toggle. If true, include a signed URL to download the call recording. Default false.

fetchCommentboolean

Boolean toggle. If true, include all comments associated with the call in the response. Default false.

Response

Call records with detailed metadata, recordings, transcriptions, and custom fields

call_idinteger

Unique identifier for the call record. Integer. Use as the primary key when cross-referencing other endpoints (e.g., /call/transcription, /call/tag).

call_flow_idinteger required

Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

Call outcome classification. Enum: ANSWERED, BUSY, FAILED, NO ANSWER, NONE, HANGUP. Default NONE. Set by carrier response plus in-call behavior.

durationinteger

Total call length in seconds (integer). Includes the entire connected segment from answer to hangup.

caller_idstring required

Phone number of the originating caller. String of digits, typically 10 digits for US numbers (e.g., '2025550123').

tracking_numberstring required

Phone number the caller dialed (the tracking/DNI number). Convirza routes calls from this number through the configured call flow. String of digits.

ring_tostring required

Phone number the call was ultimately forwarded to (the agent/business line). String of digits.

default_ring_tostring

Default ring-to number configured on the call flow (before any dynamic routing). String of digits.

repeat_callboolean

Boolean. True if this caller has previously called a tracking number in this account. Default false.

call_startedstring date-time required

Timestamp when the call started. ISO 8601 date-time with timezone (e.g., '2024-03-01T14:22:10.000-07:00').

ai_caller_identitystring

The name of the caller associated with the caller ID. Type: string.

bill_secondinteger

Billable call duration rounded up to the nearest 30-second interval. Integer, in seconds.

external_idstring

Customer-provided identifier used to map this call to a record in the customer's own system. String. Must be unique within the customer's org.

recording_filestring

Filename of the call recording in Convirza's storage. String. Use recordURL=true to also fetch a signed download URL.

call_valueinteger

Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config).

dni_log_idstring

UUID string referencing the DNI session that produced this call. Use /call/dni to fetch the full session details.

is_outboundboolean

Boolean. True if the call was placed by an agent/voice-agent outbound; false for inbound.

is_spamboolean

Indicates if the call is marked as spam

call_mine_status'not mined' | 'mined' | 'pending' | 'cancel' | 'none'

Lifecycle state of the transcription/mining process. Enum: 'not mined', 'mined', 'pending', 'cancel', 'none'. Note: exact transition rules undocumented; see TEST-9.6.

cdr_source'CE' | 'API' | 'BVR' | 'NONE' required

Source that generated the Call Detail Record. Enum: CE (Convirza carrier engine), API (uploaded via /call/upload), BVR (legacy voice response), NONE.

call_endedstring date-time required

Timestamp when the call ended. ISO 8601 date-time with timezone.

call_createdstring date-time

Timestamp when the call record was persisted in Convirza. ISO 8601 date-time. May trail call_started if the record was uploaded later via API.

mined_timestampstring date-time

Timestamp when the call audio was processed through Convirza's ASR (transcription) pipeline. ISO 8601 date-time. Null if the call has not yet been mined.

ring_to_namestring

Name associated with the ring-to phone number (agent name). String.

analytic_statusstring

Lifecycle state of the conversation analytics (scoring) process. String, values include states like 'pending', 'complete'. Exact enum and transitions undocumented; see TEST-9.6.

channel_idinteger

Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels.

channel_categorystring

Top-level marketing channel category (e.g., 'Paid Search', 'Organic', 'Social').

channel_sub_categorystring

Sub-category within the parent channel (e.g., 'Google', 'Bing').

channelstring

Human-readable channel label derived from category + sub_category (e.g., 'Paid Search - Google').