Liveleg docs

Liveleg is an outbound calling API for sales teams that power dial at volume. Your app sends leads and starts a dial session. We dial several lines per agent from local numbers, connect the first live person, record the conversation and send an event for each step.

All endpoints are under https://api.liveleg.dev/v1 and use Bearer API keys. Calls go to US numbers only. Start with the quickstart, then read the page for each part you use.

Get started

QuickstartFrom a new account to an agent talking with a live person.
AuthenticationAPI keys, scopes, rotation, agent tokens and webhook secrets.
API basicsRequests, idempotency, pagination and the shape of every response.
ErrorsThe error object, HTTP status codes and what to do for each error code.
Test modeTest keys, test phone numbers for each call outcome and what runs without dialing.
SDKsRequests in curl, Node.js and Python, and the @liveleg/voice library for agents.
Versioning and changelogHow API versions work and what changed in the API.

Guides

Dial sessions and leadsParallel dialing for an agent or a pool, up to 5 lines per agent.
Pre-dial checksLine status, do-not-call lists, calling hours, state call limits and consent before each dial.
Call controlSingle calls, live call control, transfers, callbacks and call records.
Inbound calls and callbacksCallbacks to your numbers, routing to the last agent or a pool, voicemail and scheduled callbacks.
Webhooks and eventsWebhook delivery, signatures, retries and every event type.

Products

Answering machine detectionHow detection tells people from machines, and what it reports.
Phone tree navigationPressing through main lines and waiting on hold until a person picks up.
Agent callingAgents in the browser or on SIP phones, tokens and media streams.
Phone numbersLocal and toll-free numbers, caller ID pools, retiring numbers and porting.
Number LookupLine type, carrier and status for a number, one at a time or in batches.
Caller IDLocal presence, the same number for each lead, caller name, branded caller ID and STIR/SHAKEN signing.
Number reputationSpam label checks, caller name, branded caller ID, resting and spam cleaning.
MessagingA dedicated messaging line with iMessage, SMS, MMS and WhatsApp, quiet hours and opt-outs.
Smart RecordingSmart Recording by lead location, consent during the call and retention.
Transcription and tonalityTranscripts after the call or live, summaries, outcomes and tonality.
SubaccountsOne account per client with its own numbers, keys and billing view.

API reference

All resourcesEvery resource, endpoint and object in the API.
SubaccountsA subaccount is a separate account under yours for one of your clients, with its own numbers, reputation, do-not-call list, recordings, keys and billing view.
AgentsAn agent is one person who takes calls, from the browser, a mobile app or a SIP phone.
Dial sessionsA dial session calls a lead list for one agent or a pool of agents, up to 5 lines per agent at a time.
CallsEvery connected conversation is a call with its own ID.
Leads and campaignsLeads live in lead lists, and dial sessions call one list at a time.
NumbersLocal and toll-free US numbers that your dial sessions use as caller ID.
LookupsA lookup returns the line type, carrier and line status of a US number, and the caller name on file if you ask for it.
RecordingsSmart Recording records each call from the moment the lead is connected to the agent.
TranscriptsTranscripts cover the recorded audio of a call.
MessagesMessages go out from a messaging line, a dedicated number separate from your calling numbers.
WebhooksA webhook endpoint is a URL that receives signed events from your account.
BillingUsage, invoices and call records with their cost.

Compliance and billing

ComplianceCalling hours, do-not-call list, ring time, abandonment cap and consent.
Billing and surchargesThe per-minute rate, what is never billed, every price and surcharge.