The Ringover Calls API allows you to extract and synchronize data from your calls, contacts, users, IVR systems, and SMS messages so you can integrate it directly into your business tools. In this guide, you’ll learn how to generate your authentication key, define its permissions, run your requests, and troubleshoot common errors.

Prerequisites

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

Generate an API Key and Query the Ringover Calls API

1. Generate Your API Key in the Dashboard

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

Go to Developer > API.
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 public endpoints by sending your key in the HTTP authorization 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:YOUR_API_KEY" https://public-api.ringover.com/v2/calls

☝️ Find the complete list of endpoints, parameters, and response 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 synchronize text exchanges with records in your business software or CRM.

Make sure your API key has the appropriate access rights for SMS.
See the technical documentation to build compliant JSON payloads.

💡Always test your requests in a test environment before deploying the integration to 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:

Make sure you’re using the exact API key provided in your Dashboard.
Check the letter case: uppercase and lowercase characters matter.
Confirm that the user or key has the required permissions and access rights.
Make sure the Authorization header is configured correctly in your request, without any extra spaces.

Where can I find detailed specifications for SMS messages?

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

🎉 You now know how to generate your API key and query the Ringover Calls API, and you can easily interconnect your communication flows!