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
pagination
Pagination mode for message browsing (disabled if `false`)
In: query
Schema:
  • boolean
lang

Response language:
fr - French
de - German
ru - Russian
en - English
zh - Chinese

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
    Properties:
    • response
      mixed
      1, if the request has been completed successfully, or an error message
      Example: 1
      One Of:
      • integer
      • string
    • list
      array
      List of active rental operations
      Items:
      • object