Skip to content

GET /stubs/handler_api.php?action=setRentStatus

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

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

WARNING

Закрытие операции это необратимый процесс: как только операция будет закрыта, Вы не сможете использовать или восстановить доступ к данном арендному номеру.

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

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

  • api_key
  • BearerAuth
  • OAuth2 (Области: rent-scope)
    • rent-scope: grants access to renting phone numbers from Onlinesim

Параметры

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

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

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

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

Пример:10000
status*number

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

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

Ответы

200

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

Примеры кода