Get a recipient
Read one campaign recipient with every call, newest first, and whether the campaign counts them as converted. Each call has its attempt number, callback (true for a callback the person asked for, which uses no attempt) and redial: a double dial's second call, rung straight after an unanswered first ring, has redial true and shares the attempt number of the call before it, since it uses no attempt. Each call also has its time, result (connected, no_answer, busy, voicemail, invalid_number, failed, or calling while it rings), the carrier's hangup cause, talk time, the call's outcome and summary, whether it has a recording, and its session id for get_transcript. The recipient carries its variables, note, time zone and state, next scheduled attempt, callbackAt and callbackNote when a callback is booked (change it with set_campaign_recipient_callback), and stoppedAt when an operator stopped them. Find the recipient with list_campaign_recipients, or pass their phone number.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/workspaces/string/campaigns/string/recipients/string"{
"recipient": {
"id": "string",
"phoneNumber": "string",
"status": "string",
"property1": null,
"property2": null
},
"attempts": [
null
],
"converted": true,
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Preview who a campaign will call GET
Read the audience of a campaign and preview who it matches now: audience (null when the campaign calls only the recipients added to it), summary (one plain line a rule), and preview { matched, doNotCall, willJoin, sample }, where matched counts every contact the rules match, doNotCall those on the do-not-call list, willJoin the rest, and sample up to 20 of them in phone number order. Pass audience to preview a different filter without saving it, then save it with update_campaign while the campaign is a draft. An audience picks recipients by filtering the workspace's contacts: { rules: [...] }, and every rule must hold. A rule is { kind: 'tags', op: 'any' | 'none', tags: [...] }, or { kind: 'field', key, op, ... } on a contact field (see list_contact_fields): a text field takes equals or contains with a text value (ignoring case), or is_set or is_empty; a number field takes eq, gt, gte, lt or lte with a number value; a yes or no field takes is or is_not with true or false; a choice field takes any_of with values from its options. No rules matches every contact. Numbers on the do-not-call list are always left out. The matches join the campaign as recipients when it launches, or at its scheduled start, alongside any recipients you add (one row a number; an added recipient keeps their variables), each with the contact's name and fields as variables. The list is then locked, unless autoEnroll keeps adding contacts who start to match.
Get a campaign GET
Read one campaign in full: its config (agent, brief, opener, caller number, dialing rules, calling window, and convertedOutcomes, the outcomes it counts as converted; empty means conversion is not tracked, plus sequence, the call and SMS steps and the outcomes they end in, with each step's delay, attempts, voicemails, double dial, brief or SMS body, and routes; smsWindow, the hours SMS steps send in (null is the standard SMS hours)), per-status recipient counts, and the results analytics: recipients dialed and calls placed, connected, converted, settled, failed, not reached split into no answer, busy and voicemail, the outcome breakdown of connected calls, dials, connects and conversions over time (by hour for a campaign under 36 hours, otherwise by day, in the campaign's time zone), total and average talk time, and spend in AUD cents: spentCents is what the campaign has actually been charged (call minutes, call checks, post-call analysis and transfers, composed voicemails and SMS segments), inflightCents an estimate for calls still in progress, totalCents the two together (what the spend cap is measured against), callCents the expected cost of one call (the campaign's own average once callCentsObserved, before that the agent's rate over three minutes), and perConnectedCents and perConversionCents the spend divided by connected and converted recipients. A draft or scheduled campaign also carries readiness: { ready, blockers, warnings }, the same checklist launch_campaign enforces. Blockers stop a launch: agent_unpublished, from_number_required, from_number_not_owned, no_recipients (never for an autoEnroll campaign, which can start empty), missing_variables (a {{token}} with no fallback in the opener, a voicemail message or an SMS that no pending recipient has a value for), auto_enroll_needs_spend_cap, sms_sender_required (the sequence has an SMS step and no caller number is an Australian mobile, the only kind that can send SMS) and consent_required (always listed here, because consent is confirmed only at launch). Warnings never stop it: variables_partly_missing, auto_enroll_starts_empty, no_spend_cap, calling_hours, sms_hours, no_conversion_outcomes, no_campaign_tests, campaign_tests_not_run, campaign_tests_failing (with the latest pass rate and, in at, the last run time) and voicemail_without_text. Each item has a title, a detail and sometimes an href to the page that fixes it. Pass the campaign id from list_campaigns.