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.
Header
Anfrage
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.
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.
Antwort
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.
US/Canada NANP area code (NPA) as an integer.
Unix timestamp when this number was deactivated; it is released 14 days later. Null when active.
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.
Unix timestamp (seconds since epoch)
Unix timestamp (seconds since epoch)