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.
Encabezados
xi-api-keystringOpcional
xi-workspace-idstring or nullOpcional
The customer workspace a reseller's API key acts on.
Respuesta
Respuesta correcta.
_idstring
is_activebooleanSolo lectura
accepts_public_callsbooleanSolo lectura
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOpcional
Phone number in E.164 format.
is_byobooleanOpcionalValor predeterminado: 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.
The receptionist that answers this number. Null when the workspace holds the number but no receptionist answers it yet.
deactivated_at_unixinteger or nullOpcional
Unix timestamp when this number was deactivated; it is released 14 days later. Null when active.
deactivation_reasonenum or nullOpcional
Why this number was deactivated. Null when active.
Valores permitidos:
regulatory_statusenum or nullOpcional
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.
Valores permitidos:
regulatory_number_typeenum or nullOpcional
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Valores permitidos:
regulatory_countrystring or nullOpcional
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
