The Ringover Calling API allows you to extract and synchronise your call, contact, user, switchboard and SMS data so that you can integrate it directly into your business tools. In this guide, you will learn how to generate your authentication key, define its permissions, run your requests and resolve common errors.

Prerequisites

An active Ringover account with administrator or developer access rights.
A development environment or an HTTP client (cURL, Postman or application server).

Generate an API key and query the Ringover Calling API

1. Generate your API key in the Dashboard

Create your authentication token and configure its access rights from the developer settings.

Go to the Developer > API section.
Click the Generate an API key button.
Name your key and select a user.
Select the desired permissions in the Permissions section (calls, contacts, users, IVR or SMS).
Copy the generated key and keep it in a safe place.

⚠️ Keep your API keys strictly confidential. Never share them publicly or include them directly in client-side source code.

2. Run your requests to the Ringover API

Query the public endpoints by sending your key in the HTTP authorisation header.

Open your command-line terminal or request-sending tool.
Prepare an HTTP GET request to the public API URL.
Add your API key to the Authorization header field:

curl --header "Authorization:VOTRE_CLE_API" https://public-api.ringover.com/v2/calls

☝️ Find the complete list of endpoints, parameters and return codes in the official documentation: developer.ringover.com.

3. Use SMS messages and advanced features

Integrate the management of incoming and outgoing SMS messages into your business applications.

Accessing SMS messages

Use this access to automatically synchronise text exchanges with records in your business software or CRM.

Check that your API key has the appropriate access rights for SMS.
Refer to the technical documentation to build compliant JSON payloads.

💡Always test your requests in a test environment before deploying the integration on your production system.

FAQ

What should I do if I have an authentication problem with the API key?

If your requests return an authentication error, perform the following checks:

Check that you are using the exact API key provided in your Dashboard.
Check the case sensitivity: upper- and lower-case characters are important.
Confirm that the user or key has the required authorisations and access rights.
Make sure that the Authorization header is correctly configured in your request without any unnecessary spaces.

Where can I find detailed specifications for SMS messages?

To obtain the request formats and integration schemas specific to SMS, refer directly to the official documentation at developer.ringover.com.

🎉 You now know how to generate your API key and query the Ringover Calling API, and you can connect your communication flows with ease!