Numbers

Search for numbers to order

Available numbers you can order with POST /numbers. Everything returned can be ordered right now. type=national returns non-geographic numbers that work across the country; numbers from our stock come first and work immediately. Regional numbers (type=geographic) need documents that cannot be uploaded through the API yet. With a test key, it returns free test numbers from +447700900000 to +447700900999 instead (test: true); they never reach the carrier.

get/numbers/available

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/numbers/available
  • 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:read)

Query parameters

type'national' | 'geographic'

national or geographic. Without it, the type follows from area: the national prefix or nothing is national.

areastring

The area code. Required for geographic; leave it out for national.

Response

The available numbers.

Changes

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