Developer API
API errors, limits and troubleshooting
Every error the Silux Call API can return, what it means and how to fix it, plus the request limits.
Which plans include it
Included on Plus and above. On Free Trial, Entry you can add it on its own at £2.50 a month from Features & add-ons.
What it means
When something goes wrong, the API answers with an HTTP status and a JSON body like {"code":"invalid_api_key","message":"…"}. The code is for your software; the message is plain English you can show to a person.
What it does
- 401 invalid_api_key: the key is missing, mistyped or revoked. Check the Authorization header is exactly "Bearer " followed by the key, or create a new key.
- 403 not_in_plan: the API is not on your plan. On Entry, add API access (£2.50 a month) from Features & add-ons, or move to Plus.
- 403 account_inactive: the account is suspended or closed. Contact support.
- 400 invalid_number: "to" is not a phone number. Send digits, optionally starting with +.
- 400 extension_required: send "extension" or "email" with the call.
- 400 international_not_enabled: the number is not a UK number. The API calls UK landlines, mobiles and freephone only.
- 404 extension_not_found: no active extension matches. Check GET /api/v1/extensions.
- 404 not_found: the recording does not exist or was deleted.
- 429 too_many_calls: more than 20 calls in a minute on this key. Wait a moment.
- 429 daily_limit: 10,000 requests today on this key. It resets at midnight UTC.
Every part of the page
- Requests per key
- 10,000 a day, reset at midnight UTC.
- Click-to-call per key
- 20 a minute.
- Calls at the same time
- Your plan's calls-at-once limit, the same as your phones.
- Page size
- Up to 200 calls or recordings per request.
How to use it
The call started but nothing rang
- Open the mobile app, browser softphone or desktop app for that extension and make sure it is signed in.
- Check the extension number with GET /api/v1/extensions.
- Try a call from the app itself. If that also fails, contact support with the time of the API call.
It worked yesterday and now says invalid_api_key
- Someone may have revoked the key: check the API page.
- Check your server still has the key saved (secrets can be lost on redeploy).
- Create a new key if needed.
Recommended settings
- ★Log the "code" from every error in your system, so problems are easy to trace.
- ★On a 429, wait and retry rather than retrying straight away in a loop.
Abbreviations on this page
- API key
- A secret password that lets one piece of software use another. Treat it like a password.
- Example: Treat an API key like a password: anyone with it can use your account's API.
Questions
Can my limits be raised?+
Contact our support team with what you are building and we will look at it.
Where can I see API activity?+
Every click-to-call made through the API is listed on your account's activity log, with the key name and extension.
Which plans include the API?+
It is part of the package on Plus, Growth, Pro and Enterprise at no extra cost. On Entry, add API access for £2.50 a month from Features & add-ons. The Free Trial does not include it. There is no per-call API fee.