> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# RingCentral API

> Read and change RingCentral users, call handling, call queues, devices and numbers, and read call logs and queue statistics

The common uses are an onboarding or offboarding agent that adds or removes a user's extension, number and phone, a request agent that changes a user's forwarding or queue membership, and a report of extensions, numbers and call queue statistics.

> [!NOTE]
>
> Automatically enabled when you configure RingCentral permissions in your agent workflow.

## What It Does

* Read the account, extensions and their status, and each user's presence and Do Not Disturb setting
* Read call logs, missed calls and calls in progress, and call queue statistics from RingCentral's call analytics
* Read the phone number inventory and each user's phones
* Add, change, disable and remove users; assign numbers; send welcome emails
* Change call handling and forwarding on both RingCentral call handling versions (state-based rules and answering rules)
* Add or remove call queue agents, and set whether an agent takes queue calls
* Read who left voicemails and sent texts, send texts, post in team messaging, and read RingSense AI call summaries

## Permission Groups

| Group | Covers |
| - | - |
| Account, Sites & Webhooks | The account, business address, sites, custom fields, regional settings, audit trail, 10DLC brands and webhook subscriptions |
| Users & Extensions | Users and every other extension, their status, contact details, caller ID and features, the company directory and SCIM |
| Roles & Permissions | User roles and who holds them, admin roles included |
| Call Handling & Forwarding | Call handling states and rules, forwarding numbers and targets, business hours, call blocking, greetings and IVR menus |
| Call Queues & Groups | Call queues, members and agents' availability, overflow, call monitoring and paging groups |
| Presence & Do Not Disturb | Each user's presence and Do Not Disturb setting |
| Call Logs & Analytics | Call logs, active calls and call analytics (read only) |
| Call Recordings | Recording settings, who is recorded and each recording's details, never the audio |
| Live Calls | Placing, answering, transferring, parking, holding, recording and ending calls; RingOut |
| Devices & Phone Numbers | Phones, device inventory and phone numbers |
| Emergency Addresses (E911) | Emergency addresses and the network map that assigns them |
| Messages & Voicemail | Voicemails, faxes, texts and pager messages received, business SMS threads, opt-outs and consents, message templates |
| Send Texts & Pages | Sending a text, a high-volume SMS batch or a company pager message |
| Address Book | Each user's personal contacts and favorites |
| Team Messaging | Chats, teams, posts, tasks, notes, events, adaptive cards and incoming webhooks |
| Video & Webinars | Video bridges, meeting history and recordings, webinars, sessions and registrants |
| AI Call Insights | RingSense transcripts, summaries and next steps of a call or meeting (read only) |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Every change, call and text. Roles stay read only |
| **IT Admin** | Every read, and changes to users, call handling, queues, presence, devices, numbers, messages and team messaging | Roles, call recordings and emergency addresses |
| **Full Automation** | Every read and write | Deleting a site, webhook subscriptions, and the updates that replace a whole record or list |

## Safety Controls

| Control | Behavior |
| - | - |
| **Writes** | Neo sends only the calls in RingCentral's API reference, each with its own method. Every other call is refused |
| **Updates** | Before an update of a stored setting, Neo reads the record and keeps the settings you did not change, because RingCentral resets what an update leaves out |
| **Whole-record updates** | Replacing a whole contact, SCIM user, network switch, calendar event, or a user's list of roles, call queues, favorites or administered sites always asks a technician |
| **Webhooks** | Creating or changing a webhook subscription, which sends events to the URL it names, always asks a technician |
| **Bulk deletes** | A delete of several users, numbers, devices or recordings must name each one; Neo refuses an empty list |
| **History** | Neo never deletes a user's whole call log or message store |
| **Sites** | Deleting a site always asks a technician |
| **Credentials** | Neo never reads a device's SIP password, and never mints, refreshes or revokes a RingCentral token for the agent |
| **Files** | Neo does not download recordings, voicemail audio or transcripts, faxes or images, and does not upload files |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.