탐색으로 건너뛰기
ReceptionPhone Numbers

Move Phone Number

Move a phone number to a different receptionist in the same workspace, which answers its calls from then on. Returns 409 phone_number_not_attached for a number no receptionist answers yet (attach it with POST /v1/reception/phone-numbers/assignments).

경로 매개변수

phone_assignment_idstring필수

헤더

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 from now 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