Go back to dialerseat.comsales@dialerseat.com
FAQ

Dialer API questions, answered

DialerSeat for Developers puts an outbound dialer inside your product: your server creates seats and sessions over a REST API, your page embeds the dialer with one script tag, and every call result comes back by signed webhook under your own campaigns and dispositions. Building is free in the sandbox. The answers below come from the docs, checked 2026-11-15.

The basics

What is a dialer API?

A dialer API lets software place and manage outbound calls for agents: which leads to call, in what order, how many lines to dial, and what happened on each call. DialerSeat for Developers is a dialer API with the dialer screen included: your server creates seats and sessions over REST, your page embeds the dialer, and every call result comes back to you by signed webhook.

Quickstart

What is the difference between a power dialer API and a predictive dialer API?

A power dialer dials one line per agent and moves to the next lead as soon as a call ends. A predictive dialer dials several lines per agent and paces them so an agent is free when someone answers. DialerSeat runs preview, progressive, power and predictive from the same API; you set the mode for the platform, then make exceptions per campaign or seat.

Dial modes and exceptions

How do I add a dialer to my CRM without building one?

Embed one. Create a seat for each of your users with POST /v1/seats, mint a one-use session when they open the dialer, and drop the DialerSeat dialer on your page with a script tag. It works your leads under your campaigns and your dispositions, and posts every outcome back to your server, so your CRM stays the system of record.

Ways to put the dialer in

What is CTI, and is DialerSeat a CTI integration?

CTI, computer-telephony integration, links calling to software so a click places a call and the call is logged against the right record. DialerSeat goes a step further than click-to-call: it is the dialer itself, embedded in your product, pacing calls through a queue and reporting each outcome under your own codes. Click-to-call is included for single calls.

Does DialerSeat have a click-to-call API?

Yes. Any element with a data-dialerseat-call attribute dials its number in the page's dialer when clicked, including elements your CRM renders later, and dialer.dial(lead) calls one lead from your own code. Your server can dial too: POST /v1/seats/{id}/commands with action dial, a phone and a lead places the call on that user's open dialer. For working a whole list, the embedded dialer runs the queue itself in the dial mode you choose.

Components and headless · Drive the dialer from your server · Click-to-call button guide

Can my server control an agent's dialer?

Yes. POST /v1/seats/{id}/commands tells a user's open dialer what to do: dial, hangup, skip, disposition, pause, resume, start, stop, add_leads, update_lead, show_card, hide_card, set_campaign or set_mode. It acts as if the agent pressed the button, under the same rules. The answer is 202 when sent, or 409 seat_offline when no dialer is open.

Drive the dialer from your server · Moving from VICIdial's API

How do I see who is online?

GET /v1/seats?online=true lists every user with a dialer open, and each seat carries its presence: offline, paused, available or on_call. The seat.status_changed webhook tells your server the moment one changes.

Seats and sessions

What are the ways to embed the dialer?

Six: a script tag, an HTML tag, a React component, a plain iframe, a hosted link, or headless, where you drive the dialer from your own buttons with no dialer screen. Each one needs the same thing from your server, a session token for the seat. The dialer's parts, such as the queue or the call bar, can also be placed separately.

Ways to put the dialer in · The dialer on your page

Does it work with React, Vue or plain HTML?

Yes. One script tag works on any page, whatever renders it. The docs also show a React component, a plain iframe and a hosted link, and the dialer's parts can be placed as HTML tags or driven headless from your own buttons.

Ways to put the dialer in · Your own UI on the dialer

Building the integration

Is there a free sandbox?

Yes. A developer account is free and gives sandbox keys with no card. The whole API works, the dialer runs in sandbox mode, and webhooks fire with real signed payloads, but nothing dials a real phone. The last digit of a test number decides what happens: 0 to 6 a person answers, 7 voicemail, 8 no answer, 9 busy.

Quickstart

How do I test voicemail, no answer and busy?

In sandbox mode the last digit of the number decides the outcome: 0 to 6 a person answers, 7 voicemail (AMD returns machine), 8 it rings out with no answer, 9 busy. Each fires the same signed webhooks a real call would, so every path in your code can be built without placing a call.

Quickstart

How do I go live?

In the console, open Settings, then Sandbox mode, choose Go live and type LIVE to confirm. Switching changes no data. Real calls start once live dialing is switched on for your project, which happens when your rate is agreed with sales.

Billing and signups

Do my users need a DialerSeat login?

No. Your users sign in to your product as they always do. Your server creates a seat for each user, keyed on your own user id, and mints a 15-minute, one-use session token each time the dialer opens. The token signs that seat into the dialer with no second login.

Seats and sessions

What keys does the API use?

A secret key for your server and a publishable key for the browser, each in a sandbox and a live version. Secret keys go in the Authorization header as a Bearer token and never in a page. Live keys authenticate before live dialing is on, but anything that would place a call returns 402 live_dialing_inactive.

Authentication and API keys

Is the API secure?

Secret keys stay on your server, and live keys are refused from browsers. Every key ends in a CRC32 checksum, so a mistyped or truncated key is caught before it is looked up. Dialer sessions last 15 minutes and work once. Webhooks are signed with HMAC-SHA256 in the DialerSeat-Signature header.

Authentication and API keys · Webhook signature checker

How do I send leads to the dialer?

Hand them over with the session (up to 500), from the page when the dialer mounts, or later with dialer.setLeads(). Leads travel with the dialer rather than into a store, and each keeps your external_id, so every event about it comes back with your id. POST /v1/campaigns/{id}/leads checks a batch the way live dialing will, without storing it.

Campaigns and leads

Can agents use my CRM's own dispositions?

Yes. Agents pick from your outcomes, by your codes and labels, and each one maps to an outcome class such as contact, callback or do-not-call, so redials and suppression still work. Skip is always last, so an agent can move on without an outcome; it is reported like any other disposition.

Dispositions · Call disposition codes list

Can each user see only the campaigns my platform allows?

Yes. Tell DialerSeat your teams and roles by your own ids, and say which teams and users may dial each campaign. Each person's dialer then shows only the campaigns your platform lets them dial. GET /v1/seats/{id}/access shows what one user may reach right now, and why.

Teams, roles and access

Can different teams use different dial modes?

Yes. Set one dial mode for your platform, then add exceptions for a campaign, a seat or a team. The most specific wins: the campaign, then the seat, then the first of the seat's teams that has one, then your platform's setting.

Dial modes and exceptions

Can a manager see their team in real time?

Yes. Managers and admins can put a team board on their page with the <dialerseat-team> tag. It shows each person's status and today's dials, connects and talk time. It shows statuses only: nothing in it listens to a call or joins one.

Components and headless · Status board guide

Is there an OpenAPI spec or an MCP server?

Both. /v1/openapi.json describes every endpoint, parameter, error shape and webhook event in OpenAPI 3, so you can generate a client. /v1/mcp is a Model Context Protocol server over Streamable HTTP, so an AI assistant such as Claude Code can run your project in plain words with your key.

OpenAPI and AI assistants (MCP)

What are the rate limits?

Each key may make 25 requests a second, with bursts to 50. Past that the API answers 429 rate_limited with a Retry-After header in seconds. Creating a seat, team or campaign is keyed on your own id, so sending it again after a timeout updates it rather than creating a duplicate.

Errors and limits

How does idempotency work?

Seats, teams and campaigns are keyed on your own ids, so a repeated request updates rather than duplicates. POST /v1/subscriptions takes an Idempotency-Key header, or an event_id, and the same payment is never recorded twice, so you can retry it safely after a network error.

Idempotency

Calls and compliance

Does the API include answering-machine detection?

Yes. Answering-machine detection runs on every mode except preview. On a machine, the agent is released and the next lead comes up, so voicemail, no answer and busy never reach the agent. The verdict comes back on call.answered (pending while it is still listening) and as the final result on call.ended.

Webhooks · Answering machine detection for developers

How are calling hours enforced?

Every live call is checked against the lead's local calling hours and your do-not-call list before anything rings, in the time zone of the person being called. It cannot be turned off by API. Send the lead's state when you have it.

Calling hours

Can the dialer call Canadian numbers?

Yes, on an account with Canadian dialing switched on. A Canadian number is checked against Canada's CRTC hours in every time zone its area code covers, and dials from a Canadian caller ID only. Without the switch, Canadian leads are held, never dialed under US rules. Send the province in state when you have it.

Calling hours

Is there a do-not-call API?

Yes. POST /v1/dnc suppresses a number on every campaign on your platform, GET /v1/dnc lists the suppressed numbers with how each got there, and DELETE /v1/dnc/{phone} removes one added by mistake. A disposition mapped to the do-not-call outcome adds the number for you. This is your own list: scrubbing against the national registry stays with you.

DNC API guide

Do I need my own Twilio or Telnyx account?

No. DialerSeat runs the carrier, the phone lines and caller ID from a managed number pool. Your code talks to the DialerSeat API and your page embeds the dialer; there is no voice provider account to set up, and no call flows to write.

Should I build a power dialer on Twilio instead?

Build it if calling is your product and you need call flows no dialer offers. Otherwise, the dialer is the expensive part: the lead queue, pacing for power and predictive, handling an answering-machine verdict, calling hours in each time zone, do-not-call, caller ID and the agent's screen. DialerSeat for Developers is that part, already built.

Build on Twilio, or embed?

What does DialerSeat for Developers not do?

It is an outbound dialer. It does not take inbound calls, send SMS or WhatsApp, or keep a contact list for you: leads travel with the session and stay in your CRM. Call recordings are not available through the API yet; recording.ready is listed as a planned event. There is no live listening, monitoring or barging, and no transfers, call parking or DTMF.

Webhooks and results

Which webhook events are sent?

call.started, call.answered, call.ended and call.dispositioned for each call; seat.activated, seat.status_changed (offline, paused, available or on_call, where paused means the dialer is open but the agent is not available) and seat.disabled for your users; and subscription.recorded and subscription.canceled for billing. GET /v1/webhook_events lists every type and whether it is sent today.

Webhooks

How do I verify a DialerSeat webhook signature?

Each delivery carries a DialerSeat-Signature header of the form t=<unix seconds>,v1=<hex>. Compute HMAC-SHA256 of the string "t.body", the timestamp, a dot and the raw request body, with your endpoint's signing secret, and compare it with v1 in constant time. Reject deliveries more than five minutes old. The signature checker on this site does it in your browser.

Webhook signature checker · Why verification fails · Webhooks

What happens if my webhook endpoint is down?

Anything but a 2xx response within 10 seconds is retried, at 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and 24 hours, then daily until 72 hours have passed. Every attempt is in the delivery log, GET /v1/webhooks/{id}/deliveries, and any delivery can be sent again with the same event id. Every event keeps its id on every retry, so process each id once.

Retries

Can I pull call history and statistics?

Yes. GET /v1/calls lists calls since a timestamp with outcome, talk time, AMD result and disposition, and narrows to one number (?phone=), one user (?seat=, by seat id or your user id) or one of your leads (?lead=). GET /v1/campaigns/{id}/stats gives a campaign's dials, connects, voicemails, talk time, conversions and outcomes, in total and per seat. GET /v1/exports/calls returns calls as CSV. All are counted from recorded calls; nothing is estimated.

Accounts and billing

How much does the dialer API cost?

Building is free: the sandbox has no charge and needs no card. Live dialing is paid, and platform rates are agreed with sales@dialerseat.com on your volume and the dial modes your users need. Billing is weekly, and you can stop any week.

Pricing

Who pays for my users' seats?

Your users pay you, at whatever price you set, in your own checkout. When one pays, you tell DialerSeat with POST /v1/subscriptions or by forwarding your Stripe webhook, and that seat dials for the days paid. DialerSeat then bills you its cut. A platform can also pay for its users' seats on one invoice.

Billing and signups

What happens when one of my users cancels?

Report it with POST /v1/subscriptions/cancel. The seat keeps dialing until the end of the period already paid, then stops; pass end_now to stop it at once. A subscription.canceled event confirms it.

Billing and signups

Is a developer account separate from a dialerseat.com account?

Yes. One DialerSeat login signs in to both, but the accounts never affect each other. The developer account holds your project, keys and settings; a dialerseat.com account is a personal or team dialer with its own plan.

Developer accounts

Can I put my own brand on the dialer?

Yes, as an add-on arranged with sales: your name, logo and colors on the dialer your users see, in every part and every mode, set in the console with a live preview.

Whitelabel

Other tools and CRMs

Which CRMs does it work with?

Any web product where you can add a script tag or an iframe and run a server call: your own CRM, an industry platform, or an internal tool. DialerSeat for Developers is for the team that builds the product. It is not a listed calling app inside HubSpot, Salesforce or GoHighLevel for their end users.

Is DialerSeat a HubSpot calling extension?

Not today. HubSpot's Calling Extensions SDK lets a calling provider appear inside HubSpot for HubSpot users. DialerSeat for Developers is for platforms that put a dialer in their own product: your users dial from your pages, and your server receives the results.

HubSpot Calling Extensions SDK

Salesforce Open CTI is being retired. What does that mean?

Salesforce has put Open CTI, its JavaScript API for third-party softphones, in maintenance mode with a retirement date of February 28, 2028, and points customers to Service Cloud Voice. It affects calling apps built for Salesforce users. It does not affect a dialer embedded in your own product, which is what DialerSeat for Developers is.

Open CTI retirement: what it means · Salesforce Ben: Open CTI retirement date

How is it different from the CloudTalk API?

CloudTalk's API is a REST API to CloudTalk's own phone system, and its API overview documents no embeddable dialer. DialerSeat for Developers is the dialer itself, embedded in your product with one script tag, under your campaigns and dispositions, with a free sandbox.

CloudTalk API compared

How is it different from a softphone SDK such as Aircall Everywhere or RingCentral Embeddable?

A softphone SDK puts a phone in your page for people who already have that vendor's accounts, and each person places their own calls. DialerSeat embeds an outbound dialer for your users with no second account: it works your campaign's queue, paces calls in power or predictive mode, and reports each outcome under your codes.

All comparisons

Compared with other ways to add calling

Each comparison sets one option beside DialerSeat for Developers, from that vendor's own docs, and says when the other option is the better choice.

ComparisonWhat the other option is
CloudTalk API alternative: embed a dialer in your productA cloud phone system and call center with a REST API, webhooks and CTI apps for a list of CRMs.
Aircall Everywhere alternative: an embedded outbound dialerA cloud phone system whose calling app, Aircall Workspace, can be embedded with the Aircall Everywhere SDK.
JustCall Dialer SDK alternative for platformsA cloud phone system and dialer whose Dialer SDK embeds the JustCall Dialer in a web app.
Dialpad Mini Dialer (CTI) alternative for platformsA cloud phone system with a REST API, event subscriptions and the Mini Dialer (CTI) for embedding.
WAVV API alternative: a dialer SDK you can use todayA power dialer embedded in HighLevel and HubSpot, with a public API for call data and webhooks.
RingCentral Embeddable alternative for outbound dialingAn open-source, embeddable RingCentral softphone and dialer widget for web apps.
Kixie API alternative: a dialer inside your platformA power dialer and business phone for sales teams, with APIs and webhooks for its own app.
Five9 API alternative for platforms embedding a dialerAn enterprise cloud contact center whose APIs and SDKs integrate it with other software.
Convoso API alternative: a dialer inside your productAn outbound contact-center dialer sold by quote, with an API for leads.
VICIdial API vs an embedded dialer APIAn open-source (AGPLv2) inbound and outbound contact-center suite that runs on your own Asterisk servers.
Build a power dialer on Twilio, or embed one?A voice API and browser SDK: the building blocks a team uses to build its own dialer.
Zoom Phone Smart Embed alternative for outbound dialingA softphone for Zoom Phone users, embedded in another web app.
Twilio Flex dialer: outbound campaigns, or an embedded one?A programmable contact-center application built on Twilio.
Amazon Connect Streams vs an embedded outbound dialerAn AWS cloud contact center, with a library to embed its agent panel.
Genesys Cloud Embeddable Framework alternativeAn enterprise cloud contact center, with a framework to embed its client in other apps.
HubSpot Calling Extensions SDK vs embedding a dialerHubSpot's SDK for calling providers who build an app inside HubSpot.
Service Cloud Voice (Salesforce Voice) vs an embedded dialerSalesforce's voice channel for Sales Cloud and Service Cloud.
PhoneBurner API alternative: a dialer inside your productA power dialer with a REST API for contacts, members and dial sessions.
Aloware power dialer API alternative for platformsA contact-center app with APIs that manage its Power Dialer lists.
Build a dialer on Plivo, or embed one?A voice API and browser SDK: the parts a team builds its own dialer from.
Build a dialer on the Vonage Voice API, or embed one?A voice API: the parts a team builds its own dialer from.
GOautodial vs an embedded, hosted dialer APIAn open-source (AGPLv2) contact-center suite on Asterisk and VICIdial, self-hosted.

All comparisons, with how they were checked


Not answered here? The quickstart builds a working integration in sandbox mode, the glossary explains the terms, and the comparisons set DialerSeat beside the other ways to add calling.