GET
Mandatory parameters:
| Name | Type | Description |
|---|---|---|
| from_date | string | Inclusive lower bound on call start time. YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. |
| to_date | Inclusive upper bound on call start time. Same formats. Must not be before from_date. |
Optional parameters:
| Name | Type | Description |
|---|---|---|
| pagesize | integer | Records per page, 1–100. Default 100. |
| cursos | string | Opaque pagination token from a previous response's next_cursor. Omit for the first page. |
Output
Envelope fields
| Field | Type | Description |
| pagesize | integer | Echo of the effective page size. |
| has_more | boolean | true if more records exist after this page. |
| next_cursor | string | null | Token for the next page. null on the final page. Treat as opaque — its format may change without notice. |
| recording_analyses | array | The analysis records, ordered oldest call first. |
| Field | Type | Description |
|---|---|---|
| recording_id | string (UUID) | The call recording this analysis belongs to. Usable with the /recordings endpoints. |
| cdr_id | string (numeric) | Call detail record id. Joins directly to cdr_id in /statistics/cdrs (inbound) / /statistics/cdrs_out (outbound) responses. |
| call_start | string (datetime) | Call start time, YYYY-MM-DD HH:MM:SS. |
| expired | boolean | true if the underlying audio file has been deleted (retention). The analysis remains available; the recording itself is no longer retrievable. |
| pickup_type | string | null | How the call was answered, e.g. Human, IVR. |
| waiting_time | string (numeric) | null | Seconds before pickup. |
| call_disposition | string | null | Outcome classification, e.g. Conversation, No Message. |
| inventory_status | string | null | Inventory availability discussed on the call, where applicable. |
| physical_appointment | boolean | Whether a physical appointment was made. |
| human_connection | boolean | Whether the caller reached a human. |
| conversation_topics | array | Detected topics: [{ "topic": "...", "snippet": "..." }, ...]. Empty array when none. |
| call_category | string | null | AICA call category. |
| summary | string | null | Natural-language summary of the call. |
| full_transcript | string | null | Full transcription |
Note: numeric values originating from the database (cdr_id, waiting_time) are serialised as JSON strings. Parse accordingly.
POST
Not supported.
PUT
Not supported.
DELETE
Not supported.
Comments
0 comments
Please sign in to leave a comment.