GEThttps://onlinesim.io/api/getFreeList

Get list of 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.

Parameters

query8
NameTypeDescription
countrystring

Country code (according to countries list)

numberstring

Free phone number, without the country code, whose incoming SMS need to be displayed

pageinteger
≥ 1

SMS page number (default is 1)

Default:1
countinteger
≥ 10, ≤ 500

Number of SMS per page. Values below 10 are coerced to 10; values above 500 — to 500. Default is 10

Default:10
localestring

Content language. Defaults to the value of lang

as_country_textstring

If yes, country in the request is treated as a country slug from the config (e.g. moldova) rather than a numeric code

Enum:yes
with_contentstring

If yes, the response includes the SEO content of the page (content field); otherwise content is null

Enum:yes
langstring

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

Enum:frderuenzhDefault:ru

Responses

200

Successful response for getFreeList request: the server returns information on free numbers and messages they've received, or throws an exception

Content-Typeapplication/json
Schema
schemaoneOf

Successful response, an OAuth scope error, or a common error

One Of
[0]object
[1]object
[2]object

Examples

Successful responseexample_lines

Returns a list of free numbers and the SMS messages received by them

{
  "response": 1,
  "countries": [
    {
      "country": 7,
      "country_text": "Россия",
      "country_original": "russia"
    }
  ],
  "numbers": {
    "9915584911": {
      "country": 7,
      "country_original": "russia",
      "data_humans": "6 дней назад",
      "full_number": "+79915584911",
      "is_archive": false
    }
  },
  "messages": {
    "current_page": 1,
    "data": [
      {
        "text": "74957982601 received from onlinesim.io",
        "in_number": "***2601",
        "my_number": 9915584911,
        "created_at": "2022-07-24 15:32:14",
        "data_humans": "1 минуту назад"
      }
    ],
    "per_page": 10,
    "total": 6100,
    "last_page": 610,
    "number": "9915584911",
    "country": 7
  },
  "ignore": "<p>…</p>",
  "content": null
}

Code Samples

Generating examples...