rent

Закрыть аренду

GEThttps://onlinesim.io/stubs/handler_api.php?action=setRentStatus

Закрывает аренду (status=2, единственное поддерживаемое значение). Аренду без SMS можно закрыть через 120 секунд после начала, ее резерв снимается; подтвержденная аренда закрывается без возврата средств. Номера США нельзя закрыть досрочно.

Ошибки в JSON:

  • NO_ID_RENT — id не указан, или нет активной аренды с этим id
  • INCORECT_STATUS — status не равен 2

Ошибки текстом: EARLY_CANCEL_DENIED (прошло менее 120 секунд с начала аренды без SMS), BAD_ACTION (номер США, или номер сейчас не удалось закрыть: повторите позже) и общие ошибки.

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

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

Параметры

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

Имя метода: setRentStatus

Перечисление:setRentStatus
id*integer
≥ 1

ID операции из getRentNumber или getRentList

Пример:22867858
status*integer

2 — закрыть

Перечисление:2Пример:2

Ответы

200Аренда закрыта или ошибка
text/plain
Схема
schemaoneOf
Одно из
[0]string
Перечисление:EARLY_CANCEL_DENIED
[1]string
Ошибка, которую любой метод (в том числе JSON-методы) возвращает текстом:
  • BAD_KEY — API ключ неверный или отсутствует
  • BANNED — аккаунт заблокирован
  • BAD_ACTION — неизвестный метод или ошибка без собственного кода (например, временная ошибка или слишком много одновременных запросов); проверьте запрос и повторите его позже
  • Too many requests. Please wait a moment before trying again. — лимит конвертера для getNumber, getRentNumber, setStatus и setRentStatus (3 запроса в секунду, 150 за 30 секунд)
Перечисление:BAD_KEYBANNEDBAD_ACTIONToo many requests. Please wait a moment before trying again.
application/json
Схема
schemaoneOf
Одно из
[0]object
[1]objectОшибка JSON-метода. Коды перечислены у каждого метода

Примеры

closed

Аренда закрыта

{
  "status": "success"
}
noRent

Нет такой аренды

{
  "status": "error",
  "message": "NO_ID_RENT"
}

Примеры кода

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