Developer API
Click-to-call API: POST /api/v1/calls explained
Everything about starting a call through the API: what to send, what comes back, what the caller and the customer see, and what can go wrong.
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
One request that starts a call between one of your extensions and any UK number. Your extension rings first; when it is answered, we dial the number. To the person you are calling it looks exactly like a call from your business number.
What it does
- Address: POST https://www.siluxcall.co.uk/api/v1/calls, with the header "Authorization: Bearer <key>" and "Content-Type: application/json".
- Body: "to" (required) plus "extension" or "email" (one of them is required).
- Rings the named extension for up to 30 seconds. If nobody answers, nothing is dialled and no call is charged.
- When answered, dials "to" from your account, with your first business number as caller ID, using the same UK-only rules as your phones.
- Records an entry "API key … started a call" on your account's activity log.
Every part of the page
- to
- The number to call. Digits with an optional leading +, 5 to 15 digits; spaces, brackets and dashes are removed. Examples: 01632960123, 07700 900123, +447700900123.
- extension
- The extension that should ring, exactly as listed by GET /api/v1/extensions, for example "1001".
- Instead of extension: the email of the user whose own extension should ring.
- Reply: status
- "ringing_extension" when the extension is being rung, or "failed" if the call could not be started.
- Reply: extension, to, message
- What we rang, what we will dial, and a plain-English sentence you can show in your CRM.
How to use it
Send a call
- POST https://www.siluxcall.co.uk/api/v1/calls
- Header: Authorization: Bearer sk_live_…
- Header: Content-Type: application/json
- Body: {"extension": "1001", "to": "01632960123"}
Choose who rings
- If each CRM user has a Silux Call login, store their email in the CRM and send "email". We ring that person's own extension.
- Otherwise, store each user's extension number in the CRM and send "extension".
- Shared or desk-phone extensions work too: send their extension number.
Examples
Sales team in a CRM
Shaun clicks "Call" next to a school's number in the CRM. The CRM's server sends {"email":"shaun@yourcompany.co.uk","to":"01632960123"}. Shaun's headset rings on his desktop app; he answers and hears the school's phone ringing.
Callback from a web form
A visitor asks for a callback on your website. Your server sends {"extension":"1001","to":"<their number>"} during office hours. Whoever is on 1001 answers and is connected to the visitor straight away.
Recommended settings
- ★Show the reply's "message" in your CRM so users know their phone is about to ring.
- ★Keep your extension signed in on the app or desktop app while working through a call list.
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
What does the person I call see?+
Your business number, exactly as if you had dialled from your phone.
What if nobody answers the extension?+
After 30 seconds the attempt ends and nothing is dialled. Nothing is charged.
Can I call abroad?+
No. Like your phones, the API calls UK landlines, mobiles and freephone numbers only. A non-UK number gets the error "international_not_enabled".
How many calls can I start?+
Up to 20 a minute per key. How many calls can be live at once follows your plan.
Is the call recorded?+
It follows your normal recording settings, exactly like a call from your phone.