Money guards
A key that can add leads can start real phone calls, and calls cost money. A runaway loop in a CRM, or a leaked key, could get expensive. These guards are there so it can’t.
The spend cap
Section titled “The spend cap”Your organization has a daily and a monthly budget for calls started through the API. By default it’s $300 a day and $3,000 a month. The spend is the calls’ billable minutes at your rate, the same numbers as your bill. Days and months follow your organization’s time zone.
Only API-started calls count. Leads you load into a campaign in the app keep dialing as usual.
When a cap is reached:
- New API leads aren’t refused. They’re kept and held:
"status": "held","held_reason": "spend_cap_reached". The same goes forPOST /calls. - API leads already waiting aren’t dialed until the cap lifts.
- Your organization’s admins get one email about it (once per cap, per day or month).
The cap lifts by itself at midnight (or on the 1st, for the monthly cap), or as soon as the cap is raised. Held leads are then called in their usual order.
Org admins can lower the caps in CallView. To go above the defaults, ask CallView support.
Numbers we won’t dial
Section titled “Numbers we won’t dial”Premium-rate numbers (900, 976 and the like) and international numbers, including +1 numbers in the Caribbean, are refused for API leads:
{ "error": { "type": "invalid_request_error", "code": "number_not_allowed", "message": "phone: premium-rate numbers (such as 900 and 976) are not dialed for this organization. Ask CallView support to allow them.", "param": "phone", "request_id": "req_6f1c2a9b0d3e4f5a6b7c8d9e0f1a2b3c", "reason": "premium" }}reason is premium or international. If you really need to call one of these, ask CallView support to allow it for your organization.
Calling one lead again
Section titled “Calling one lead again”POST /calls calls an existing lead right away. Each lead can be called this way at most 3 times in 24 hours. The 4th gets 429 call_limit_reached, with Retry-After saying when you can again.
Knowing which key started a call
Section titled “Knowing which key started a call”Every call says what started it, in started_by: { "type": "api", "api_key_id": "ck_live_..." } for a call your key started, dialer for the campaign’s own dialing, or person for a call someone placed by hand.