rent

Get your active rentals

GEThttps://onlinesim.io/stubs/handler_api.php?action=getRentList

Returns your active rentals, including those still waiting for the first SMS. Without any: {"status":"error","message":"NO_NUMBERS"}.

Security

OAuth2
rent-scope
grants access to renting phone numbers from Onlinesim

Parameters

query1
NameTypeDescription
action*string

Method name: getRentList

Enum:getRentList

Responses

200Active rentals, or an error
text/plain
Schema
schemastring
Error answered as text by every action (also by the JSON ones):
  • BAD_KEY — the API key is wrong or missing
  • BANNED — the account is blocked
  • BAD_ACTION — unknown action or an error without its own code (for example a temporary error or too many concurrent requests); check the request and repeat it later
  • Too many requests. Please wait a moment before trying again. — the converter's limit of getNumber, getRentNumber, setStatus and setRentStatus (3 requests per second, 150 per 30 seconds)
Enum:BAD_KEYBANNEDBAD_ACTIONToo many requests. Please wait a moment before trying again.
application/json
Schema
schemaoneOf
One Of
[0]object
[1]objectError of a JSON action. The codes are listed at each action

Examples

list

Active rentals

{
  "status": "success",
  "values": [
    {
      "id": 22867858,
      "phone": "7400123456"
    }
  ]
}
none

No active rentals

{
  "status": "error",
  "message": "NO_NUMBERS"
}

Code Samples

Generating examples...