For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Header
xi-api-keystringOptional
xi-workspace-idstring or nullOptional
The customer workspace a reseller's API key acts on.
Antwort
Erfolgreiche Antwort
_idstring
is_activebooleanSchreibgeschützt
accepts_public_callsbooleanSchreibgeschützt
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOptional
Phone number in E.164 format.
is_byobooleanOptionalStandardwert ist 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.
providerenumOptionalStandardwert ist twilio
Telephony provider for this phone number.
Erlaubte Werte:
nanp_area_codeintegerOptionalStandardwert ist 0
US/Canada NANP area code (NPA) as an integer.
customer_facing_agent_idstring or nullOptional
The receptionist that answers this number. Null when the workspace holds the number but no receptionist answers it yet.
deactivated_at_unixinteger or nullOptional
Unix timestamp when this number was deactivated; it is released 14 days later. Null when active.
deactivation_reasonenum or nullOptional
Why this number was deactivated. Null when active.
Erlaubte Werte:
regulatory_statusenum or nullOptional
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.
Erlaubte Werte:
regulatory_number_typeenum or nullOptional
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Erlaubte Werte:
regulatory_countrystring or nullOptional
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
