Skip to main content
GET
/
shop
/
numbers
/
countries
/
{country_code}
/
areas
/
{calling_code}
/
numbers
List available numbers
curl --request GET \
  --url https://restapi.fax.plus/v3/shop/numbers/countries/{country_code}/areas/{calling_code}/numbers \
  --header 'Authorization: Bearer <token>'
{
  "numbers": [
    {
      "type": "<string>",
      "currency": "<string>",
      "availability": "<string>",
      "item": {
        "id": "<string>",
        "country": "<string>",
        "number": "<string>",
        "country_code": "<string>",
        "geographic_area": {
          "area_code": "<string>",
          "geographic_area": "<string>",
          "city": "<string>"
        }
      },
      "price": 123,
      "monthly_fee": 123,
      "number_of_months": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
country_code
string
required

Country code (ISO 3166-1 alpha-2)

​
calling_code
string
required

Area code

Query Parameters

​
channel
enum<string>
default:random

Channel to specify whether numbers should be 'random' or 'custom'. Optional, defaults to 'random'.

Available options:
random,
custom
​
contains
string

If 'custom' is selected as the channel, this field allows specifying numbers that should appear in the phone number. Optional, only used when channel is 'custom'.

Pattern: ^[0-9]*$

Response

List of available fax numbers

​
numbers
object[]
required