Ir para a navegação
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).

Parâmetros de caminho

phone_assignment_idstringObrigatório

Cabeçalhos

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

Solicitação

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

Resposta

Resposta bem-sucedida

_idstring
is_activebooleanSomente leitura
accepts_public_callsbooleanSomente leitura
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOpcional
Phone number in E.164 format.
is_byobooleanOpcionalPadrão é 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.

providerenumOpcionalPadrão é twilio
Telephony provider for this phone number.
Valores permitidos:
nanp_area_codeintegerOpcionalPadrão é 0

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

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

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

deactivation_reasonenum or nullOpcional
Why this number was deactivated. Null when active.
Valores permitidos:
regulatory_statusenum or nullOpcional

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.

Valores permitidos:
regulatory_number_typeenum or nullOpcional
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Valores permitidos:
regulatory_countrystring or nullOpcional
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
created_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

updated_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

Erros

422
Unprocessable Entity Error