v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Shop

List available numbers

Get a list of available fax numbers for a specific area. (Permitted scopes: fax:all:read, fax:shop:read)

get/shop/numbers/countries/{country_code}/areas/{calling_code}/numbers

Path parameters

country_codestring required

Country code (ISO 3166-1 alpha-2)

calling_codestring required

Area code

Query parameters

channel'random' | 'custom'

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

containsstring

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'.

Response

List of available fax numbers