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

GET /api/setOperationRevise.php

Получить следующее SMS, полученное номером

Перемещает внутренний указатель на следующее SMS-сообщение для указанного ID операции. Метод только сдвигает указатель на следующее сообщение в рамках операции, он не возвращает текст SMS. Для получения содержимого сообщения после вызова этого метода, используйте getState.

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

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

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

Параметры

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

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

langstring

Язык ответа:

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

de - немецкий,

ru - русский,

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

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

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

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

Ответы

200

Успешный ответ на запрос setOperationRevise: сервер сдвигает указатель на следующее SMS, поступившее на этот номер, или выбрасывает исключение

Content-Typeapplication/json
Схема
ResponseoneOf

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

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

ID операции (тот же, что был передан в запросе)

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

"1" — запрос выполнен успешно, указатель сдвинут на следующее SMS

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

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

  • ERROR_NO_TZID — параметр tzid не был передан
Перечисление:ERROR_NO_TZID
[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 — непредвиденная ошибка

Примеры

SMS pointer moved successfully

Успешное выполнение запроса, указатель сдивнут

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

Примеры кода

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