Export calls
Export calls to a CSV file. The CSV file will be available for download for 24 hours. The export will be performed asynchronously. The task status can be checked with the Tasks endpoints: when the task is done, its result contains the url of the CSV file.
The CSV file is UTF-8 (with a BOM). Its columns are the fields of the call webhooks (direction, callid, callerNumber, callee, started, durationBilled, billingDebit...). The separator is ; for the accounts in French, , otherwise. You can export calls up to 24 months back.
You cannot export more than 31 days of calls at once. If you need to export more than 31 days, you will need to split the export in multiple requests.
Exporting calls is a heavy operation. It can take a long time to complete, depending on the amount of calls to export. That is why you are limited to a maximum of 5 exports per day.
If you need to process calls in real-time, you should use webhooks, or the fetch action with Callr Actions.
Request
- Base URLhttps://api.callr.com/v2.0
- URLhttps://api.callr.com/v2.0/calls/export
- Auth
- API key in header x-api-key
- or HTTP basic
Query parameters
The direction. Inbound is a call or an SMS received by the Callr platform. Outbound is a call or an SMS initiated by the Callr platform.
RFC 3339, section 5.6
RFC 3339, section 5.6
Short ID
The SID of the scenario that was used to process the calls. If you want to export all calls, regardless of the scenario, you can omit this parameter.
A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"
A Callr phone number you own that received the calls. With direction inbound, this will export the inbound calls received on this number. With direction outbound, this will export the outbound calls forwarded by this number.
Response
Export is running (Task ID in response)
Task ID
Example response
"sampleTaskID1234567890abcdef0000"
Changes
No recorded changes to this operation across all 2 revisions of this API.