跳到导航
ReceptionPhone Numbers

列出电话号码

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.

请求头

xi-api-keystring可选
xi-workspace-idstring or null可选
The customer workspace a reseller's API key acts on.

响应

成功响应

_idstring
is_activeboolean只读
accepts_public_callsboolean只读
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or null可选
Phone number in E.164 format.
is_byoboolean可选默认为 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.

providerenum可选默认为 twilio
Telephony provider for this phone number.
允许的值:
nanp_area_codeinteger可选默认为 0

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

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

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

deactivation_reasonenum or null可选
Why this number was deactivated. Null when active.
允许的值:
regulatory_statusenum or null可选

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.

允许的值:
regulatory_number_typeenum or null可选
The regulated number type this number was issued as. Null for numbers that need no paperwork.
允许的值:
regulatory_countrystring or null可选
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
created_at_unixinteger可选

Unix timestamp (seconds since epoch)

updated_at_unixinteger可选

Unix timestamp (seconds since epoch)

错误

422
Unprocessable Entity Error