Developer API
Make your first API call: test click-to-call in 2 minutes
A step-by-step test of the Silux Call API from a terminal: list your extensions, then ring your own extension and dial a number.
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
A quick check that your key works before you connect your own system. You only need a computer with a terminal (Command Prompt, PowerShell, Terminal on a Mac, or any Linux shell). curl is built into Windows 10 and later, macOS and Linux.
What it does
- Confirms your key is accepted.
- Shows which extensions exist on your account.
- Rings your own extension and, when you answer, dials the number you chose.
Every part of the page
- YOUR_API_KEY
- Replace with the key you copied from the API page. It starts sk_live_.
- extension
- The extension that should ring, for example 1001. Use your own for the test.
- to
- The number to call, for example 07700900123 or +447700900123. UK numbers only.
How to use it
Step 1: list your extensions
- Open a terminal and run: curl https://www.siluxcall.co.uk/api/v1/extensions -H "Authorization: Bearer YOUR_API_KEY"
- The reply lists each extension with its name and email, for example {"data":[{"extension":"1001","name":"Sam Smith","email":"sam@example.co.uk","type":"softphone"}]}.
- If you see "invalid_api_key", the key was copied wrongly or has been revoked. If you see "not_in_plan", the API is not on your plan yet.
Step 2: ring your extension and dial a number
- Make sure your extension is signed in: open the mobile app, the browser softphone or the desktop app.
- Run: curl -X POST https://www.siluxcall.co.uk/api/v1/calls -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"extension":"1001","to":"07700900123"}'
- The reply says "status": "ringing_extension". Your extension rings straight away.
- Answer it. We now dial the number, and the person you are calling sees your business number.
On Windows PowerShell
- PowerShell treats quotes differently. Use: Invoke-RestMethod -Method Post -Uri https://www.siluxcall.co.uk/api/v1/calls -Headers @{Authorization="Bearer YOUR_API_KEY"} -ContentType "application/json" -Body '{"extension":"1001","to":"07700900123"}'
Examples
A successful reply
{"status":"ringing_extension","extension":"1001","to":"07700900123","message":"Extension 1001 is ringing. When it is answered, we call 07700900123."}
Using the email instead of the extension
Send {"email":"sam@example.co.uk","to":"07700900123"} and we ring that user's own extension. Handy when your CRM knows who is logged in but not their extension.
Recommended settings
- ★Test with your own mobile number as "to" first, so you can hear both ends.
- ★Do not paste your key into chat tools or emails while testing. If you do, revoke it and make a new one.
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
My extension did not ring.+
It must be signed in somewhere: the mobile app, browser softphone or desktop app. If the reply said "ringing_extension" but nothing rang, open the app and try again.
Do I pay for the API call?+
No. Calls cost the same as calls from your phone, and the API itself has no per-call fee.
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.