Phone Numbers

Check country availability

Pre-purchase check, so you can warn BEFORE a customer invests in KYC (regulated review is async, 1-3 days). Tells you whether we have deliverable inventory, and what address the customer needs:

  • addressConstraint: geo → the registered address MUST be in one of the returned areas (the only place we have stock). A different-area address passes pre-approval but the number can never be assigned.
  • addressConstraint: country → any in-country address works.
  • addressConstraint: none → field-only / instant country, no address. Call this before starting the KYC form for regulated countries.

Without an API key it answers from cache only and returns just country, numberType and areaOptions, for building an area picker before signup.

Billing: Read (free unless it says otherwise) · Rate limit: 120/min

get/v1/messaging/phone-numbers/availability

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/phone-numbers/availability
  • Auth: HTTP bearer

Query parameters

smsboolean

Pass true when the buyer wants SMS: availability, areas, and areaOptions then describe the SMS-capable pool (an SMS purchase orders from it), not the wider voice-only pool.

countrystring required

ISO-2 country code.

numberType'local' | 'mobile' | 'national' | 'toll_free'

Check a specific offered type (stock and address constraints are per type). Omitted = the country's default type.

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.