latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Billing1

Chats20

Common3

Contact Notes6

Contacts22

Custom Fields6

Distribution Lists5

Email campaign senders1

Email Campaigns1

Inbound Messages5

Lists17

Lookup2

Numbers5

Outbound Message Sessions6

Outbound Messages14

Scheduled Email Campaigns1

Scheduled Messages5

Sender IDs4

Sender Settings3

Statistic3

Tags1

Templates7

User4

User Settings8

User Subaccounts6

Numbers

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

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"
}