Naar navigatie springen
ReceptionPhone Numbers

Assign Phone Number

Give a receptionist a phone number. A number the workspace already holds but has not attached is used first. Otherwise, in the US and Canada, a number with one of the requested area_codes is taken from the pool or bought, falling back to any number in the business’s country. In countries that require paperwork, the number is issued right away but takes public calls only once the workspace’s own registration is approved (see accepts_public_calls). Counts toward the plan’s phone number limit, and free plans can take only a few new numbers a day. Returns 404 when no number is available and 403 telephony_managed_by_reseller when the reseller supplies the workspace’s numbers from its own Twilio account or SIP trunk and none is free.

Headers

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

Verzoek

This endpoint expects an object.
customer_facing_agent_idstringVerplicht
The receptionist that answers calls to the number.
area_codeslist of strings or nullOptioneel

Preferred US or Canadian area codes, e.g. ["415", "628"]. Codes outside the business’s country are ignored, and any number is given when none of these is available.

number_typeenum or nullOptioneel
Local or mobile, in a country that requires paperwork before a number takes calls. Leave unset to try mobile first. Ignored in the US and Canada.
Toegestane waarden:
idempotency_keystring or nullOptioneel<=255 characters

Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 idempotency_key_in_progress; a different body with the same key gets 400 idempotency_key_reused. A request that fails is not saved, so it can be retried with the same key.

Response

Geslaagde response
_idstring
is_activebooleanAlleen-lezen
accepts_public_callsbooleanAlleen-lezen
Whether inbound calls from the public may reach the receptionist.
phone_numberstring or nullOptioneel
Phone number in E.164 format.
is_byobooleanOptioneelStandaard 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.

providerenumOptioneelStandaard twilio
Telephony provider for this phone number.
Toegestane waarden:
nanp_area_codeintegerOptioneelStandaard 0

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

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

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

deactivation_reasonenum or nullOptioneel
Why this number was deactivated. Null when active.
Toegestane waarden:
regulatory_statusenum or nullOptioneel

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.

Toegestane waarden:
regulatory_number_typeenum or nullOptioneel
The regulated number type this number was issued as. Null for numbers that need no paperwork.
Toegestane waarden:
regulatory_countrystring or nullOptioneel
ISO country the regulated number was issued in. Null for numbers that need no paperwork.
created_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

Fouten

422
Unprocessable Entity Error