GET /stubs/handler_api.php?action=setRentStatus

Изменить статус операции аренды виртуального номера

Этот запрос закрывает аренду на указанном Вами номере.

Вы можете использовать этот запрос, когда Вам необходимо закрыть операцию аренду напрямую. Например, когда необходимые Вам данные уже были получены и Вы не планируете использовать этот номер в дальнейшем.

Безопасность

api_key

BearerAuth

OAuth2Области: rent-scope

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

Параметры

query3

Название	Тип	Описание
`action`*	`string`	Имя метода, в данном случае `setRentStatus` Перечисление:`setRentStatus`По умолчанию:`setRentStatus`
`id`*	`integer` ≥ 1	ID операции (выдается при заказе, смотри getRentList) Пример:`10000`
`status`*	`number`	Код статуса операции (константа, может принимать лишь значение `2`, в противном случае вернет ошибку) Перечисление:`2`По умолчанию:`2`Пример:`2`

Ответы

200

Успешный ответ от сервера на запрос setRentStatus: либо меняет статус операции аренды, либо выбрасывает исключение.

Content-Typeapplication/json

Схема

Responseobject

statusstring

Статус выполнения запроса

Пример:success

Примеры

Response upon successful operation close

{
  "status": "success"
}