gethttps://onlinesim.io/api/setOperationOk.php

GET /api/setOperationOk.php

Завершить операцию активации

Закрывает операцию и меняет ее статус в зависимости от результата на успешный или неудачный.

Этот запрос необходимо посылать, когда Вы хотите явно закрыть операцию (например, после получения нужного Вам SMS сообщения). Вы также можете временно заблокировать повторную выдачу этого номера, передав параметр ban=1, для ситуаций, когда номер указан в некорректном формате (это возможно лишь при условии отсутствия входящих SMS).

Закрытие операции

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

apikey
BearerAuth
OAuth2Области: sms-scope
sms-scope
grants access to manage numbers for the SMS receiving service from Onlinesim

Параметры

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

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

baninteger

Этот параметр может быть использован в случае, если выданный Вами номер имел некорректный формат. Вы можете передать параметр со значением 1, чтобы заблокировать номер, но только если на нем нет входящего SMS

Перечисление:01
langstring

Язык ответа:

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

de - немецкий,

ru - русский,

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

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

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

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

Ответы

200

Успешный ответ на запрос setOperationOk: сервер успешно закрывает указанную операцию или выбрасывает исключение

Content-Typeapplication/json
Схема
ResponseoneOf

Успешное закрытие операции, бан не применен (response: 0), специфичная ошибка метода или общая ошибка

Одно из
[0]object
responseintegerОбязательный

1, если запрос был выполнен успешно, либо выведет сообщение об ошибке. Обработку общих ошибок смотри в разделе Обработка исключений

Перечисление:1
tzidintegerОбязательный

ID операции

≥ 1
[1]object
responseintegerОбязательный

0 — передан ban=1, но SMS уже есть, поэтому блокировка номера не может быть применена

Перечисление:0
[2]object
responsestringОбязательный

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

  • ERROR_NO_TZID — параметр tzid не был передан
  • ERROR_WRONG_TZID — операции нет или она принадлежит другому аккаунту
  • NO_COMPLETE_TZID — слишком рано закрывать операцию без SMS. Защитный интервал по умолчанию — 120 с; для WhatsApp — 300 с
  • INTERVAL_CONCURRENT_REQUESTS_ERROR — повторное закрытие той же tzid чаще, чем раз в 5 секунд
  • NO_NUMBER — партнёр/выдача не подтвердила закрытие
Перечисление:ERROR_NO_TZIDERROR_WRONG_TZIDNO_COMPLETE_TZIDINTERVAL_CONCURRENT_REQUESTS_ERRORNO_NUMBER
[3]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 — непредвиденная ошибка

Примеры

Operation closed successfully

Операция успешно закрыта

{
  "response": 1,
  "tzid": 10000
}

Примеры кода

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