GEThttps://onlinesim.io/api/rent/closeRentNum.php

Завершить операцию аренды виртуального номера

Этот запрос закрывает указанную операцию аренды (за исключением аренды по номерам США - ее закрытие происходит исключительно при истечении срока операции).

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

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

Параметры

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

ID операции, возвращается сервером при выдаче номера (в ответ на запрос getNum или getRentNum). Список активных операций профиля с их ID можно также через getState или getRentState

langstring

Язык ответа:

fr - французский,

de - немецкий,

ru - русский,

en - английский,

zh - китайский.

Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке

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

Ответы

200

Успешный ответ на запрос closeRentNum: сервер закрывает текущую арендную операцию и возвращает информацию о ней или выбрасывает исключение

Content-Typeapplication/json
Схема
schemaoneOf

Успешное закрытие операции аренды, специфичная или общая ошибка

Одно из
[0]object
[1]object
[2]object

Примеры

Rental operation successfully closed

Успешное закрытие операции аренды

{
  "response": "1"
}
No active rental operations

Нет активных операций аренды

{
  "response": "ERROR_NO_OPERATIONS"
}
Unable to close the specified rental operation

Закрытие во время защитного интервала недоступно: пока нет SMS и не прошло 120 секунд с момента старта (аренда еще в ожидании активации); также всегда возвращается при попытке закрыть арендный номер США

{
  "response": "NO_COMPLETE_TZID"
}

Примеры кода

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