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

GET /stubs/handler_api.php?action=setRentStatus

Change rent operation status

This request closes the rent on a specified phone number.

You might want to use this request when you need to close the operation explicitly and do not plan to use the number further, for example when the data you wanted has been retrieved.

Security

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

Parameters

query3
NameTypeDescription
action*string

Method name, in this case setRentStatus

Enum:setRentStatusDefault:setRentStatus
id*integer
≥ 1

Operation ID (assigned upon order, according to getRentList)

Example:10000
status*number

Operation status code (constant value, can only accept 2, else throws an error)

Enum:2Default:2Example:2

Responses

200

Successful setRentStatus response from the server: either changes the rental operation status or throws an exception.

Content-Typeapplication/json
Schema
Responseobject
statusstring

Request execution status

Example:success

Examples

Response upon successful operation close
{
  "status": "success"
}

Code Samples

Generating examples...