跳到导航
ReceptionPhone Numbers

Assign Phone Number

Give a receptionist a phone number. A number the workspace already holds but has not attached is used first. Otherwise, in the US and Canada, a number with one of the requested area_codes is taken from the pool or bought, falling back to any number in the business’s country. In countries that require paperwork, the number is issued right away but takes public calls only once the workspace’s own registration is approved (see accepts_public_calls). Counts toward the plan’s phone number limit, and free plans can take only a few new numbers a day. Returns 404 when no number is available and 403 telephony_managed_by_reseller when the reseller supplies the workspace’s numbers from its own Twilio account or SIP trunk and none is free.

请求头

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

请求

This endpoint expects an object.
customer_facing_agent_idstring必需
The receptionist that answers calls to the number.
area_codeslist of strings or null可选

Preferred US or Canadian area codes, e.g. ["415", "628"]. Codes outside the business’s country are ignored, and any number is given when none of these is available.

number_typeenum or null可选
Local or mobile, in a country that requires paperwork before a number takes calls. Leave unset to try mobile first. Ignored in the US and Canada.
允许的值:
idempotency_keystring or null可选<=255 characters

Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 idempotency_key_in_progress; a different body with the same key gets 400 idempotency_key_reused. A request that fails is not saved, so it can be retried with the same key.

响应

成功响应

_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