get getRentNum

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

This request allows you to rent a number of a specific country for SMS receiving.

You can use this request when you need to receive messages from multiple different services or from a single one, but over a long time period.

IMPORTANT NOTES!

Please note that every new rent operation has a 20 minute protective interval, during which SMS must be received by issued number. If you won't use the number within this timeframe the operation will be terminated automatically and the cost of rent will be refunded.

Also 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.

Security

Parameters

country

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

In: query
Schema:
  • integer
    Example: 46
    >= 1
days
Required

Initial rental period (in days), see available values in tariffsRent response

In: query
Schema:
  • integer
    Example: 1
    >= 1
extension
Auto-renewal (when enabled, automatically extends the rental for 30 days upon expiration)
In: query
Schema:
  • boolean
    Example: true
pagination
Message pagination
In: query
Schema:
  • boolean
    Example: true
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 `getRentNum` request: the server issues a number with requested parameters for rent or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"response":1,"item":{"status":0,"messages":{"current_page":1,"data":[{}],"from":1,"last_page":12,"per_page":20,"to":2,"total":4},"country":46,"rent":0,"extension":1,"checked_time":"2022-07-17 11:55:13","sum":215.5,"number":"9108501010","tzid":10000,"time":19,"days":0,"hours":14,"extend":{"\"extension_period_in days\"":0},"checked":true,"reload":1,"day_extend":36,"m_ext":true,"freeze":true}}
    Properties:
    • response
      mixed
      1, if the request has been completed successfully, or an error message
      Example: 1
      One Of:
      • integer
        Example: 0
      • string
        Example: "string"
    • item
      object
      Example: {"status":0,"messages":{"current_page":1,"data":[{}],"from":1,"last_page":12,"per_page":20,"to":2,"total":4},"country":46,"rent":0,"extension":1,"checked_time":"2022-07-17 11:55:13","sum":215.5,"number":"9108501010","tzid":10000,"time":19,"days":0,"hours":14,"extend":{"\"extension_period_in days\"":0},"checked":true,"reload":1,"day_extend":36,"m_ext":true,"freeze":true}