Postman

The Postman collection has one request for every operation, generated from the same contract as this site, with example bodies and example error answers.

Download

The files contain no key. Import them in Postman (Import, then choose the three files).

Set up

Select the DialerBee live environment (or DialerBee test with a dbk_test_ key).
Paste your key into DIALERBEE_API_KEY, as the current value only, so it stays on your machine and is never synced or shared.
Send Account / Who am I (GET /v1/me) to check the key.

The collection sends the key in the Authorization header only, and refuses to send a request while DIALERBEE_API_KEY is empty.

Idempotency keys

Requests that need an Idempotency-Key use the collection variable idempotency_key. The collection fills it with a new value when it is empty, and keeps it until the outcome of the request is known:

after a success or a definite refusal, the value is cleared, so the next request gets a new key;
after 409 outcome_unknown, 409 conflict, 429 or a 5xx, the value is kept, so sending the request again retries with the same key, as Idempotency requires.

Pages

After a list request, the collection stores page.next_cursor in the cursor variable. Tick the cursor query parameter of the same request to fetch the next page.

Variables

Path parameters use collection variables with example ids (campaign_id, lead_id, call_id, and so on). Replace them with ids from your own account.

Tier-2 requests are labelled [Tier 2]. They answer 403 tier_not_enabled unless the matching switch is on for your account.