get getFreeList

https://onlinesim.io/api/getFreeList
free numbers

Depending on the parameters returns information on available countries with free numbers, received messages and the list of restricted services.

Without parameters: returns a list of available countries with free numbers, messages received by the first number from the list and the list of restricted services.

With country parameter: returns a list of available free numbers of that country, messages received by the first number from the list and the list of restricted services.

With country and number parameters: returns a list of SMS messages received by this number and the list of restrices services.

You can send this request to get a number that can be used for SMS receiption later on, for example for testing.

IMPORTANT NOTES!
Please note that some services are prohibited for use (and SMS from these services are not available), you can find the list of such services on the front page or in Public offer.
It is worth to mention that since the access for these numbers is public we do not recommend to use them to create accounts for personal use with any confidential information.

Security

    Parameters

    country

    Country code (Е.164 standard, without "+" sign), see getNumbersStats

    In: query
    Schema:
    • integer
      Example: 46
      >= 1
    number
    Free phone number, without country code
    In: query
    Schema:
    • string
      Example: 9100100101
    lang

    Response language:
    fr - French
    de - German
    ru - Russian
    en - English
    zh - Chinese

    In: query
    Schema:
    • string
      Example: en
      Enum: fr de ru en zh

    Responses

    200

    Successful response for `getFreeListrequest`: the server returns information on free numbers and messages they've received.
    Content Type:
    application/json
    • Schema
    • Examples
    • object
      Properties:
      • response
        mixed
        1, if the request has been completed successfully, or an error message
      • countries
        array
        Array of countries with their corresponding phone codes
        Items:
        • object
      • numbers
        object
      • messages
        object
        Free numbers messages
      • ignore
        string
        List of restricted services (SMS from these services are unavailable)