नेविगेशन पर जाएँ
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