Skip to main content

Ringover

Ringover is a cloud business phone and calling platform. Its Public API exposes team telephony data — calls, contacts, users, IVRs, phone numbers, SMS and chat conversations, campaigns, and CRM tasks — so you can pull activity into your warehouse and push contact, tagging, and messaging actions back into Ringover.

Ringover icon

Power end-to-end data operations for your Ringover API with Nexla. Our bi-directional Ringover connector is purpose-built for Ringover, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Ringover or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Ringover workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Ringover credential, you need a Ringover API key. Ringover authenticates every Public API request with an API key sent in the Authorization header (the key is sent raw, without a Bearer prefix). API keys are scoped to specific access rights and users, so you control exactly what the key can read or modify.

To obtain a Ringover API key, follow these steps:

  1. Sign in to your Ringover dashboard with an administrator account.

  2. Open the Dashboard (click the crown icon), then navigate to the Developer tab.

  3. Click API key to view existing keys, then click Create an API key.

  4. Select the access rights and the users the key should apply to. Grant only the permissions your Nexla flows require — for example, read access for ingesting calls, contacts, and conversations, and write access for creating contacts, sending SMS, or tagging calls.

  5. Create the key and copy it immediately. Store it securely, as it grants access to your Ringover team data.

API keys are case sensitive and must match exactly. The user associated with the key must hold the permissions needed for the endpoints you plan to call — for example, presence and conference endpoints require the Monitoring permission. For full details on authentication and available endpoints, see the Ringover API documentation and the Using our API help article.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesRingover Public API key. Create one from the Ringover dashboard under API settings. Sent raw (no 'Bearer ' prefix) in the Authorization header.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Ringover API key in the API Key field. This is the key you generated in the Ringover dashboard under Dashboard > Developer > API key. Nexla sends it raw in the Authorization header on every request.

    If your API key is compromised, revoke it in the Ringover dashboard under Developer > API key and generate a new one. Because keys are scoped to specific rights and users, issue a dedicated key for Nexla with only the permissions your flows need.

    For more on authentication and available endpoints, see the Ringover API documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Ringover connector tile, then select the credential that will be used to connect to Ringover, and click Next; or, create a new Ringover credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Ringover endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] Get Team

Retrieve team-wide configuration in a single call: phone numbers, users, IVRs, conferences, tags, and groups.

[Rest API] List Calls

Search terminated (completed) calls across your team. Supports start_date/end_date and call_type filters to scope the result set.

[Rest API] Get Call

Retrieve a single call record by its call ID.

[Rest API] List Call Surveys

Retrieve the survey answers collected for a call.

[Rest API] List Contacts

List contacts in your Ringover address book. Supports search filters.

[Rest API] Get Contact

Retrieve a single contact by its contact ID.

[Rest API] List Users

List the users on your Ringover team.

[Rest API] Get User

Retrieve the details of a single user.

[Rest API] List Groups

List the call groups configured for your team.

[Rest API] Get Group

Retrieve a single group's details, including its members.

[Rest API] List Numbers

List the phone numbers on your account. Supports is_user, is_ivr, and is_fax filters.

[Rest API] Get Number

Retrieve the details of a single phone number.

[Rest API] List IVRs

List the IVR (interactive voice response) menus configured for your team.

[Rest API] Get IVR

Retrieve the details of a single IVR.

[Rest API] List IVR Scenarios

List the scenarios attached to a specific IVR.

[Rest API] List Scenarios

List all IVR scenarios across your team.

[Rest API] List Tags

List the call tags defined for your team.

[Rest API] Get Tag

Retrieve the details of a single call tag.

[Rest API] List Conversations

List SMS and chat conversations.

[Rest API] Get Conversation

Retrieve a single conversation.

[Rest API] List Conversation Messages

List the messages within a conversation.

[Rest API] List Profiles

List the user permission profiles defined for your team.

[Rest API] List Presences

Retrieve the presence status of every team member. Requires the Monitoring permission.

[Rest API] Get User Presence

Retrieve the presence status for a single user.

[Rest API] List Blacklisted Numbers

List the numbers your team has blacklisted.

[Rest API] List Campaigns

List your outbound calling campaigns.

[Rest API] List Campaign Numbers

List the phone numbers (contacts) in a campaign's call queue.

[Rest API] List Transcriptions

List call transcriptions.

[Rest API] List Tasks

Search CRM tasks for your team. Ringover exposes this as a POST search rather than a plain GET list.

[Rest API] List Conferences

List conference rooms. Requires the Monitoring permission.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Ringover data sources can also be manually configured to ingest data from any valid Ringover Public API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Ringover data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Ringover destination, and select the Send to Destination option from the menu. Select the Ringover connector from the list of available destination connectors, then select the credential that will be used to connect to Ringover, and click Next; or, create a new Ringover credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Ringover endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Contact

Create a new contact from Nexset records, including first name, last name, company, and phone numbers.

[Rest API] Update Contact

Update an existing contact.

[Rest API] Delete Contact

Delete a contact.

[Rest API] Send SMS

Send an SMS message to an E.164-formatted phone number.

[Rest API] Archive Conversation

Archive an SMS or chat conversation. Ringover has no direct send-message endpoint (new messages are sent via Send SMS); this endpoint exposes the archive action.

[Rest API] Create Callback

Initiate a callback between a Ringover user and an external number.

[Rest API] Create Tag

Create a new call tag with a name, color, and description.

[Rest API] Create Tasks (Batch)

Create one or more CRM tasks from a list of phone numbers. Ringover only exposes batch task creation; there is no single-task create endpoint.

[Rest API] Archive Call

Archive a call record. This is a soft delete: the call is removed from default listings but remains retrievable by ID.

[Rest API] Start Campaign

Start an outbound calling campaign. Ringover has no campaign-creation endpoint; campaigns are created in the dashboard and started or managed via the API.

Manual configuration

Ringover destinations can also be manually configured to send data to any valid Ringover Public API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Ringover endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Ringover endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.