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

Ответы

200

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

Content-Typeapplication/json

Схема

Responseobject[]

Массив активных номеров (текущих операций) по Вашему аккаунту

itemsobject

Информация об операции

countryinteger

Международный телефонный код страны (согласно стандарту E.164, без знака "+")

≥ 1

По умолчанию:7Пример:46

suminteger

Стоимость услуги, в рублях

≥ 0

Пример:14

servicestring

'Название сервиса, с теми же значениями, что и в запросе getNum'

Пример:Facebook

numberstring

Номер телефона в международном формате

Пример:+46050101010

responsestring

'Текущий статус операции (enum):

TZ_INPOOL - операция ожидает выдачи номера

TZ_NUM_WAIT - ожидание получения SMS

TZ_NUM_ANSWER - SMS было получено

TZ_OVER_EMPTY - SMS не было получено за отведенное время

TZ_OVER_OK - операция была успешно завершена

ERROR_NO_TZID - не указан tzid (ID операции)

ERROR_NO_OPERATIONS - нет активных операций на Вашем аккаунте'

Перечисление:TZ_INPOOLTZ_NUM_WAITTZ_NUM_ANSWERTZ_OVER_OKERROR_NO_TZIDERROR_NO_OPERATIONSПример:TZ_NUM_ANSWER

tzidinteger

ID операции

≥ 1

Пример:10000

timeinteger

Оставшееся время операции, в секундах

≥ 0

Пример:281

formstring

Вид приема (онлайн прием — index)

Пример:index

Примеры

Successful getState response example

[
  {
    "country": 7,
    "sum": 14,
    "service": "Facebook",
    "number": "+46050101010",
    "response": "TZ_INPOOL",
    "tzid": 10000,
    "time": 281,
    "form": "index"
  }
]

Примеры кода

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