GET
Get a reachability check

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

id
string
required

Reachability check id (rch_ + 32 hex characters).

Response

The check.

id
string
required

rch_ + 32 hex characters.

Example:

"rch_4e7b1c9d2a3f4e5b8c6d7a8b9c0d1e2f"

status
enum<string>
required

running (dialling), waiting_window (outside your calling hours, numbers wait), queued (paused on our side, for example reachability was disabled after creation), then completed or canceled.

Available options:
queued,
running,
waiting_window,
completed,
canceled
mode
enum<string>
required

answer (default): wait for a pick-up, hold the line hold_sec seconds and hang up. ring: hang up as soon as the phone has rung ring_sec seconds; nobody needs to pick up (the customer sees a missed call).

Available options:
answer,
ring
from
string
required

Caller ID used, E.164.

hold_sec
integer | null
required

null for a ring check.

ring_sec
integer | null
required

null for an answer check.

ring_timeout_sec
integer
required
machine_detection
boolean
required

false for a ring check.

answer_message
string | null
required

null for a ring check.

max_attempts
integer
required
retry_delays_min
integer[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
completed_at
string<date-time> | null
required

When the batch finished (also set on a canceled check once its last dial ends).

canceled_at
string<date-time> | null
required
counts
object
required

Numbers per result (computed when read). total = numbers sent, duplicates and invalid inputs included.

cost
object
required

Your cost (never the provider's). pending until every part of the cost is known, then final. no_rule: no pricing is configured for your account yet (amount_micros is null). Integer INR micros (1,000,000 = INR 1).

metadata
object
required

The metadata you sent; {} when none.

campaign_id
string

Only on a check a campaign placed (a ring_check step; lists show those with include_campaign=true); absent otherwise, as on a CallView. Also in the reachability.* webhooks.

campaign_contact_id
string

The campaign contact (cct_...) the check was placed for; with campaign_id only.

campaign_step_id
string

The campaign step that placed it; with campaign_id only.