Skip to content
Calls

Export calls history

POST/call/export

Export calls as a CSV file, one line per call, selected with the filters of POST /call/search. Large exports are split into files of at most 4 MB: when the response carries a non-null next_offset, call the endpoint again with that value as offset to get the next file.

Request body

  • filtersobjectrequired

    Which calls to export, as in POST /call/search; page and page_size select the window of calls to export. to_phone_number and call_ids are not applied.

  • offsetinteger

    Number of already-exported rows to skip, within the filters' page/page_size window. Pass the next_offset value from the previous response to fetch the next file of a split export.

    Default 0≥ 0

  • include_structured_output_fieldsboolean

    Add one column per value extracted from the last attempt, named structured_output-<field>.

  • include_metadataboolean

    Add one column per metadata key, named metadata-<key>.

Response

200
  • csvstring

    The CSV file content, one line per call, with a header line.

  • filenamestring

    Suggested file name, e.g. 'revox-call-history-<ISO timestamp>.csv', with the row range appended for a split export.

  • next_offsetintegernullable

    Non-null when the export was split because this file reached the 4MB cap: pass it as offset in a follow-up call to get the next file. Null when this file completes the export.