get setRentStatus

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

This request closes the rent on a specified phone number.

IMPORTANT NOTE!
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

Parameters

action
Required
Method name, in this case `setRentStatus`
In: query
Schema:
  • string
    Example: "setRentStatus"
    Enum: setRentStatus
id
Required

Operation ID (assigned upon order, see getRentList)

In: query
Schema:
  • integer
    Example: 10000
    >= 1
status
Required

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

In: query
Schema:
  • number
    Example: 2
    Enum: 2

Responses

200

Successful `setRentStatus` response from the server: either changes the rental operation status or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"status":"success"}
    Properties:
    • status
      string
      Request execution status
      Example: "success"