Ringover

Integrated

Voice intelligence. Quake Agents listen to calls, transcribing and summarizing key details into the CRM automatically, so your consultants can focus on the conversation, not the notes.

1 Integration

141 Endpoints

Available integrations

Ringover

Ringover REST API allows you to easily retrieve your phone information, access your contacts, users and groups and their properties.

Archive a specific conversations in level 2. This will archive a specific conversation in level 2 on which you have the right to write.

Archive a specific conversations in level 2. This will archive in level 2 a message in a specific conversation on which you have the right to write.

Unarchive a specific message. This will unarchive a message in a specific conversation in which you have the right to write

Archive a specific conversation in level 1 This will archive in level 1 a specific conversation in which you have the right to write

Archive a specific message in level 1. This will archive in level 1 a message in a specific conversation in which you have the right to write

Updates the purpose of specific conversation This will update the purpose of a specific conversation on which you have the right to read

Create a WhatsApp template This endpoint creates a Whatsapp message template and returns the template UUID. The template name should not have upper case and special characters.

Archive call logs Archive call logs associated with specified channels for the authenticated user's team.

Remove a team blacklisted number Remove a number from your team's blacklist.

Archive call This request allows you to archive a call (Rights monitoring enable = Dashboard effect | Rights monitoring disable = MyRingover effect).

Archive call with channelID This request allows you to archive a call with channelID (Rights monitoring enable = Dashboard effect | Rights monitoring disable = MyRingover effect).

Delete group(s)from the specific campaign CALL List Delete group(s)from the specific campaign CALL List

Delete number(s) from the queue of specific campaign CALL List Delete number(s) from the queue of specific campaign CALL List

Delete column of the numbers of a specific campaign CALL List Delete column of the numbers of a specific campaign CALL List. The column will be deleted from the 'social_data' field of the numbers. Will also add a log of the operation (c.f. /campaigns/call/{campaignscalllistuuid}/logs).

delete all tags of a specific campaign CALL List delete all tags of a specific campaign CALL List

Delete user(s)from the specific campaign CALL List Delete user(s) from the specific campaign CALL List

Delete contact Delete the contact by their id

Delete numbers for specific contact Delete permanently all phone numbers of the contact set in the route

Delete number for specific contact Delete the phone number of the contact set in parameter

Delete calls or delete media from calls

Disassociate a flag from a call

Remove a user from a group This request allows you to remove a user from a group.

Delete a user This request allows you to delete permanently a user from their unique identifier.

Remove a user blacklisted number Remove a number from your user's blacklist (user must have the WRITE rights for users routes).

Delete a WhatsApp template This endpoint deletes a Whatsapp message template.

Retrieve team plans data Retrieve team available plans with name/id/licence counts (used and owned)

Get team's blacklist Retrieve the phone numbers blacklisted by your team

Check if a number is blacklisted Check if a number is blacklisted, a 200 HTTP Code response mean the number is blacklisted, a 404 HTTP response mean that the number isn't in the blacklist.

Get all calls This request allows you to retrieve your terminated calls. All the parameters are optional. For a more refined search, please refer to the POST method. > *Note: In the response, multiple items in the call list can have the same call ID. This behaviour occurs when a call is transferred or when it goes through a standard, you will notice changes in the `from_number/to_number` or `scenario_name/scenario_id` respectively.*

Get call by id This request allows you to retrieve data about the terminated call set in the route parameter. The array list contains all the logs generated by the call, (for example in the case of call forwarding).

Get all survey answers for the callId indicated in the route

Get list of campaign CALL List Retrieve a list of campaigns calllist

Get a specified campaign calllist Retrieve data about a campaign calllist

get the groups for a specific campaign CALL List get the groups for a specific campaign CALL List

Get all the logs about a campaign This is getting all the history

get the queue of numbers for a specific campaign CALL List get the queue of numbers for a specific campaign CALL List

get the users for a specific campaign CALL List get the users for a specific campaign CALL List

Get a list of CALL List campaigns Retrieve campaigns that are started

Get all conferences from team This request allows you to retrieve all the conferences you've set up. The size of the list is indicated in the variable list_count.

Get a conference This request allows you to retrieve a conference.

Get contacts Retrieves your list of contacts (yours and those shared with you). The maximum of rows returned is set in the parameter limit_count (limited to 500 rows). All the parameters are optional. If the \"search parameter\" is filled, results are sorted by relevance (according to how good the match is). Note: If a contact has an emoji in their `firstname`, `lastname`, and/or `company`, it will not be displayed in the response body.

Get specific contact Retrieve data as well as all `numbers` to a specific `contact` by their identifier

Lists conversations filtered by some parameters. This will show the first 100 available conversations by default. When you provide a 'limit_offset' X with a 'limit_count' Y, the first X conversations will be ignored, and the following Y conversations will be returned. > Warning : You will see the conversations you are allowed to see. If you are a supervisor, you will see the conversations of people you supervise (according to the profile linked to your user) and if you have admin rights, you will see all team users' conversations.

Gets information about specific conversation This will get information about specific conversation in which you have the right to read. For messages, only the last is retrieved. To access all messages.

Lists members of specific conversation This will show all members in a specific conversation on which you have the right to read

Lists messages from a specific conversation in which you have the right to read This will show the first 100 available messages in a specific conversation. When you provide a 'limit_offset' X with a 'limit_count' Y, the first X conversations will be ignored, and the following Y conversations will be returned.

Get a Call Object by "call_uuid"

Get a Call moment by "call_uuid"

Get chatGPT summary of a Call by "call_uuid"

Get multiple Call objects using the query parameters as a filter

Retrieve flags for the team

get a call uuid

retrieve a summary retrieve a summary

Get all groups from your team This request allows you to retrieve the 100 first groups from your team.

Get a specific group from your team This request allows you to retrieve data about a group.

Get all ivrs from team This request allows you to retrieve all your ivrs. The size of the list is set in the variable list_count.

Get an ivr This request allows you to retrieve the ivr corresponding to the identifier indicated in the route.

Get all scenarios from a specific ivr This request allows you to retrieve all the scenarios attached to the ivr indicated in the route. The size of the list is set in the variable list_count.

Get a scenario by id from a specific ivr This request allows you to retrieve a scenario's information by indicating in the route its identifier and that of its ivr.

Get all numbers This request allows you to retrieve the `numbers` list for your whole team. The size of the list is set in the variable list_count. The `is_available` filter is `true` by default and the other filters are `false` by default. You must have the admin rights in order to use parameters.

Get number This request allows you to retrieve information about an existing number. You simply have to set the phone number in the route (E.164 format).

Get all presences Retrieve presences information about all your users

Get all profiles Retrieve all your team's profiles

Get profile Retrieve the profile associated with the profile_id in the route (user must have the READ rights for users routes).

Get all snooze labels This request allows you to get the list of snooze labels in several languages if applicable.

Retrieve call summaries based on date range or user ID This endpoint retrieves a summary of calls for a specified user within a given date range. It requires permissions associated with the user's token and includes optional limits and offsets.

Get all tags This request allows you to retrieve all your tags. The size of the list is set in the variable list_count.

Get a specific tag This request allows you to retrieve the tag corresponding to the provided identifier.

Get full team object This request allows you to get a complete `team` object that contains a list of `numbers`, `users`, `ivrs`, `conferences`, `tags` and `groups`.

Get transcriptions Retrieves your team's transcriptions. For each transcription, in the items of the array of the transcription_data.speeches field, the field channelId takes one of the following values: - 1 for the caller emitting the call - 0 for the callee receiving the call If the call is received by a Ringover user while the call is emitted by a call member that is not a registered contact, the contact field will be null. The maximum rows returned has to be set in the parameter limit_count (limited to 1000 rows). All the parameters are optional.

Get transcription by callId Retrieves one single transcription by its Call ID. For the returned transcription, in the items of the array of the transcription_data.speeches field, the field channelId takes one of the following values: - 1 for the caller emitting the call - 0 for the callee receiving the call If the call is received by a Ringover user while the call is emitted by a call member that is not a registered contact, the contact field will be null.

Get all users from a team This request allows you to retrieve all the users on your team, and a list of their numbers for each. The size of the list is set on the attribute `list_count`.

Get a specific user This request allows you to retrieve basic data about a user and all phone numbers assigned to them.

Get user's blacklist Retrieve the phone numbers blacklisted by the user in parameter (user must have the READ rights for users routes).

Check if a specific phone number is present in the blacklist of a specific user. Check if a number is blacklisted, a 200 HTTP Code response mean the number is blacklisted, a 404 HTTP response mean that the number isn't in the user's blacklist (user must have the READ rights for users routes).

Get user's plannings This request allows you to retrieve a user's planning information if the planning of the user is enabled in their settings. Otherwise, `is_planning` will indicate \"false\".

Get user's presences This request allows you to retrieve a user's presences information.

Get user snooze log This request allows you to get a user's snooze log

Get all WhatsApp accounts associated with the user This endpoint retrieves all WhatsApp accounts associated with the user.

Get WhatsApp conversations This endpoint retrieves all Whatsapp conversations. Account UUID is a optional parameter.

Get all WhatsApp templates associated with the account This endpoint retrieves all WhatsApp templates associated with the account.

Update the comment of a team's blacklisted number Update the comment of a team's blacklisted number

update the max retry of a specific campaign CALL List update the max retry of specific campaign CALL List and all associated numbers

update the name of specific campaign CALL List update the name of specific campaign CALL List

Update number(s) from the queue of specific campaign CALL List Update number(s) from the queue of specific campaign CALL List

Rename column of the numbers of a specific campaign CALL List Rename column of the numbers of a specific campaign CALL List. The column will be renamed in the 'social_data' field of the numbers. The column can't be renamed to a name that already exists both in or out of 'social_data'. Will also add a log of the operation (c.f. /campaigns/call/{campaignscalllistuuid}/logs).

Switch columns of the numbers of a specific campaign CALL List Switch columns of the numbers of a specific campaign CALL List. Will also add a log of the operation (c.f. /campaigns/call/{campaignscalllistuuid}/logs).

Start a campaign CALL List Start a campaign CALL List

Edit campaign start date CALL List Edit campaign start date CALL List

Stop a campaign CALL List Stop a campaign CALL List

Update pincode for specific conference This request allows you to update the pincode of the conference indicated in the parameter. You have to set parameters directly in the URL.

Update company for specific contact Update the attributed company of the contact indicated in the parameter. You have to set the parameter directly in the URL.

Update firstname for specific contact Update the attributed firstname of the contact indicated in the parameter. You have to set the parameter directly in the URL.

Update lastname for specific contact Update the attributed lastname of the contact indicated in the parameter. You have to set the parameter directly in the URL.

Update is_shared status for specific contact Toggle the attribute is_shared of the contact indicated in the parameter

Toggle free access to the group Toggle the `is_jumper` parameter of a specific group: it allows users to leave and join the group freely. This corresponds to the `Free access` switch of the group in the dashboard.

Patch the ring duration This request allows you to patch the ring duration for a user in a group.

Update the comment of a user's blacklisted number Update the comment of a user's blacklisted number (user must have the WRITE rights for users routes)

Invite multiple users Invite several users and create all associated resources.

Add a number to your team's blacklist Add a number to your team's blacklist, with or without comment (user must have the WRITE rights for users routes)

Callback This API route is used to trigger a call in specific IVR queue (the user must have the WRITE right with their API key for the call routes). Caution: this feature adds call redirection fees. Here is the call workflow: 1. Your user (from_number) receives a call from the recipient's number (to_number) 2. Your user picks up the phone > A call is automatically made to the recipient (to_number).

Get all calls This request is used to retrieve detailed data of your terminated calls according to the following filters. None of the filters are mandatory but some depends on others. Please check the elements' descriptions. > *Note: In the response, multiple items in the call list can have the same call ID. This behaviour occurs when a call is transferred or when it goes through a standard, you will notice changes in the `from_number/to_number` or `scenario_name/scenario_id` respectively.*

Get all current calls This request allows you to retrieve all currents calls. This route is only available with the POST method. The current_calls_filter object must be sent.

Add group(s) to the specific campaign CALL List Add group(s) to the specific campaign CALL List

Add number(s) to the queue of specific campaign CALL List Add number(s) to the queue of specific campaign CALL List

Add column to the numbers of a specific campaign CALL List Add column to the numbers of a specific campaign CALL List. The column will be added to the 'social_data' field of the numbers. The column name can't be used in or out of the 'social_data' field. Will also add a log of the operation (c.f. /campaigns/call/{campaignscalllistuuid}/logs).

Reset a campaign Put everything back to zero

Add user(s) to the specific campaign CALL List Add user(s) to the specific campaign CALL List

Event to send a DTMF for specific channel Event to send a DTMF for specific channel

Event to hangup a specific channel Event to hangup a specific channel

Event to enable/disable hold for specific channel Event to enable/disable hold for specific channel

Event to enable/disable mute for specific channel Event to enable/disable mute for specific channel

Event to enable/disable record for specific channel Event to enable/disable record for specific channel

Event to transfer a specific channel Event to transfer a specific channel

Get or Create contacts The function depends on the parameter you send: the JSON contact_filter to retrieve contacts (yours and those shared with you), or contact_creation to create new ones. Only one parameter must be sent. When creating contacts, each contact is automatically assigned to the user associated with the API_KEY used for the request. You can create up to 50 contacts at once. When retrieving contacts, the maximum number of contacts returned is defined by the variable limit_count (limited to 500 contacts). If the \"search\" parameter is filled, results are sorted by relevance (based on how well they match). Note: If you create a contact with an emoji in the `firstname`, `lastname`, or `company` fields, it will work but the emoji will not be displayed in the response body when retrieving the contact.

Add new number(s) for specific contact Allow to add one or more numbers to the contact set in parameter. Phone numbers must be in international format.

Renames a specific conversation This will update the name of a specific conversation on which you have the right to read

Unarchive a specific conversation This will unarchive a specific conversation in which you have the right to write

Send a chat message

Associate a flag with a call

Upload a call or video recording Upload a call (audio) or video recording with metadata. Either send a file or a file_url, not both.

Add a user to a group This request allows you to add a user to a group so that, for example, they have the same rights as other users already in the group. Make sure that it is possible to join the group freely (free access switch).

IVR Callback IVR Callbacks are only available in the Business and Advanced plans. Credit charges may apply based on your destination. This API route is used to trigger a call in specific IVR queue (the user must have the WRITE right with their API key for the call routes).

Get team tasks

Create a batch of tasks from a list of numbers

Sends a message This will send an SMS (the user must have the WRITE rights for Conversations routes). If you worry about your consumption, we invite you to read the following article "<a href='https://www.ringover.com/support/texting-understanding-and-ontrolling-usage'>SMS: understand and control your consumption</a>". Phone numbers must be in E.164 format.

Sends a one-way message This will send a one-way SMS or Push SMS (the user must be admin and have the WRITE rights for Conversations routes). Phone number must be in E.164 format.

Create a tag This request allows you to create a tag.

Create a user WILL BE DEPRECATED => All new invitations should be done with /users/invite. This request allows you to create a new user with or without commitment from their email address and phone number (E.164 format). An invitation email will be sent to the user, they will have to confirm their account to log in to Ringover.

Add a number to a user's blacklist Add a number to a user's blacklist, with or without comment (user must have the WRITE rights for users routes).

Update profile ID This request allows you to update the user's profile by replacing it with the one corresponding to the id set in parameter.

assigns a script_uuid if body has no script_uuid and campaign does, it removes the link

update the tag list of a specific campaign CALL List update the tag list of a specific campaign CALL List

Update specific contact Update the contact from their id. All fields are mandatory, except the array of numbers. If the array of numbers is set, then the numbers will be purged and replaced by those present in the parameter, otherwise no action will be taken for them.

Update a number for specific contact Update a phone number from the id and the phone number of the contact. The number in the API route is the old number, while the new number is in the json parameter. Phone numbers must be in E.164 format.

Set user's planning This request allows you to replace a user's entire planning with a new one (the planning of the user must be enabled in their settings).

Set user's planning of specific day This request allows you to replace a user's day planning with a new one (the planning of the user must be enabled in their settings).

Set user's snooze status This request allows you to set a user's snooze status

send Whatsapp message

Send a WhatsApp template message This endpoint sends a WhatsApp template message to a specified external number.