NS — Phone Numbers
The NetSapiens Phone Numbers page lists every phone number on the NetSapiens domain and routes each one to the contact center or the PBX, writing the change to NetSapiens directly.
The NetSapiens Phone Numbers page manages the phone numbers (DIDs) on a NetSapiens domain from within CCaaS. Each number can be sent to the contact center — to the default routing, an IVR, a skill, or an agent — or left on the PBX, and any number can be tagged as an outbound number for agents to call out from. The page writes each change to NetSapiens, including the caller ID prefix that tells CCaaS where to route the call, so numbers no longer need to be edited in the NetSapiens Manager Portal or given a prefix typed by hand.
AvailabilityThe page is visible to Admin accounts only, on NetSapiens and Xima UCaaS accounts with voice, and must be turned on for the account by Xima Support. On Xima UCaaS accounts it is named
Xima UCaaS Phone Numbers. It requires version 2 of the NetSapiens API; on servers that do not support it, the page showsThe Netsapiens Phone Numbers page needs Netsapiens API v2instead of the list.
Accessing NetSapiens Phone Numbers
NetSapiens Phone Numbers is accessible to accounts with Admin permissions.
- Navigate to
Routing Configuration > Netsapiens Phone Numbers - All phone numbers on the NetSapiens domain are listed in the
Netsapiens Phone Numberspanel, sorted by number and grouped by where they are routed
On CallHub accounts, the page can also be opened from Admin (System) > SIP Extensions by selecting Open Netsapiens Phone Numbers — see SIP Extensions on CallHub.
Phone Number List
Each group heading shows how many numbers it holds — for example, Routed to Contact Center (11).
| Group | Description |
|---|---|
Routed to Contact Center | Numbers that ring the contact center |
Routed to Netsapiens - Outbound Number | Numbers the PBX still answers but that are tagged as outbound numbers. Hidden when empty |
Routed to Netsapiens | Every other number. The PBX handles these calls |
Each row shows the number and where it rings:
| Routing Shown | Description |
|---|---|
Default routing, IVR: Main Menu, Skill: Billing, Agent: Pat Smith(684) | A number routed to the contact center, and what answers it |
Netsapiens call queue 2000, Netsapiens extension 212, Netsapiens voicemail 555, Netsapiens time of day routing, Forward to (435) 555-0100 | A number the PBX routes. "Netsapiens" in the name means a PBX call queue, extension, or voicemail box — not a CCaaS skill |
Prefix "XDT Support/" | A number routed to the contact center with a prefix the page did not write, usually one set up by hand in NetSapiens. The page leaves it unchanged unless the number is edited |
An outbound number shows a third line with its label and who places calls from it — for example, Sales · Agent: Pat Smith(684), Support · Skill: Support, or Front Desk · Unassigned. A pin icon marks a pinned number. On accounts where the assignment is set in SIP Extensions, the third line shows only the label.
A Disabled chip marks a number disabled in NetSapiens. The list is read from NetSapiens each time the page opens, so changes made in the NetSapiens Manager Portal appear immediately.
Select Close to close the panel.
Editing a Phone Number
- Select the pencil icon next to a phone number — the dialog re-reads the number from NetSapiens and shows its current routing in full, for example
Currently: Skill: Billing via load balancer 500 - Complete the following fields:
| Field | Description |
|---|---|
Send To | Where the call goes — see Send To |
Destination Type | Shown when the number goes to the contact center. What answers the call — see Destination Type |
Notes | Notes saved to the number in NetSapiens. Unavailable while Keep current routing is selected |
Outbound Number Label | Tags the number as an outbound number — see Outbound Numbers. Leave blank to untag |
- Select
Save
Notes LimitNetSapiens keeps 64 characters for the notes and the outbound number label combined. Notes cannot start with
Xima OB:— the page writes that tag itself fromOutbound Number Label.
Send To
| Option | Description |
|---|---|
| The load balancer | Calls ring the contact center through the load balancer |
| An inbound SIP extension | Calls ring the contact center through one of the registered inbound extensions |
Keep current routing | The number keeps its current routing exactly as it is. Used to change only the notes, the enabled state, or the outbound number label |
A number the PBX routes, or one routed to the contact center by a prefix the page did not write, opens on Keep current routing with a hint describing its current routing. Choosing any other option shows a warning naming the routing it will replace.
Destination Type
| Destination Type | Caller ID Prefix | Description |
|---|---|---|
Default routing | None | The call goes through the inbound Call Routing rules first; if no rule matches, it goes to the primary IVR |
IVR | XDT-I <IVR name>/ | The call goes to the selected IVR |
Skill | XDT-S <skill extension>/ | The call goes to the selected skill |
Agent | XDT-A <agent extension>/ | The call goes to the selected agent |
The prefix the page will write is shown read-only under the choice — for example, XDT-S 300/ for a skill. It does not need to be entered or changed by hand. These prefixes route the call ahead of any Call Routing rule, the same way as XDT Routing.
Renaming Is Safe for Skills and AgentsSkills and agents are identified by their extensions, so renaming one does not break the number. IVRs are identified by name — after renaming an IVR, open the number and select the IVR again.
Business Hours Belong in the IVRA number that needs business-hours or holiday handling should be sent to an IVR whose call flow checks a Time of Day or Holiday profile, rather than relying on NetSapiens time of day routing.
Disabled Numbers
The page never disables a number. A disabled number opens grayed out with an Enable button; selecting it unlocks the form, and the number is enabled when the dialog is saved, along with any other changes. Cancel discards both.
Outbound Numbers
An outbound number is a phone number agents can place outbound calls from. A number is tagged by entering a name in Outbound Number Label — for example, Sales — whether the number is routed to the contact center or kept on the PBX. Clearing the label untags the number. Tagged numbers appear under Outbound Numbers in SIP Extensions automatically.
Label RulesLabels cannot contain an apostrophe. The label is saved to the number's notes in NetSapiens as
Xima OB: '<label>', ahead of any other notes.
Once a number has a label, the following fields appear under it:
| Field | Description |
|---|---|
Outbound Number Assignment | Unassigned, Skill, or Agent |
Outbound Number Skill / Outbound Number Agent | The skill or agent that places calls from this number |
Outbound Number Pinned | Keeps this number as the caller ID for the assigned skill or agent |
An agent can be assigned to only one outbound number. Choosing an agent who already has one prompts to move the agent to this number.
CallHub AccountsOn CallHub, outbound numbers are set up only on this page, and the assignment fields appear only when outbound API dialing is turned on for the account — Xima Support can turn it on. Outbound numbers typed in by hand under SIP Extensions, with no SIP extension behind them, are not presented by NetSapiens as the caller ID; they are hidden from agents and removed on the next save of this page. Give those numbers an
Outbound Number Labelinstead.On accounts not using CallHub, the number is tagged with a label here and then assigned under Outbound Numbers in SIP Extensions.
See NS — Outbound Numbers for how outbound numbers fit alongside outbound extensions.
Saving
Save writes the number to NetSapiens, then saves the outbound number's assignment and pin.
- If NetSapiens refuses the change, its message is shown in the dialog and nothing is saved
- If the number saves but the assignment does not, the dialog stays open and says the number was saved, so the assignment can be corrected and saved again
SIP Extensions on CallHub
On CallHub accounts using the NetSapiens Phone Numbers page, the SIP Extensions modal lists only Inbound Extensions. Outbound Numbers no longer appear there, and existing outbound extensions remain listed and can be edited or deleted, but new ones cannot be added. A note at the bottom of the modal links to this page.
See NS — SIP Extensions.
Troubleshooting
| Symptom | Resolution |
|---|---|
| The page is not in the menu | The page is visible to Admin accounts only and must be turned on for the account. Contact Xima Support |
Needs Netsapiens API v2 | The NetSapiens server or account does not use version 2 of the NetSapiens API. Contact Xima Support |
A number shows Prefix "…" | The number was routed to the contact center by hand. Leave it as is, or open it and choose a destination to replace the prefix with one the page manages |
| No assignment fields under the label | On CallHub, outbound API dialing is off for the account. Elsewhere, assign the number in SIP Extensions |
Its notes start with "Xima OB:" but have no label | The number was tagged by hand without a label, so agents are not offered it. Enter an Outbound Number Label and save |
Use Outbound Number Label to tag an outbound number | Xima OB: was typed in Notes. Remove it and enter the name in Outbound Number Label instead |
Couldn't read this number's assignment | The page could not load who places calls from this number. The number can still be saved; its assignment and pin are left unchanged |
Its outbound number isn't set up yet | The label was just added and the contact center has not picked up the new outbound number yet. Wait a moment and save again |
| An outbound number typed in under SIP Extensions disappeared | On CallHub, those numbers do not work on NetSapiens and are replaced by this page. Give the number an Outbound Number Label |
Related Pages
Updated about 3 hours ago