GET /stubs/handler_api.php?action=setRentStatus
Change rent operation status
This request closes the rent on a specified phone number.
WARNING
Closing the operation is irreversible process: once you close the operation, you won't be able to use or restore access to this rental 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
- OAuth2 (Scopes: rent-scope)
rent-scope: grants access to renting phone numbers from Onlinesim
Parameters
| Name | Type | Description |
|---|---|---|
action* | string | Method name, in this case Enum: setRentStatusDefault:setRentStatus |
id* | integer≥ 1 | Operation ID (assigned upon order, according to Example: 10000 |
status* | number | Operation status code (constant value, can only accept Enum: 2Default:2Example:2 |
Responses
200
Successful setRentStatus response from the server: either
changes the rental operation status or throws an exception.
Code Samples
No code samples available