Sign in
Phone Numbers

Watch an out-of-stock country

Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the phone_number.stock_available webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.

Countries and types marked fulfilment: request by GET /v1/phone-numbers/countries can also be watched, but anything with preOrderable: true does not need a watch: submit KYC and the carrier sources the number to order.

Pass areaCode (with numberType) to watch one sold-out area, for example an entry of soldOutAreas from GET /v1/phone-numbers/availability. Area stock is checked live on the same 6h cadence.

post/v1/phone-numbers/stock-watches

Request body

countrystring required

ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries.

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

Narrow the watch to one number type. Omit to be notified when any type in the country is back.

areaCodestring

Narrow the watch to one area code (NDC). Requires numberType.

Response

A watch for this country and type already existed; returned unchanged.

idstring required
countrystring required

ISO 3166-1 alpha-2.

countryNamestring required
numberType'local' | 'mobile' | 'national' | 'toll_free' | 'null' nullable required

The watched number type, or null when the watch covers every type in the country.

areaCodestring nullable

The watched area code (NDC), or null when the watch covers every area.

createdAtstring date-time required

Changes