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

# SASBOSS API

> Set up and remove users, Microsoft Teams calling and phone numbers in your clients' SASBOSS enterprises, and read call records and billing

The common use is onboarding and offboarding: a new hire gets a phone number on their site and Teams calling, a desk phone or an extension with it, and a leaver's service is suspended or removed, with their number kept for the next person or given back. Agents also add numbers to a client's site and take them back.

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

## What It Does

* Allocate phone numbers from your account to a client's site, take them back, quarantine and release them, and raise porting orders
* Set up a user's Microsoft Teams calling, extension, hunt group or SIP trunk; change their number, extension, user ID and service pack; suspend and remove them
* Assign, rebuild and reboot desk phones
* Change forwarding, schedules, time-of-day routing, call rejection and BroadWorks Anywhere
* Send SMS and faxes from a service, and read their reports
* Read call records, call centre statistics, call recordings, invoices, balances and charges, and add payments and charges

## Permission Groups

| Group | Covers |
| - | - |
| Customers & Sites | Enterprises (your clients) and their groups (sites or departments), the event log, and a group's music on hold, caller ID, calling profile, dial plan and common phone list |
| Phone Numbers | Your numbers and their status, allocating them to a group and removing them, porting orders, quarantining and releasing numbers, number notes |
| Users & Services | Extensions, Microsoft Teams users and channels, hunt groups and SIP trunks; their numbers, extensions, user IDs, service packs; suspending and terminating them |
| Call Routing | Call forwarding, schedules, time-of-day forwarding, call rejection, busy lamp fields, BroadWorks Anywhere, call centre overflow, outgoing calling profile |
| Devices | Your device inventory and the phones on a service; assigning, removing, rebuilding, rebooting and factory resetting them |
| SMS & Fax | SMS contact lists, sending SMS and their reports, eFax |
| Call Records | Call records per client and per service, call centre statistics, call recordings (read only) |
| Billing | Balances, invoices, pending and transacted charges, billable call exports, products; adding payments and charges |
| Reseller Account | New SASBOSS logins and domains |

## 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 to numbers, users, routing and devices; no other write is allowed |
| **IT Admin** | Every read, and every change to numbers, users, routing and devices outside [Safety Controls](#safety-controls) | Changes to sites, SMS and fax, billing and logins, and the changes in [Safety Controls](#safety-controls) |
| **Full Automation** | Every read and write outside [Safety Controls](#safety-controls) | The changes in [Safety Controls](#safety-controls) |

## Safety Controls

| Control | Behavior |
| - | - |
| **Always asks** | Terminating a whole group (site), factory resetting a phone, and any change that sets a password (a portal, login or SIP password, or a Microsoft admin password) always ask a technician, whatever the profile |
| **Each ticket stays with its client** | On a ticket that names a company, Neo changes only records in the enterprise that company is mapped to: it reads a group or user before each change and refuses one in another enterprise. A change to one number by its id is left to dashboards, chats and scheduled runs. Reads are not narrowed |
| **Updates keep what they leave out** | An update of an enterprise, a site or a user reads the stored record first, so every field the agent did not change, the portal password included, stays as it was |
| **Invoice files** | Neo does not download an invoice PDF; it reads the invoice list instead |
| **Credentials in answers** | Neo removes passwords and tokens from every answer before the agent reads it |
| **The login's role** | SASBOSS checks the role of the login Neo signs in with on every call, so Neo can never do more than that login |


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