Export CDRs as CSV
Returns CDR data as a downloadable CSV file. Same filters as the list endpoint.
Note: Do NOT send Accept: application/json on this endpoint - the response is text/csv.
Request
- Base URLhttps://api.vobiz.ai
- AuthAPI key in header X-Auth-ID and API key in header X-Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Your account Auth ID
Query parameters
Filter by the originating phone number (caller).
Filter by the destination phone number (callee).
Beginning of the search period (YYYY-MM-DD). Required when using end_date.
End of the search period (YYYY-MM-DD). Required when using start_date.
Filter by direction.
Minimum call duration in seconds. Excludes calls shorter than this value.
Filter by the SIP Call-ID of the call (matches the cdr's sip_call_id field).
Filter by the UUID of the bridged leg (matches the cdr's bridge_uuid field).
Filter by telephony hangup cause, e.g. NORMAL_CLEARING.
Filter by how the leg was released, e.g. send_refuse.
Filter by the call context, e.g. sip-trunking.
Filter by the campaign identifier associated with the call.
Free-text search across CDR fields (numbers, IDs, etc.).
Response
CSV file containing CDR rows
Changes
No recorded changes to this operation across all 1 revision of this API.