GET`https://onlinesim.io/api/getState.php`

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

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

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

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

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

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

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

apikey

BearerAuth

OAuth2

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Параметры

query6

Название	Тип	Описание
`tzid`	`string`	ID операции, возвращается сервером при выдаче номера (в ответ на запрос getNum или getRentNum). Список активных операций профиля с их ID можно также через getState - для операций приема, и через getRentState - для операций аренды. Если ID операции не передан, ответ будет содержать данные обо всех операциях
`message_to_code`	`integer`	Режим отображения SMS: `0` - показать SMS целиком, `1` - показать только код из SMS Перечисление:`01`По умолчанию:`1`
`orderby`	`string`	Порядок сортировки сообщений по времени их поступления: `asc` - сортировка от старых к новым; `desc` - сортировка от новых к старым Перечисление:`ascdesc`По умолчанию:`desc`
`msg_list`	`integer`	Режим отображения списка сообщений: `0` - только активное сообщение, `1` - в виде списка всех входящих сообщений Перечисление:`01`
`clean`	`integer` ≥ 0, ≤ 1	Режим отображения сообщений (только при переданном параметре msg_list = 0): `0` - отображать ранее показанные сообщения, `1` - не отображать ранее показанные сообщения Перечисление:`01`
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке Перечисление:`frderuenzh`По умолчанию:`ru`

Ответы

200

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

Content-Typeapplication/json

Схема

schemaoneOf

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

Одно из

[0]object[]

Список активных операций. Пустой массив, если их нет (в некоторых случаях сервер возвращает ошибку — см. компоненты commonErrorResponse и getStateMethodError в отдельном разделе)

[1]object

[2]object

[3]object

Примеры

List of operations provided as an array

Успех — массив операций

[
  {
    "tzid": 10000,
    "response": "TZ_NUM_WAIT",
    "number": "+37360000000",
    "country": 373,
    "service": "telegram",
    "sum": 14,
    "time": 596,
    "msg": "123456",
    "form": "index"
  }
]

Примеры кода

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

GEThttps://onlinesim.io/api/getState.php