> ## 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.

# Telavox API

> Read Telavox queue and call statistics, live queues and recordings, and change users, queues, profiles, numbers and desk phones

The common uses are a phone statistics dashboard, an onboarding agent that creates a Telavox user and sends the welcome email, and a request agent that adds a user to a call queue or forwards their calls. Telavox is also sold as Voxone by Voip Unlimited.

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

## What It Does

* Read users, licences, numbers, call queues and their members, IVRs, phone numbers, portings and desk phones
* Read each user's recorded calls and call transcriptions, the token user's call history with missed calls, and the calls in each queue now
* Read call, queue and per-user statistics over a period from Telavox's Studio API, with a Statistics Token
* Create, change, replace and remove users; send the welcome and password reset emails
* Add or remove queue members and change queue settings; switch availability profiles and forward calls
* Reserve numbers, register, reboot and move desk phones, and keep contacts and templates
* Call or text from the token's user

## Permission Groups

| Group | Covers |
| - | - |
| Company, Sites & Groups | The company's contacts, address, delivery and invoice places, and groups |
| Users | Users, their numbers, languages, login emails, hotdesk settings and SIP registrations; welcome and password reset emails |
| User Permissions | The rights each user holds, administration included |
| Licences & Purchases | Licences, add-ons and PBX licences owned and on sale, and each user's licences |
| Availability & Forwarding | Each user's availability profiles, the active one, and their forwarding |
| Queues, IVRs & PBX Services | Call queues and members, IVRs, shared voicemail and fax extensions |
| Call History & Live Calls | The token user's call history, each user's calls now, and each queue's calls now (read only) |
| Call Statistics | Calls, queue calls and the calls that rang each user over a period, from the Studio API; needs the Statistics Token (read only) |
| Place Calls & Send Texts | A call or a text from the token's user |
| Recordings & Transcriptions | Each user's recorded calls (never the audio) and call transcriptions |
| Contacts | The company directory, the shared address book and custom contact fields |
| Phone Numbers & Porting | Numbers, main numbers, reserved and free numbers, and portings |
| Desk Phones | Registered desk phones, their owners and status |
| User Templates | Templates new users start from, with their profiles and contact settings |

## 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. User rights, licences and numbers stay read only |
| **IT Admin** | Every read, and changes to users, queues, profiles, contacts, desk phones and templates | User rights, licence purchases, calls and texts, recordings, numbers and porting |
| **Full Automation** | Every read and write | Changing every user's contact at once, deleting a contact field, resetting a user's profiles, a desk phone's factory reset, and three updates that may clear fields |

## Safety Controls

| Control | Behavior |
| - | - |
| **Writes** | Neo sends only the calls in Telavox's API reference, each with its own method. Every other call is refused |
| **Statistics** | Neo sends only GraphQL queries to the Studio API, and only with the Statistics Token. A query Telavox answers with errors is refused, so no total is made from part of the data |
| **Tokens** | The API token goes only to your portal, and the Statistics Token only to Telavox's statistics host |
| **Updates** | Before an update of a contact, a company contact, a desk phone or hotdesk settings, Neo reads the record and keeps what you did not change |
| **Company-wide changes** | Changing the contact details of every user or PBX service at once, or deleting a contact field from every user, always asks a technician |
| **Resets** | Resetting a user's profiles from a template, and a desk phone's factory reset, always ask a technician |
| **Lists** | A call that adds or removes queue members, contacts or users must name each one; Neo refuses an empty list |
| **Credentials** | Neo never reads a hotdesk PIN or a password reset link; it sends the user the reset email instead |
| **Files** | Neo does not download call recordings |


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