Peek at the next contacts to be dialed
Returns, in order, the contacts the allocator would serve next — a read-only, NON-BINDING snapshot. Nothing is held, locked or recorded, so any of these contacts may be taken by an agent a moment later; treat the answer as a display hint, never a reservation. There is no partner-facing way to claim a contact.
A campaign that exists but is not active, or whose queue is empty, answers 200 with an empty array — never 404. Contacts already held by an agent and contacts whose eligibility lies in the future are excluded. Callbacks pinned to a specific agent are not visible on this surface until their pin lapses.
Unknown query parameters are rejected with 400 rather than ignored.
Authorizations
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
Dialer campaign ID.
^[1-9][0-9]*$Query Parameters
How many contacts to peek at. Defaults to the campaign's queue_policy.lock_size.
1 <= x <= 100Response
The next contacts in dialing order — a bare array, empty when nothing is dialable.
Membership row ID.
"5100"
The contact's ID in Contacts.
"88213"
Waterfall category the pick came from.
"fresh"
The contact's numbers in dialing order (index 0 is primary).
Contact display name.
"Jane Kowalski"
Contact's IANA timezone.
"Europe/Bratislava"
Note attached to a scheduled callback; null otherwise.
null