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

GET /api/rent/closeRentNum.php

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

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

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

apikey

BearerAuth

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

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

Параметры

query2

Название	Тип	Описание
`tzid`*	`string`	ID операции, возвращается сервером при выдаче номера (в ответ на запрос getNum или getRentNum). Список активных операций профиля с их ID можно также через getState или getRentState
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке Перечисление:`frderuenzh`По умолчанию:`ru`

Ответы

200

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

Content-Typeapplication/json

Схема

ResponseoneOf

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

Одно из

[0]object

responsestringОбязательный

"1" — операция аренды успешно закрыта. Возвращается только статус; номер, SMS и баланс не передаются

Перечисление:1

[1]object

responsestringОбязательный

Код ошибки, специфичный для метода:

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

Перечисление:ERROR_NO_OPERATIONSNO_COMPLETE_TZIDTRY_AGAIN_LATER

[2]object

responsestringОбязательный

Код ошибки в формате UPPER_SNAKE_CASE, возвращается в поле response при HTTP-статусе 200. Список кодов не является закрытым и может пополняться. Неизвестный код следует трактовать как обобщенную ошибку и логировать для разбора.

Известные коды, сгруппированные по смыслу:

Параметры запроса

UNDEFINED_COUNTRY — некорректное значение параметра страны. Доступные значения — в списке стран;
UNDEFINED_DAYS — некорректный срок аренды или продления. Допустимые значения — в объекте days ответа tariffsRent - для базовых сроков аренды, и в объекте extend ответа getRentState - для продления;
ERROR_NO_SERVICE — некорректное значение параметра сервиса. Доступные значения — в списке сервисов.

Состояние и доступность

NO_NUMBER — нет доступных номеров с указанными параметрами. Повторите запрос позже или попробуйте другую страну;
WARNING_LOW_BALANCE — недостаточно средств на балансе.

Аккаунт и доступ

ACCOUNT_BLOCKED — аккаунт заблокирован;
API_ACCESS_DISABLED — доступ к API отключён в настройках профиля (см. тумблер API включено);
API_ACCESS_IP — IP-адрес отсутствует в allowlist (см. Доступ с IP).

Авторизация

ERROR_WRONG_KEY — некорректный API-ключ;
ERROR_NO_KEY — API-ключ отсутствует.

Лимиты запросов

INTERVAL_CONCURRENT_REQUESTS_ERROR — превышена допустимая частота или количество одновременных запросов.

Маршрутизация

REQUEST_NOT_FOUND — имя вызываемого метода некорректно или отсутствует.

Прочее

TRY_AGAIN_LATER — непредвиденная ошибка

Примеры

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"
}

Примеры кода

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