Numbers

Order a number

Orders a number for the project. The Idempotency-Key header is required: when your request times out, send it again with the same key and you receive the same number, never a second one. Before ordering we check the company details, the spending cap, the payment method, a verified phone with one payment confirmed with your bank (iDEAL or a card with 3D Secure; verification_required otherwise), and the prepaid balance; each has its own error. A national number needs a business: a personal account receives business_required, and a business may need its registration number checked against the business register (verification_required with missing kvk_check). A live number is deducted from the balance: the first month when you order it, then on the first of every month. A geographic number also needs the number_documents verification level (see verification in GET /project).

post/numbers

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/numbers
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: numbers:write)

Headers

Idempotency-Keystring required

1 to 255 visible ASCII characters without spaces, like a UUID. A new one per order; reuse it when you retry. We remember a key for 24 hours.

Request body

OR

Response

The number was ordered. status is active (it works now) or pending (the registration is with the carrier).

idstring uuid required

The id of the number. Use it for the call plan.

e164string required

The number in E.164, like +447700900123.

typestring required

national (non-geographic), geographic (with an area code), mobile or tollfree.

statusstring required

pending (the registration is with the carrier, usually active within one business day), active or porting.

created_atstring date-time required

When the number was added to the project.

testboolean required

true for a test number (test mode), from the range +447700900000 to +447700900999. It can never be called for real.

from_stockboolean required

Whether the number came from our stock. A number from stock works right away.

Changes

No recorded changes to this operation across all 1 revision of this API.