ナビゲーションにスキップ
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