탐색으로 건너뛰기
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