Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
call

List of calls with indicator scores associated to call

Retrieves call records with conversation intelligence indicator scores. Returns calls along with AI-generated scores for metrics such as sentiment, call quality, and outcome probability. Supports pagination and filtering.

get/call/indicator

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.

show_all_callsboolean

Boolean toggle. If true, include calls with or without indicator data. Default false (only calls with indicators).

Response

Call records with AI-generated indicator scores and analytics

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.

disposition'ANSWERED' | 'BUSY' | 'FAILED' | 'NO ANSWER' | 'NONE' | 'HANGUP'

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').

agentstring

The assigned agent to call. Type: string.

scorecardstring

The scorecard assigned to call. Type: string.

outcomeboolean

Outcome of the call. Type: boolean.