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

GET /api/getState.php

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

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

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

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

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

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

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

apikey

BearerAuth

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

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

Схема

ResponseoneOf

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

Одно из

[0]object[]

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

itemsobject

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

ID операции

≥ 1

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

Статус операции:

TZ_INPOOL — ожидание выдачи номера
TZ_NUM_WAIT — номер выдан, ожидание SMS
TZ_NUM_ANSWER — SMS получено
TZ_OVER_OK — операция завершена
ERROR_NO_ITEMS — операция неудачна / номер не выдан

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

numberstring

Номер телефона в международном формате со знаком +

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

Код страны без +

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

Slug сервиса

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

Стоимость услуги

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

Секунд до конца операции

≥ 0

msgoneOf

Одно из

[0]string

Содержимое SMS. По умолчанию — только код; при message_to_code=0 — весь текст; при msg_list=1 — список всех входящих сообщений

[1]string[]

Список полученных сообщений (при msg_list=1)

itemsstring

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

Вид приёма (для приёма SMS всегда index)

guard_interval_remaining_secondsinteger

Секунд до разрешения досрочного закрытия без SMS. Возвращается только при передаче параметра number в запросе

≥ 0

[1]object

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

Код успешного выполнения запроса

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

listobject[]Обязательный

Список активных операций

itemsobject

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

ID операции

≥ 1

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

Статус операции:

TZ_INPOOL — ожидание выдачи номера
TZ_NUM_WAIT — номер выдан, ожидание SMS
TZ_NUM_ANSWER — SMS получено
TZ_OVER_OK — операция завершена
ERROR_NO_ITEMS — операция неудачна / номер не выдан

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

numberstring

Номер телефона в международном формате со знаком +

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

Код страны без +

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

Slug сервиса

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

Стоимость услуги

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

Секунд до конца операции

≥ 0

msgoneOf

Одно из

[0]string

[1]string[]

Список полученных сообщений (при msg_list=1)

itemsstring

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

Вид приёма (для приёма SMS всегда index)

guard_interval_remaining_secondsinteger

Секунд до разрешения досрочного закрытия без SMS. Возвращается только при передаче параметра number в запросе

≥ 0

[2]object

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

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

ERROR_NO_OPERATIONS — нет активных операций или такого tzid не существует
ERROR_UNDEFINED — неопределенная ошибка

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

[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 — непредвиденная ошибка

Примеры

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

Примеры кода

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