Find dedicated numbers available for purchase

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/undefined/getAvailableDedicatedNumbers" target="_blank">Try in sandbox</a><br>

get/api/v2/numbers/available

Request

Base URL
https://rest.textmagic.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/textmagic/apis/textmagic-api/docs/api/v2/numbers/available/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

prefixinteger

Desired number prefix. Should include the country code (i.e. 447 for UK phone number format). Leave blank to get all the available numbers for the specified country.

tollfree0 | 1

Should we show only tollfree numbers (tollfree available only for US).

countrystring required

The 2-letter dedicated number country ISO code.

Response

The list of available to buy dedicated numbers.

numbersstring[] required

Array of phone numbers.

pricenumber float required

Dedicated number monthly fee for this country. Returned in the current account currency.

giftType'none' | 'registration' | 'first_month' | 'include_in_plan' required

Example response

{
  "numbers": [
    447860021130,
    447860021131
  ],
  "price": 2.4,
  "giftType": "none"
}

Changes

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