Описание API SimFolder

API поддерживает односторонний и двухсторонний режим работы:

В одностороннем режиме пользовательский сервер выполняет GET или POST запросы и получает ответ в формате JSON.

В асинхронном двухстороннем режиме платформа также отправляет уведомления на пользовательский сервер в формате POST-запроса, при наступлении событий, описанных в настройках.

Для обращения к API требуется api_key, который можно получить в профиле пользователя.


Методы API


Ниже перечислены ключевые методы, доступные в API.
Полное описание каждого метода предоставляется после авторизации.

atList — Ответы модема
Получение ответов модема из базы данных

atSend — Отправление AT-команды
Прямая отправка команды на модем

callAnswer — Ответ на вызов
Команда для ответа на входящий вызов

callBegin — Исходящий вызов
Запуск исходящего вызова

callDelete — Удаление записи о вызове
Удаление входящего вызова из базы

callEnd — Завершение вызова
Завершение текущего вызова

callList — Список входящих вызовов
Получение истории входящих

callOutgoingDelete — Удаление исходящего вызова
Удаление записи из истории

callOutgoingList — Список исходящих вызовов
Получение исходящих вызовов

cardDirect — Выбор SIM-карт
Назначение карт на модемы с ограничением по числу подключений

cardEdit — Редактирование SIM-карты
Изменение данных по карте

cardList — Список SIM-карт
Получение информации по всем картам

cardSelect — Подключение карт
Активное назначение карт на устройства

deviceEdit — Редактирование устройства
Обновление данных агрегатора

deviceList — Список устройств
Информация по зарегистрированным агрегаторам

deviceState — Статус устройства
Текущий статус модемов в агрегаторе

operatorEdit — Редактирование оператора
Изменение сведений о мобильном операторе

operatorList — Список операторов
Перечень доступных операторов

settingsGet — Получение настроек уведомлений
Текущие параметры уведомлений

settingsSet — Установка настроек уведомлений
Обновление параметров уведомлений

smsDelete — Удаление входящего SMS
Удаление входящих SMS из системы

smsList — Список входящих SMS
Получение входящих сообщений

smsOutgoingDelete — Удаление исходящего SMS
Удаление отправленных сообщений

smsOutgoingList — Список исходящих SMS
Просмотр исходящих сообщений

smsSend — Отправка SMS
Прямая отправка SMS через устройство

telegramSend — Отправка в Telegram
Отправка уведомлений через Telegram-бота

ussdDelete — Удаление USSD-ответа
Удаление ответа на USSD-запрос

ussdList — Список USSD-ответов
История ответов на USSD

ussdSend — Отправка USSD-запроса
Прямая отправка USSD

version — Версия API
Текущая версия интерфейса


Уведомления о событиях

Управление уведомлениями осуществляется через метод settingsSet.
Уведомления приходят в виде POST-запросов с данными в JSON-формате.

deviceState — Изменение статуса устройства
device_id, device_title, state (online/offline)

ussdReceived — Ответ на USSD-запрос
device_id, device_title, card_id, number, name, msg

smsReceived — Входящее SMS
time, device_id, device_title, card_id, number, name, sender, msg

smsSended — Отправка SMS
device_id, device_title, card_id, number, name, addressee, status (0/1/2)

callIncoming / callBegin / callEnd / callOutgoing — События вызова
time, device_id, device_title, card_id, number, name, incoming/outgoing

simStatus — Статус SIM-карты
device_id, device_title, card_id, number, name, state
(-3 — Выключена, -1 — Включается, 0 — Нет сети, 1 — Активна, ... и др.)


Полное описание каждого метода предоставляется после авторизации.