GET /api/getState.php
Получить информацию о номерах с активными операциями
Возвращает подробную информацию обо всех активных номерах профиля (или только об указанном номере).
Позволяет проверить статус операций Вашего аккаунта и прочесть полученные на заказанные Вами номера SMS-сообщения.
Вы можете использовать этот запрос для получения списка всех сообщений с активных номеров для их последующей обработки.
Фактически является репрезентацией блока активных операций ("Мои номера") личного кабинета.
.png)
Безопасность
- apikey
- BearerAuth
- OAuth2 (Области: sms-scope)
sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim
Параметры
| Название | Тип | Описание |
|---|---|---|
tzid | integer≥ 1 | ID операции Пример: 10000 |
message_to_code | integer | 'Режим отображения SMS:
Перечисление: 01Пример:1 |
orderby | string | 'Порядок сортировки:
Перечисление: ascdescПо умолчанию:ascПример:asc |
msg_list | integer≥ 0, ≤ 1 | 'Режим отображения списка сообщений:
Перечисление: 01Пример:1 |
clean | integer≥ 0, ≤ 1 | 'Режим отображения сообщений (только при переданном параметре
Перечисление: 01Пример:1 |
lang | string | Язык ответа:
Перечисление: frderuenzhПо умолчанию:ruПример:en |
Ответы
200
‘Успешный ответ на запрос getState: сервер возвращает
текущую информацию об активных номерах Вашего аккаунта или
выбрасывает исключение.’
Примеры кода
Примеры кода недоступны