Skip to navigation

Export caller data

Returns everything the platform keeps about a phone number for your organization, to answer a request of access or portability (GDPR art. 15 and 20): every call in the shape of GET /calls/{call_id} with its transcript, every outbound contact with the values you loaded and the origin you declared, and the objection. The export is recorded in the register as an access request, with the one-month deadline counted from received_at. Live keys only. A number with more than 200 calls cannot be exported here. Required scope: caller_requests:manage. It is not available with a test key (vx_test_): the response is 403 not_available_in_test_mode. This is a read that uses POST only so that its input (a phone number, a search text) travels in the body and never in the URL. It takes no Idempotency-Key, nothing is stored, and the response is never cached or repeated.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Request

This endpoint expects an object.
phone_numberstringRequiredformat: "^\+[1-9][0-9]{6,14}$"

The phone number of the person, in international format (E.164), for example +393331234567. It travels only in the request body.

received_atdatetimeOptional

When you received the person’s request (ISO 8601). It starts the one-month deadline of GDPR art. 12(3). Default: now. Not earlier than 365 days ago and not in the future.

referencestringOptionalformat: "^[A-Za-z0-9._:-]{1,64}$"

Your own reference for the request, for example the case number: 1 to 64 letters, digits, dots, underscores, colons or hyphens. It must not be personal data.

Response

Successful response.
object"caller_data_export"

Always caller_data_export.

request_idstringformat: "uuid"

The id of the request in the register (GET /caller-requests).

generated_atdatetime
When the export was made, ISO 8601 UTC.
callslist of objects

Every call of this number, each in the shape of GET /calls/{id} plus its transcript. At most 200: beyond that the export is refused.

contactslist of objects
Every outbound contact with this number.
objectionobject

The do-not-call list of the organization: active is true if this number has objected to being called.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error