Numbers // supply-side DID pool
LIVE · /api/v1/ucaas
Number supply

Numbers

The supply-side DID pool. Preload stock, then assign, reserve or release numbers per tenant. Configure where supply comes from below — provider credentials are write-only and never displayed.

In pool
numbers loaded
Available
ready to assign
Assigned
live on tenants
Reserved
on hold

Preload numbers into stock

POST /ucaas/numbers/preload · idempotent per number
First column is the E.164 number (required). Optional: 2-letter country, then number_type (local · national · tollfree · mobile). Header row is auto-detected and skipped.

Number source configuration

GET / PUT /ucaas/numbers/source-config
Allow own carriers
Platform gate — when on, resellers may bring their own upstream carriers / SBCs for number supply. Togglable by a platform admin only; resellers can read it but not change it.
CURRENTLY: —
Credentials are write-only and never shown. The console only reports whether a set is stored.
Stored Fernet-encrypted on the server. Send {} to clear stored creds. 503 is returned if the server encryption key is unset.

Number stock

// loading…
NumberTypeCountryStatusMonthlyE911Actions
// loading…
Hosted PBX

Extensions & Devices

Provision PBX extensions and their SIP endpoints. Expand a row to manage devices — a new device's SIP password is shown once, at creation, and can never be retrieved again.

New extension

POST /ucaas/pbx/extensions
Platform admins must target a tenant. Reseller/tenant operators are pinned to their own scope; this is ignored for them.

Extensions

// loading…
ExtensionDirect DIDCaller IDStatusActions
// loading…
Voicemail

Voicemail

Manage mailboxes and their messages. Set a PIN (write-only — never displayed), mark messages read or delete them, and review the visual-voicemail feed across all accessible boxes.

New voicemail box

POST /ucaas/voicemail/boxes

Mailboxes

// loading…
Mailboxvm-to-emailTranscribePINCapacityActions
// loading…
Call routing

Ring Groups

Hunt groups: dial a single pilot number to ring a set of members by strategy — all at once, in sequence, round-robin or longest-idle — then fall through to an overflow target if nobody answers.

New ring group

POST /ucaas/ring-groups
Set the type and target together, or leave both empty to disable overflow.
Platform admins must target a tenant. Reseller/tenant operators are pinned to their own scope; this is ignored for them.

Ring groups

// loading…
GroupPilotStrategyRingOverflowStatusActions
// loading…
Call routing

Auto-Attendants

Build the inbound menu (IVR): a greeting plus keypad options that route callers to an extension, ring group, voicemail or another menu. Draft it, then publish to take it live.

New auto-attendant

POST /ucaas/auto-attendants
Platform admins must target a tenant. Reseller/tenant operators are pinned to their own scope; this is ignored for them.
Menu options
Map keypad digits to a destination. These compile into the attendant's published flow graph; an invalid graph is rejected on save.
Advanced — raw flow definition (JSON)
Leave blank to compile from the builder above. When filled, this raw definition is sent verbatim (overrides the builder) and validated server-side.

Auto-attendants

// loading…
NameVersionPublishedActiveActions
// loading…
Call routing

Conferences

Conference bridge rooms. Each room is reached by its room number, with an optional member PIN and a moderator PIN. PINs are write-only — set once, never displayed back.

New conference room

POST /ucaas/conferences
Platform admins must target a tenant. Reseller/tenant operators are pinned to their own scope; this is ignored for them.

Conference rooms

// loading…
RoomNameCapacityMember PINModerator PINStatusActions
// loading…
Carrier integration

Connectors

The supply path behind your number pool. Pick a connector kind, store its credentials (write-only, encrypted), then test, sync, search and provision numbers — or begin a port-in — through it.

Connector configuration

// loading…
Credentials are write-only and never shown. The console only reports whether a set is stored.
Stored encrypted on the server. Send {} to clear stored credentials. 503 is returned if the server encryption key is unset.

Supply operations

search · provision · release · port-in
NumberCountryAreaTypeSourceActions
// run a search to list available supply
Wholesale meter

Wholesale Meter

Platform → reseller billing preview, per period. Every meter always yields a line — including the switching fee. A deliberate 0.000 rate is a real $0.00 line; an unconfigured rate is flagged and excluded from billing.

A 0.000-rate line is a real charge (priced at zero) — it is posted. An unconfigured meter has no rate set at all: its line is shown for visibility but is not billed, so nobody is silently charged $0.
Priced — will be billed Deliberate $0.00 — billed Unconfigured — not billed

Preview a period

GET /ucaas/billing/preview
Saved