Skip to main content
GET
Peek at the next contacts to be dialed
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]*$

Query Parameters

count
integer

How many contacts to peek at. Defaults to the campaign's queue_policy.lock_size.

Required range: 1 <= x <= 100

Response

The next contacts in dialing order — a bare array, empty when nothing is dialable.

campaign_contact_id
string

Membership row ID.

Example:

"5100"

contact_id
string

The contact's ID in Contacts.

Example:

"88213"

category
string

Waterfall category the pick came from.

Example:

"fresh"

phone_numbers
string[]

The contact's numbers in dialing order (index 0 is primary).

Example:
display_name
string | null

Contact display name.

Example:

"Jane Kowalski"

timezone
string | null

Contact's IANA timezone.

Example:

"Europe/Bratislava"

callback_notes
string | null

Note attached to a scheduled callback; null otherwise.

Example:

null