Skip to content

GET /api/getState.php

Получить информацию о номерах с активными операциями

Возвращает подробную информацию обо всех активных номерах профиля (или только об указанном номере).

Позволяет проверить статус операций Вашего аккаунта и прочесть полученные на заказанные Вами номера SMS-сообщения.

Вы можете использовать этот запрос для получения списка всех сообщений с активных номеров для их последующей обработки.

Фактически является репрезентацией блока активных операций ("Мои номера") личного кабинета.

Активные операции

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

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

Параметры

НазваниеТипОписание
tzidinteger
≥ 1

ID операции

Пример:10000
message_to_codeinteger

'Режим отображения SMS:

0 - показать SMS целиком,

1 - показать только код из SMS’

Перечисление:01Пример:1
orderbystring

'Порядок сортировки:

asc - сортировка по возрастанию;

desc - сортировка по убыванию’

Перечисление:ascdescПо умолчанию:ascПример:asc
msg_listinteger
≥ 0, ≤ 1

'Режим отображения списка сообщений:

0 - только активное сообщение,

1 - в виде списка’

Перечисление:01Пример:1
cleaninteger
≥ 0, ≤ 1

'Режим отображения сообщений (только при переданном параметре
msg_list = 0):

0 - отображать ранее показанные сообщения,

1 - не отображать ранее показанные сообщения’

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

Язык ответа:

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

de - немецкий,

ru - русский,

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

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

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

Ответы

200

‘Успешный ответ на запрос getState: сервер возвращает
текущую информацию об активных номерах Вашего аккаунта или
выбрасывает исключение.’

Примеры кода