SkySwitch API

The common use is onboarding and offboarding: a new hire gets an extension, a phone, a number with its E911 address and their call queues, and a leaver’s are removed, with their number kept, rerouted or released. Scheduled agents also report each client’s used and free seats and the numbers that ring no one.

Automatically enabled when you configure SkySwitch permissions in your agent workflow.

What It Does

Add, change and remove PBX users (extensions), their devices and desk phones
Buy phone numbers from SkySwitch’s catalog, route them to a user, queue or auto attendant, set their E911 address, and disconnect them
Add users to call queues, sign agents in and out, and change answer rules and forwarding
Count each client’s users against their seat limit, and find users with no phone in use and numbers that ring no one
Read call records, voicemail, recordings and live calls
Manage SMS and MMS on numbers, port-in orders, entitlements and reports

Permission Groups

Group	Covers
Users and Extensions	PBX users (extensions) per client domain with their caller ID, voicemail and portal login
Devices and Phones	Users’ devices and their registration, desk phones (MAC addresses), phone models, fax ATAs
Phone Numbers	The number inventory and each domain’s numbers, the catalog, buying, reserving and disconnecting numbers, caller ID name, spam settings, the company a number belongs to, the PBX DID table
Call Routing	Where each number rings, answer rules and forwarding, time frames, auto attendants, conference bridges, SIP trunks, trunk groups, routes by caller
Call Queues and Agents	Call queues and their agents, signing agents in and out
Live Calls	Active calls; placing, answering, holding, transferring, recording and hanging up calls
Call History	Call records per client domain and user (read only)
Voicemail and Recordings	Voicemail and greetings, call recordings, the recording setting of a user or queue
Emergency Addresses (E911)	Each number’s E911 address, address checks, a domain’s emergency numbers
SMS and Messaging	SMS and MMS on numbers, messaging users and forwarding, sending messages, 10DLC and toll-free registrations
Number Porting	Port-in orders and their numbers, portability checks
Customer Domains and Accounts	Your client domains with their limits and billing summary, accounts, sub-accounts and companies
Entitlements, Settings and Reports	Entitlements of resellers, companies and users, UC settings, reports
Portal Users	Users of your SkySwitch portal
Portal Roles	Portal user roles, and giving a PBX user an Office Manager, Site Manager, Call Center Supervisor or Reseller scope
Reseller Administration	Carriers, branding, release note subscribers, PBX event subscriptions, audit logs and journals

Access Profiles

Profile	What runs on its own	What asks a technician
Read Only	Every read	No write is allowed
Helpdesk	Every read outside voicemail, portal and reseller settings	Every change to users, devices, numbers, routing, queues, live calls and E911; no other write is allowed
IT Admin	Every read, and every change outside portal users, portal roles, reseller settings and Safety Controls	Portal user, portal role and reseller changes, and the changes in Safety Controls
Full Automation	Every read and write outside Safety Controls	The changes in Safety Controls

Safety Controls

Control	Behavior
Always asks	Deleting a client domain, deleting a portal user for good, updating a portal user or a port order’s customer service records, and setting a password, voicemail PIN, SIP key, conference PIN or porting PIN always ask a technician, whatever the profile
Each ticket stays with its client	On a ticket that names a company, Neo sends a call only for the domain that company is mapped to, and a call on one phone number only for a number that domain holds or a new number from the catalog. Calls across every client are left to dashboards, chats and scheduled runs
Every domain at once	Neo refuses a PBX write that names every domain with `*`, and an event subscription that names no domain
Sign-in	Neo never signs in with a user’s password, and does not use SkySwitch’s ActivePieces app, which needs a user’s own sign-in
Credentials in answers	Neo removes passwords, PINs and SIP keys from every answer before the agent reads it

Getting started

Core

Triggered & Scheduled Agents

Chat Agents

Integrations

Product

Workflows

Customizing Neo

What It Does

Permission Groups

Access Profiles

Safety Controls

​What It Does

​Permission Groups

​Access Profiles

​Safety Controls

What It Does

Permission Groups

Access Profiles

Safety Controls