Overview
The DialerBee API lets your own systems (a CRM, a data warehouse, an automation tool) work with your DialerBee contact centre without anyone signing in to the console. It is a server-to-server REST API: JSON over HTTPS, one API client for each integration, and one or more keys for each client.
Version 1 answers two questions: how do I get leads in? and how do I get results out?
Base URL
https://app.dialerbee.com/api/v1
Every path starts with /v1. There are no breaking changes inside v1: new endpoints, new optional
request fields and new response fields can be added, so build your client to ignore response fields it
does not know. A breaking change would get a new version (/v2) and at least 12 months of notice (see
Deprecations).
What you can do
| Area | What you can do | Tiers |
|---|---|---|
| Account | The calling API client. | Tier 1 |
| Leads | Import, read and update leads. Imports run the platform's own validation and DNC screen. | Tier 1 |
| Campaigns | Read campaigns and their progress; pause (Tier 1) and resume (Tier 2). | Tier 1, Tier 2 |
| Calls | Call records, recordings, transcripts and AI summaries (all calls of the account), and click-to-call. | Tier 1, Tier 2 |
| Webhooks | Endpoints, event history, delivery history and replay. | Tier 1 |
| Do-Not-Call | Check and add numbers (Tier 1). Removing a number is not offered in the API: an account administrator removes it in the DialerBee console. | Tier 1 |
| Callbacks | Read and cancel (Tier 1); schedule and move (Tier 2). | Tier 1, Tier 2 |
| Appointments | Read (Tier 1); book, move and cancel (Tier 2). | Tier 1, Tier 2 |
| SMS | Delivery reports and usage (Tier 1); sending (Tier 2). | Tier 1, Tier 2 |
Send WhatsApp messages (scope whatsapp:send; not available yet). | Tier 1 | |
| Consent | Record consent evidence (Tier 2). | Tier 2 |
| Reports | Aggregated reports. | Tier 1 |
Tier 1 operations are safe or reduce contact (reading data, importing leads through the platform's own checks, pausing a campaign, adding a number to the Do-Not-Call list). Tier 2 operations can reach or unlock real people (resuming a campaign, scheduling a callback, booking an appointment, recording consent). They need their own scope and an account switch that is off until DialerBee turns it on for your account. Removing a number from the Do-Not-Call list is not in the API: an account administrator does it in the DialerBee console. See Tiers.
Start here
- Quickstart: your first request in five minutes.
- Authentication and API keys: how keys work and how to rotate them.
- Errors, Idempotency and Pagination: the conventions every endpoint follows.
- Webhooks: results pushed to you as they happen.
- API reference: every endpoint, with curl and Python examples.
There is no separate charge for using the API. Default limits apply; see Rate limits.