get getRentState

https://onlinesim.io/api/rent/getRentState.php
rent
This request returns a list of active rental numbers. You can use it to quickly browse all your active rental numbers (or only specific one) and their received messages.

Security

Parameters

tzid
Operation ID. If not specified, request will return the entire list of active rental operations
In: query
Schema:
  • integer
    Example: 0
pagination
Pagination mode for message browsing (disabled if `false`)
In: query
Schema:
  • boolean
    Example: false
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 `getRentState` request: the server returns information of specified active rental operation (or all of them) or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"response":1,"list":[{"status":1,"extension":1,"messages":[{"id":1,"service":"Google","text":"Your verification code is 070051","code":"070051","created_at":"2022-07-17 21:46:58"}],"sum":"251.5","country":46,"checked_time":"2022-07-17 21:41:20","number":"9915584307","rent":4,"tzid":10000,"time":5750,"days":3,"hours":95,"extend":{"#period_in_days#":36},"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"
    • list
      array
      List of active rental operations
      Example: [{"status":1,"extension":1,"messages":[{"id":1,"service":"Google","text":"Your verification code is 070051","code":"070051","created_at":"2022-07-17 21:46:58"}],"sum":"251.5","country":46,"checked_time":"2022-07-17 21:41:20","number":"9915584307","rent":4,"tzid":10000,"time":5750,"days":3,"hours":95,"extend":{"#period_in_days#":36},"checked":true,"reload":1,"day_extend":36,"m_ext":true,"freeze":true}]
      Items:
      • object
        Example: {"status":1,"extension":1,"messages":[{"id":1,"service":"Google","text":"Your verification code is 070051","code":"070051","created_at":"2022-07-17 21:46:58"}],"sum":"251.5","country":46,"checked_time":"2022-07-17 21:41:20","number":"9915584307","rent":4,"tzid":10000,"time":5750,"days":3,"hours":95,"extend":{"#period_in_days#":36},"checked":true,"reload":1,"day_extend":36,"m_ext":true,"freeze":true}