DialerBee APIv1 · 1.0.0-rc6

Tiers

Every operation has a tier. The tier says what the operation can do to real people.

Tier 1: safe or reduces contact

Reading data, importing leads through the platform's own checks, pausing a campaign, adding a number to the Do-Not-Call list, cancelling a callback. A Tier-1 operation works as soon as API access is on for your account and the API client holds its scope.

Tier 2: reaches or unlocks real people

Resuming a campaign starts real calls. Scheduling a callback schedules a real call. Booking, moving or cancelling an appointment can send the customer a text. Recording consent can make a number callable again.

A Tier-2 operation needs both:

  1. its own scope on the API client, and
  2. the matching account switch, which is off for every account until DialerBee turns it on at your request.

Until both are in place the operation answers 403 tier_not_enabled. GET /v1/me shows which switches are on for your account (tier2). Every Tier-2 operation also requires an Idempotency-Key, is audited as it happens and has a daily cap per account.

Account switchAllowsOperationsDefaultDaily cap
tier2_campaign_resume_enabledAllows POST /v1/campaigns/{campaign_id}/resume (starts real calls).POST /v1/campaigns/{campaign_id}/resumeOffset before launch
tier2_callback_write_enabledAllows scheduling and rescheduling callbacks (schedules real calls).POST /v1/callbacks, POST /v1/callbacks/{callback_id}/rescheduleOffset before launch
tier2_appointment_write_enabledAllows booking, rescheduling and cancelling appointments (the confirmation service may text the customer).POST /v1/appointments, POST /v1/appointments/{appointment_id}/reschedule, POST /v1/appointments/{appointment_id}/cancelOffset before launch
tier2_consent_write_enabledAllows recording consent.POST /v1/consentsOffset before launch
tier2_sms_send_enabledAllows sending SMS. Each message needs its own client_reference; a repeat is refused.POST /v1/smsOffset before launch
tier2_calls_originate_enabledAllows starting a click-to-call (POST /v1/calls), and adding a lead the dialler calls at once.POST /v1/callsOffset before launch

Sending SMS is Tier 2. Every message carries your own client_reference; a second message with the same reference answers 409 duplicate_client_reference and nothing is sent again.

Click-to-call is Tier 2. POST /v1/calls (scope calls:originate) connects one of your agents who is signed in and ready with a customer; POST /v1/leads into a running campaign or with dial_now also needs calls:originate, because the dialler then calls the person. Click-to-call and SMS are switched on by your own administrator in the console's guided sending setup, which also sets the caps, the IP allow-list of each sending key and the "stop all sending" switch.

WhatsApp is not available yet. POST /v1/whatsapp/messages (scope whatsapp:send) answers 403 tier_not_enabled for every account until DialerBee announces it. See Calls, leads and messages.

Later

These are not in API v1. They may come in a later version; the changelog will say when.

Not offered

The API does not offer, at any tier: starting a call without one of your agents on it, controlling a live call or its audio, creating or deleting campaigns, managing users and agents, trunk, SIP and caller-ID configuration, billing changes, bulk deletes, or sending calendar invites and reminders on demand.