Przejdź do nawigacji
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).

Parametry ścieżki

phone_assignment_idstringWymagany

Nagłówki

xi-api-keystringOpcjonalny
xi-workspace-idstring or nullOpcjonalny
The customer workspace a reseller's API key acts on.

Żądanie

This endpoint expects an object.
customer_facing_agent_idstringWymagany
The receptionist that answers calls to the number from now on.

Odpowiedź

Pomyślna odpowiedź

_idstring
is_activebooleanTylko do odczytu
accepts_public_callsbooleanTylko do odczytu
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOpcjonalny
Phone number in E.164 format.
is_byobooleanOpcjonalnyDomyślnie 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.

providerenumOpcjonalnyDomyślnie twilio
Telephony provider for this phone number.
Dozwolone wartości:
nanp_area_codeintegerOpcjonalnyDomyślnie 0

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

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

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

deactivation_reasonenum or nullOpcjonalny
Why this number was deactivated. Null when active.
Dozwolone wartości:
regulatory_statusenum or nullOpcjonalny

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.

Dozwolone wartości:
regulatory_number_typeenum or nullOpcjonalny
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Dozwolone wartości:
regulatory_countrystring or nullOpcjonalny
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
created_at_unixintegerOpcjonalny

Unix timestamp (seconds since epoch)

updated_at_unixintegerOpcjonalny

Unix timestamp (seconds since epoch)

Błędy

422
Unprocessable Entity Error