get tariffsRent

https://onlinesim.io/api/rent/tariffsRent.php
rent

Returnes information on available for rent numbers of specified country (or all of countries, if not specified): rental plans and other parameters of rent.

Unlike regular SMS receiving, rental implies a longer period of use. Also, unlike regular receiving, you can receive any number of SMS messages during the entire rental period from various senders: from websites and applications to SMS sent from regular mobile numbers.

If you initially chose a number with the extention option, you can extend the rental at any time before it expires.

IMPORTANT NOTE!

Please note that some services are prohibited for use (and SMS from these services will not be received), you can find the list of such services on the front page or in Public offer.

Security

Parameters

country

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

In: query
Schema:
  • string
    Example: "7"
    Minimum string length: 1
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 `tariffsRent` request: the server returns information on available rental plans or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"code":46,"enabled":true,"new":true,"position":1,"count":{"\"period_in_days\"":20},"days":{"\"period_in_days\"":0},"extend":0,"confirm":true}
    Properties:
    • code
      integer

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

      Example: 46
      >= 1
    • enabled
      boolean
      Availability of virtual numbers of a country (available/unavailable)
      Example: true
    • new
      boolean
      Was the country recently added to the list
      Example: true
    • position
      integer
      Country position in the list in the user dashboard (by default)
      Example: 1
      >= 0
    • count
      object
      Contains information on the amount of available numbers for each available rental period
      Example: {"\"period_in_days\"":20}
    • days
      object
      Contains information on the price for each initial rental period
      Example: {"\"period_in_days\"":0}
    • extend
      integer
      Amount of available numbers for rent with extention option
      Example: 0
    • confirm
      boolean
      Example: true