API reference

Every operation, grouped by area. Each page shows the scope, the tier, how sensitive the data is, whether an Idempotency-Key is needed, the batch limits, curl and Python examples, and every error it can return. The machine-readable contract is published as OpenAPI 3.1 (JSON).

Account

The calling API client.

	Path	Summary	Scope	Tier
GET	`/v1/me`	Who am I: the API client, the account and the granted scopes	none	Tier 1

Leads

Import, read and update leads. Imports run the platform's own validation and DNC screen.

	Path	Summary	Scope	Tier
POST	`/v1/leads/import`	Import leads into a campaign through the platform's own list-upload validation	`leads:write`	Tier 1
GET	`/v1/leads`	List leads across the account's campaigns	`leads:read`	Tier 1
POST	`/v1/leads`	Add one lead, optionally to be dialled first (speed-to-lead)	`leads:write`	Tier 1
GET	`/v1/leads/{lead_id}`	One lead	`leads:read`	Tier 1
PATCH	`/v1/leads/{lead_id}`	Update a lead's name, email or custom fields	`leads:write`	Tier 1
GET	`/v1/leads/{lead_id}/history`	A lead's contact history	`leads:read`	Tier 1

Campaigns

Read campaigns and their progress; pause (Tier 1) and resume (Tier 2).

	Path	Summary	Scope	Tier
GET	`/v1/campaigns`	List campaigns	`campaigns:read`	Tier 1
GET	`/v1/campaigns/{campaign_id}`	One campaign	`campaigns:read`	Tier 1
GET	`/v1/campaigns/{campaign_id}/progress`	A campaign's progress counts	`campaigns:read`	Tier 1
POST	`/v1/campaigns/{campaign_id}/pause`	Pause a running campaign	`campaigns:pause`	Tier 1
POST	`/v1/campaigns/{campaign_id}/resume`	Resume a paused campaign (Tier 2: starts real calls)	`campaigns:resume`	Tier 2

Calls

Call records, recordings, transcripts and AI summaries (all calls of the account), and click-to-call.

	Path	Summary	Scope	Tier
GET	`/v1/calls`	List the account's calls, newest first	`calls:read`	Tier 1
POST	`/v1/calls`	Start a click-to-call	`calls:originate`	Tier 2
GET	`/v1/calls/{call_id}`	One call	`calls:read`	Tier 1
GET	`/v1/calls/{call_id}/recording`	The call's newest playable recording, streamed	`recordings:read`	Tier 1
GET	`/v1/calls/{call_id}/transcript`	The call's transcript	`transcripts:read`	Tier 1
GET	`/v1/calls/{call_id}/summary`	The call's summary, with its status	`summaries:read`	Tier 1

Webhooks

Endpoints, event history, delivery history and replay.

	Path	Summary	Scope	Tier
GET	`/v1/webhooks`	List webhook endpoints	`webhooks:read`	Tier 1
POST	`/v1/webhooks`	Create a webhook endpoint	`webhooks:write`	Tier 1
GET	`/v1/webhooks/{webhook_id}`	One webhook endpoint	`webhooks:read`	Tier 1
PATCH	`/v1/webhooks/{webhook_id}`	Change a webhook endpoint	`webhooks:write`	Tier 1
DELETE	`/v1/webhooks/{webhook_id}`	Delete a webhook endpoint	`webhooks:write`	Tier 1
POST	`/v1/webhooks/{webhook_id}/rotate-secret`	Rotate an endpoint's signing secret, with a 24-hour overlap	`webhooks:write`	Tier 1
POST	`/v1/webhooks/{webhook_id}/test`	Send a test event	`webhooks:write`	Tier 1
GET	`/v1/webhook-events`	List webhook events	`webhooks:read`	Tier 1
GET	`/v1/webhook-events/{event_id}`	One webhook event, with its data	`webhooks:read`	Tier 1
POST	`/v1/webhook-events/{event_id}/replay`	Replay an event: same event id, new delivery id	`webhooks:write`	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.

	Path	Summary	Scope	Tier
POST	`/v1/dnc/check`	Check numbers against the Do-Not-Call list	`dnc:check`	Tier 1
POST	`/v1/dnc`	Add a number to the Do-Not-Call list	`dnc:add`	Tier 1

Callbacks

Read and cancel (Tier 1); schedule and move (Tier 2).

	Path	Summary	Scope	Tier
GET	`/v1/callbacks`	List a campaign's callbacks, newest created first	`callbacks:read`	Tier 1
POST	`/v1/callbacks`	Schedule a callback (Tier 2: schedules a real call)	`callbacks:write`	Tier 2
POST	`/v1/callbacks/{callback_id}/cancel`	Cancel a pending callback	`callbacks:cancel`	Tier 1
POST	`/v1/callbacks/{callback_id}/reschedule`	Move a pending callback (Tier 2: moves a real call)	`callbacks:write`	Tier 2

Appointments

Read (Tier 1); book, move and cancel (Tier 2).

	Path	Summary	Scope	Tier
GET	`/v1/appointments`	List appointments	`appointments:read`	Tier 1
POST	`/v1/appointments`	Book an appointment (Tier 2: the customer may be texted)	`appointments:write`	Tier 2
GET	`/v1/appointments/{appointment_id}`	One appointment	`appointments:read`	Tier 1
POST	`/v1/appointments/{appointment_id}/reschedule`	Move an appointment (Tier 2: the customer may be texted)	`appointments:write`	Tier 2
POST	`/v1/appointments/{appointment_id}/cancel`	Cancel an appointment (Tier 2: the customer may be texted)	`appointments:write`	Tier 2

SMS

Delivery reports and usage (Tier 1); sending (Tier 2).

	Path	Summary	Scope	Tier
GET	`/v1/sms/delivery-reports`	Recent SMS delivery reports	`sms:read`	Tier 1
GET	`/v1/sms/usage`	SMS usage counters	`sms:read`	Tier 1
POST	`/v1/sms`	Send an SMS (Tier 2)	`messages:send`	Tier 2

Send WhatsApp messages (scope whatsapp:send; not available yet).

	Path	Summary	Scope	Tier
POST	`/v1/whatsapp/messages`	Send a WhatsApp message	`whatsapp:send`	Tier 1

Record consent evidence (Tier 2).

	Path	Summary	Scope	Tier
POST	`/v1/consents`	Record consent evidence (Tier 2: can make a number callable)	`consent:write`	Tier 2

Reports

Aggregated reports.

	Path	Summary	Scope	Tier
GET	`/v1/reports/dispositions`	Disposition counts over the last N days	`reports:read`	Tier 1