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.
Headers
xi-api-keystringOptioneel
xi-workspace-idstring or nullOptioneel
The customer workspace a reseller's API key acts on.
Response
Geslaagde response
_idstring
is_activebooleanAlleen-lezen
accepts_public_callsbooleanAlleen-lezen
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOptioneel
Phone number in E.164 format.
is_byobooleanOptioneelStandaard 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.
providerenumOptioneelStandaard twilio
Telephony provider for this phone number.
Toegestane waarden:
nanp_area_codeintegerOptioneelStandaard 0
US/Canada NANP area code (NPA) as an integer.
customer_facing_agent_idstring or nullOptioneel
The receptionist that answers this number. Null when the workspace holds the number but no receptionist answers it yet.
deactivated_at_unixinteger or nullOptioneel
Unix timestamp when this number was deactivated; it is released 14 days later. Null when active.
deactivation_reasonenum or nullOptioneel
Why this number was deactivated. Null when active.
Toegestane waarden:
regulatory_statusenum or nullOptioneel
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.
Toegestane waarden:
regulatory_number_typeenum or nullOptioneel
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Toegestane waarden:
regulatory_countrystring or nullOptioneel
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
