Skip to main content

Search for available phone numbers that match your criteria.

GET 

/Accounts/:AccountSid/AvailablePhoneNumbers/:IsoCountry/Local

Search for Local AvailablePhoneNumbers.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

    AccountSid uuidrequired

    The Project ID that uniquely identifies the Account to retrieve.

    IsoCountry stringrequired

    The ISO country code of the number.

Query Parameters

    AreaCode string
    Beta boolean
    Contains string
    ExcludeAllAddressRequired boolean
    ExcludeForeignAddressRequired boolean
    ExcludeLocalAddressRequired boolean
    FaxEnabled boolean
    InRegion string
    MmsEnabled boolean
    SmsEnabled boolean
    VoiceEnabled boolean

Responses

OK

Schema

    uri string

    The URI for the API call.

    available_phone_numbers

    object[]

  • Array [

  • beta boolean

    New numbers on SignalWire are marked as beta. Possible values are true or false.

    capabilities

    object

    Whether or not a number can receive calls and messages. Possible values are voice, SMS, MMS, and Fax. Each of these values have a boolean value of true or false.

    voice boolean

    Whether or not voice is enabled on the number.

    SMS boolean

    Whether or not SMS is enabled on the number.

    MMS boolean

    Whether or not MMS is enabled on the number.

    fax boolean

    Whether or not fax is enabled on the number.

    friendly_name string

    A formatted version of the number.

    iso_country string

    The ISO country code of the number.

    lata stringnullable

    The LATA of the number. Only available for numbers in US and Canada.

    latitude string

    The latitude of the number. Only available for numbers in US and Canada.

    longitude string

    The longitude of the number. Only available for numbers in US and Canada.

    phone_number string

    The number in E.164 format.

    postal_code string

    The postal/zip code of the number. Only available for numbers in US and Canada.

    rate_center string

    The rate center of the number. Only available for numbers in US and Canada.

    region string

    The state or province abbreviation of the number. Only available for numbers in US and Canada.

  • ]

Loading...