Skip to main content
POST
Request a campaign data export
The Dialer is a newly released product surface: depending on your account’s rollout stage, campaigns managed through this API may not yet be visible in your CloudTalk Dashboard.

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

campaignId
string
required

Dialer campaign ID.

Pattern: ^[1-9][0-9]*$

Body

application/json

Body of the export enqueue call.

type
enum<string>
required

What to export. call_history exports the campaign's dial log; survey_responses exports answers collected by the campaign's survey.

Available options:
call_history,
survey_responses
Example:

"call_history"

format
enum<string>
required

Serialisation format of the generated file.

Available options:
csv,
xlsx
Example:

"csv"

filters
object

Optional narrowing filters. Omitting the whole object exports everything for the campaign.

Response

The export job was accepted and queued.

Handle for a queued export job. Poll it with the export-status call.

jobId
string<uuid>

Export job ID.

Example:

"0197fbd1-6d0a-7e58-8f6f-1a2b3c4d5e6f"

status
enum<string>

Job status at the moment of enqueue.

Available options:
queued,
running,
completed,
failed
Example:

"queued"