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 receiving, 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 personal information.

Security

Parameters

country

International dialing code of the country (Е.164 standard, without "+" sign), see country list

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. Please note that the translation applies only to string field values, such as service names or country names. Field names themselves, error messages, and standard values (for example, true/false for boolean fields) remain in English.

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

Responses

200

Successful response for `getFreeList` request: the server returns information on free numbers and messages they've received.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"response":"string","countries":[{"country":46,"country_text":"Sweden"}],"numbers":{"#number#":{"country":46,"data_humans":"6 days ago","full_number":"+79915584911","is_archive":true}},"messages":{"current_page":1,"data":[{"text":"string","in_number":"string","my_number":0,"created_at":"string","data_humans":"6 days ago"}],"first_page_url":"string","from":0,"last_page":0,"last_page_url":"string","links":[{"url":"string","label":"string","active":true}],"next_page_url":"string","path":"string","per_page":0,"prev_page_url":"string","to":0,"total":0,"number":"string","country":46},"ignore":"string"}
    Properties:
    • response
      mixed
      1, if the request has been completed successfully, or an error message
      Example: "string"
    • countries
      array
      Array of countries with their corresponding international phone codes
      Example: [{"country":46,"country_text":"Sweden"}]
      Items:
      • object
        Example: {"country":46,"country_text":"Sweden"}
    • numbers
      object
      Example: {"#number#":{"country":46,"data_humans":"6 days ago","full_number":"+79915584911","is_archive":true}}
    • messages
      object
      Free numbers messages
      Example: {"current_page":1,"data":[{"text":"string","in_number":"string","my_number":0,"created_at":"string","data_humans":"6 days ago"}],"first_page_url":"string","from":0,"last_page":0,"last_page_url":"string","links":[{"url":"string","label":"string","active":true}],"next_page_url":"string","path":"string","per_page":0,"prev_page_url":"string","to":0,"total":0,"number":"string","country":46}
    • ignore
      string
      List of restricted services (SMS from these services are unavailable)
      Example: "string"