GET
Get one record of a campaign

Authorizations

Authorization
string
header
required

Authorization: Bearer vg_live_<32 hex characters>. Keys are issued by Mergen admins and shown once. Missing or invalid key: 401 unauthorized. Suspended account: 403 tenant_suspended.

Path Parameters

campaignId
string
required

Campaign id (cmp_ + 32 hex characters).

recordId
string
required

Campaign record id (rec_ + 32 hex characters).

Response

The record.

One person to call in a campaign. variables are the resolved values the calls use. seq is the order of arrival and source_row the CSV row (or the position in the API request). next_attempt_at is when the next attempt is planned (next_is_callback when it is a callback the customer asked for). post_call holds the post-call variables of the latest answered call.

id
string
required

rec_ + 32 hex characters.

campaign_id
string
required
seq
integer
required
Required range: x >= 1
phone
string
required

E.164.

external_id
string | null
required
variables
object
required
source
enum<string>
required
Available options:
csv,
api
source_row
integer | null
required
status
enum<string>
required

pending (waiting for its next attempt), calling (an attempt is on the line), completed (finished with a success, another final outcome or a wrong number), exhausted (attempts or the schedule used up), closed (do not call, paid, or canceled) and skipped (never called: invalid phone, duplicate or missing variables).

Available options:
pending,
calling,
completed,
exhausted,
closed,
skipped
result
enum<string> | null
required

How a record ended: success (an outcome of goal.outcomes), wrong_number, final_outcome (another outcome that ends the record; result_detail names it), exhausted (no attempt left), end_date (the schedule ended first), do_not_call, paid (a customer event), canceled, invalid_phone, duplicate and missing_variables (result_detail lists them).

Available options:
success,
wrong_number,
final_outcome,
exhausted,
end_date,
do_not_call,
paid,
canceled,
invalid_phone,
duplicate,
missing_variables
result_detail
string | null
required

The outcome behind final_outcome or success, or the missing variables.

missing_variables
string[]
required
attempts_made
integer
required
Required range: x >= 0
callbacks_used
integer
required
Required range: x >= 0
next_attempt_number
integer | null
required
next_attempt_at
string<date-time> | null
required
next_is_callback
boolean
required
last_status
string | null
required
last_outcome
string | null
required
last_call_at
string<date-time> | null
required
post_call
object
required
attempts
object[]
required
paid_at
string<date-time> | null
required
collected_micros
integer
required
Required range: x >= 0
closed_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required