gethttp://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentList

GET /stubs/handler_api.php?action=getRentList

Get list of active rental numbers of the profile

This request returns a list of rental numbers with current rent for your profile, including unactivated numbers, if the activation period has not expired.

You might want to use this request to retrieve a relevant information on all the active rental numbers you've ordered.

Security

api_key
BearerAuth
OAuth2Scopes: rent-scope
rent-scope
grants access to renting phone numbers from Onlinesim

Parameters

query1
NameTypeDescription
action*string

Method name, in this case getRentList

Enum:getRentListDefault:getRentList

Responses

200

Successful getRentList response from the server: either returns a list of active rental numbers by country or throws an exception.

Content-Typeapplication/json
Schema
Responseobject
statusstring

Request execution status

Example:success
valuesobject

Array of active rental numbers data of the profile

#country#object
idinteger

Operation ID

≥ 1
Example:10000
phonestring

Rental phone number without country code

Example:9089100000

Examples

List of active rental numbers
{
  "status": "success",
  "values": {
    "0": {
      "id": 22867858,
      "phone": "9912530000"
    }
  }
}

Code Samples

Generating examples...