Moving from the old API
Some integrations were built on the console's own API: they sign in with a user's email and password
(POST /v1/auth/login), receive a token that expires after 24 hours, and call console routes with it.
That way of integrating is being retired. It ties an integration to a person's password, cannot be
limited to what the integration needs, and breaks when the person leaves or changes their password.
What changes
| Old console login | DialerBee API | |
|---|---|---|
| Address | your console address | https://app.dialerbee.com/api/v1 |
| Identity | a user's email and password | an API client with its own keys |
| Credential | a token that expires after 24 hours | a key that works until you revoke it or it expires |
| Access | everything the user can do | only the scopes you grant |
| Contract | internal routes that can change | a versioned, documented contract |
| Errors | varied | RFC 9457 with stable codes |
How to move
- Ask DialerBee to switch API access on for your account.
- In the console, create an API client for the integration and grant it the scopes it needs.
- Create a key, store it in your secret store, and check it with
GET /v1/me. - Move each call to its API operation (table below), and test it.
- Switch the integration over, and watch it for a few days.
- Remove the stored password from the old integration, and ask your admin to change it.
Common tasks
| Task | API operation |
|---|---|
| List campaigns | GET /v1/campaigns |
| Read a campaign and its progress | GET /v1/campaigns/{campaign_id}, GET /v1/campaigns/{campaign_id}/progress |
| Pause a campaign | POST /v1/campaigns/{campaign_id}/pause |
| Add contacts to a campaign | POST /v1/leads/import |
| Search contacts | GET /v1/leads |
| List calls | GET /v1/calls |
| Download a recording | GET /v1/calls/{call_id}/recording |
| Check or add a Do-Not-Call number | POST /v1/dnc/check, POST /v1/dnc |
| Disposition report | GET /v1/reports/dispositions |
| Receive events | Webhooks |
Starting single calls, agent state and campaign creation are not offered by the API. If your integration depends on them, contact DialerBee support before you move.