Passer à la navigation
ReceptionPhone Numbers

Lister les numéros de téléphone

List the workspace’s phone numbers and the receptionist each one rings. A number with no customer_facing_agent_id is held by the workspace but not attached to a receptionist yet.

En-têtes

xi-api-keystringOptionnel
xi-workspace-idstring or nullOptionnel
The customer workspace a reseller's API key acts on.

Réponse

Réponse réussie

_idstring
is_activebooleanLecture seule
accepts_public_callsbooleanLecture seule
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOptionnel
Phone number in E.164 format.
is_byobooleanOptionnelPar défaut false

True when the phone is bring-your-own: registered by the workspace using their own telephony provider (Twilio credentials or SIP trunk). BYO phones are never part of the shared pool, do not count against the plan’s phone number limit, and are deleted (rather than returned to the pool) on release.

providerenumOptionnelPar défaut twilio
Telephony provider for this phone number.
Valeurs autorisées:
nanp_area_codeintegerOptionnelPar défaut 0

US/Canada NANP area code (NPA) as an integer.

customer_facing_agent_idstring or nullOptionnel
The receptionist that answers this number. Null when the workspace holds the number but no receptionist answers it yet.
deactivated_at_unixinteger or nullOptionnel

Unix timestamp when this number was deactivated; it is released 14 days later. Null when active.

deactivation_reasonenum or nullOptionnel
Why this number was deactivated. Null when active.
Valeurs autorisées:
regulatory_statusenum or nullOptionnel

Null for numbers that need no paperwork. held while the workspace’s own application is under review, approved once it passed and the number is fully usable.

Valeurs autorisées:
regulatory_number_typeenum or nullOptionnel
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Valeurs autorisées:
regulatory_countrystring or nullOptionnel
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
created_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

Erreurs

422
Unprocessable Entity Error