rent

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

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

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

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

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

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

Параметры

query3
НазваниеТипОписание
action*string

Имя метода, в данном случае setRentStatus

Перечисление:setRentStatusПо умолчанию:setRentStatus
id*integer
≥ 1

ID операции (выдается при заказе, смотри getRentList)

status*number

Код статуса операции (константа, может принимать лишь значение 2, в противном случае вернет ошибку)

Перечисление:2По умолчанию:2

Ответы

200Успешный ответ от сервера на запрос setRentStatus: либо меняет статус операции аренды, либо выбрасывает исключение.
Content-Typeapplication/json
Схема
schemaobject
statusstring
Статус выполнения запросаПример:success

Примеры

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

Примеры кода

Генерация примеров...