Order a number

Orders a phone number from a recent availability search and starts billing for it.

This spends money and can't be undone through this API. To stop paying for a number, disconnect it.

Use it:

  1. Search with POST /api/v1/numbers/available/local or /toll_free.
  2. Order a number from those results. If it has aged out of the saved results, you get a 404: search again and reorder.
  3. On an account that routes calls only through call flows, choose the number's call flow in call_flow_uuid.

Notes:

  • A 200 means the carrier accepted the order, not that the number is ready to take calls.
  • Needs an API key with the Admin role, and an account with a billing customer. Sending customerId doesn't work around that.

Accounts that route calls only through call flows:

  • call_flow_uuid is checked before anything is ordered, and the number arrives attached to that call flow.
  • No published call flow yet? Leave it out: the number arrives attached to a new "Default call flow", which simply hangs up and which you can edit like any other.
  • If your chosen call flow is deleted, or can no longer take numbers, before the number arrives, the number goes to the Default call flow instead.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The number to order. It must be one a recent availability search returned.

string

Billing customer to charge. Must be one of your account's customers; defaults to the first.

string

Subscription to add the number to. Must belong to the selected customer, otherwise one is chosen for you.

uuid

The call flow the number arrives attached to: one of your account's published call flows. Required when your account routes calls only through call flows and already has a published call flow. Other accounts get 400 invalid_parameter.

Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json