Go back to dialerseat.comsales@dialerseat.com
Guide

Moving from VICIdial's API to an embedded dialer

VICIdial's Agent API acts on a logged-in agent's screen through /agc/api.php, with the user and password in the address and plain-text answers. DialerSeat for Developers does the same job with POST /v1/seats/{id}/commands: dial, hangup, skip, disposition, pause, resume and more, sent to the user's open dialer as if the agent pressed the button. Requests and answers are JSON, and the key goes in a header.

Checked 2026-11-15 against the sources linked at the end.

Agent API, function by function

VICIdial Agent APIDialerSeat for Developers
external_dialdial
external_hanguphangup
preview_dial_action SKIPskip
external_statusdisposition
external_pause PAUSE / RESUMEpause / resume, plus start / stop for auto-dialing
external_add_leadadd_leads (up to 500, at the top or the bottom)
update_fieldsupdate_lead
send_notificationshow_card / hide_card
change_ingroupsset_campaign
the campaign's dial_methodset_mode

Non-Agent API lookups

VICIdial Non-Agent APIDialerSeat for Developers
logged_in_agentsGET /v1/seats?online=true
agent_statusthe presence on GET /v1/seats/{id}
phone_number_log, lead_searchGET /v1/calls?phone=
callid_infoGET /v1/calls/{id}
call_dispo_reportGET /v1/campaigns/{id}/stats
add_dnc_phone, delete_dnc_phonePOST and DELETE /v1/dnc
add_user, update_user/v1/seats
update_campaign, campaigns_list/v1/campaigns

The same call, before and after

The answer is 202 when the command is on its way, or 409 seat_offline when the user has no dialer open. What happens next arrives as the usual webhooks: call.started, call.dispositioned and seat.status_changed.

DialerSeat: dial a lead on one user's open dialer
curl https://api.dialerseat.com/v1/seats/usr_829/commands \
  -H "Authorization: Bearer dsk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "action": "dial", "phone": "+15125550142", "lead": { "external_id": "c_5501" } }'

What stays the same, and what changes

  • A command never goes around the dialer: campaign access, your do-not-call list and the lead's calling hours are still checked on the server.
  • A command the dialer can't do right now, such as a dial in the middle of a call, is ignored, as the button would be.
  • An open dialer whose agent isn't available reads paused, as in VICIdial.
  • Leads travel with the session or add_leads. There is no hopper or stored lead list to search.
  • There is no blind_monitor or barge, and no transfers, parking or DTMF: DialerSeat has no live listening.

Related: VICIdial API vs an embedded dialer API, drive the dialer from your server, answering machine detection and call disposition codes list.

Sources


More: the developer FAQ, the comparisons, Answering machine detection (AMD), explained for developers, Salesforce Open CTI retirement: what it means, Webhook signature verification failed? Find the cause, Do-not-call API: what the national registry offers, A click-to-call button in your CRM, Your own UI on the dialer, with DialerSeat.connect, A live status board for managers, or the quickstart, free in sandbox mode.