POST /v1/calls, or run a campaign that calls a list of contacts inside the hours you set.
Before you can call
Outbound is closed until the account passes these gates. Unverified accounts can only receive calls.Preflight
Check a campaign before you launch it.POST /v1/campaigns/preflight checks an unsaved draft, and GET /v1/campaigns/{id}/preflight checks a saved campaign. Nothing is written. The result has can_launch and a list of checks. Each check has a state of ok, warn, stop or info, and often a link to fix it.
Preflight is a forecast. Every dial is checked again when it happens.
The checks cover the gates above and these:
GET /v1/compliance/calling-rules returns the calling rules applied for each US state.
Run a campaign
1
Add contacts and record consent
Create contacts with
POST /v1/contacts, or import a CSV with POST /v1/contacts/imports. Record consent for each person. Individuals can’t upload lists. See Outbound with consent for the full steps with examples.2
Create the campaign
POST /v1/campaigns takes a name, an agent, the numbers to call from, a purpose (informational or telemarketing), calling windows, retry rules and the voicemail behavior (amd_mode). POST /v1/campaigns/audience-preview previews who would be called, and POST /v1/campaigns/estimate estimates the size and cost.3
Run preflight
Fix every
stop before launch. A warn does not block.4
Start
POST /v1/campaigns/{id}/start. Contacts are checked one at a time as they come up. A contact that fails a check is skipped, or held until the check can pass, for example until the calling window opens.5
Watch and control it
GET /v1/campaigns/{id}/stats returns the counters, and GET /v1/campaigns/{id}/events returns a readable timeline of what happened. Pause with POST /v1/campaigns/{id}/pause (calls in progress continue) and resume with .../resume.Safety pauses
Larynth watches campaigns for signs of a problem, such as many opt-outs, complaints or very short calls. A campaign can pause itself. You can ask for a review, and our team decides within about one business day. Only our team can resume a campaign paused for a safety reason. You can resume a campaign paused for the schedule, your balance, or by you.When someone asks to stop
An opt-out is recorded straight away, the number joins your Do-Not-Call list, and it is not called again. Record opt-outs you receive another way withPOST /v1/compliance/revocations. A compliance.opt_out webhook is sent.