DialEcho API
View as Markdown

DialEcho API ​

The DialEcho API lets your own website, backend or tools push leads into your campaigns, keep them up to date, book appointments, attach files, have your AI voice agents call leads, read back what happened to them, read and answer your campaigns' email conversations, and read your email blasts' results.

Every endpoint lives under /v1, is called with a member API key and is limited to what that member can do in DialEcho right now.

API keys ​

Create keys in Settings > API keys: a name, the scopes the integration needs, the campaigns it may reach (or every campaign you can access) and an optional expiry. The secret looks like dei_<12 hex characters>_<43 characters> and is shown once. Send it on every request as Authorization: Bearer <key>.

Open Settings > API keys in DialEcho to create one, then read Authentication.

Reference ​

  • Overview: Base URL, authentication and scopes, request conventions, errors, rate limits, pagination and idempotency.
  • Leads: A lead is one person in one campaign, identified by their phone number. Push leads from your website or backend, merge in more details as the visitor tells you more, read them back and move their pipeline card.
  • Appointments: Show a calendar of the times a campaign can take right now, then book the visitor's pick on their lead. Bookings go through the same atomic check DialEcho's AI uses when it books on a call, so your site and the AI never double-book a team member.
  • Files: Store documents and photos a visitor sends you, for example a utility bill, in a file or image custom field of the lead's pipeline card, exactly as if your team had uploaded them on the board. Files are stored privately; your team opens them from the card's Custom Fields panel and the API never returns a link to them.
  • Calls: Have one of your campaign's AI voice agents call a lead once, like creating a call in Vapi. You decide when: right after a form, or later from your own scheduled job. DialEcho adds no timers, delays or "did they book" logic of its own and never retries an API call; whether and when to call again is up to you.
  • Reporting: What happened to the leads you sent and where they are now: the conversion report (first AI call, appointment booked and held, deal won or lost, with its value) and the campaign's pipeline board. Both are read live from DialEcho on every request and need leads:read.
  • Lead actions: A lead action is a button on a lead in DialEcho that opens your own web app for that lead, for example a quoting or scheduling tool your team works in. It is set up on the API key your app uses: a button label and the URL of your page.
  • Inbox: Your campaigns' email conversations, as your team sees them in DialEcho's inbox: read threads and their messages, poll for new inbound replies, answer them from the campaign mailbox or the reply address, and mark threads read or archived. Contact campaign inboxes (contact) and real-estate offer campaign inboxes (realestate) are both served; every conversation and message names its domain.
  • Blasts: Read-only results of your campaigns' email blasts: how many recipients were delivered, bounced, replied or opted out, day by day, and which addresses got which blast. All four endpoints need blasts:read, and nothing here changes a blast.

For AI agents ​

Every page has a Markdown version: use Copy as Markdown or View as Markdown at the top of the page. To give an AI agent the whole API, point it at: