API может работать в одностороннем или двухстороннем режимах:

В одностороннем синхронном режиме Компьютер Пользователя обращается с GET либо POST запросами по адресу https://simfolder.com/api/ и получает от Сервера SimFolder ответ в формате JSON.

В двухстроненнем асинхронном режиме Сервер Пользователя также обращается с запросами к Серверу SimFolder, а SimFolder в свою очередь уведомляет Сервер Пользователя о наступлениии событий, перечисленных в настроках уведомлений. Уведомления поступают на указанный URL в формате POST-запроса.

Обязательным атрибутом запроса к Серверу SimFolder является api_key, который можно получить, а при необходимости поменять в разделе Профиль пользователя.

Методы API

atList — Ответы модема

Получение ответов модема из Базы Данных системы

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

Прямое отправление AT-команды на выбранный модем

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

Отправление команды для ответа на входящий вызов

callBegin — Позвонить

Совершение исходящего вызова

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

Удаление записи о входящем вызове из Базы Данных системы

callEnd — Положить трубку

Завершение исходящего вызова

callList — Список входящих вызовов

Получение входящих вызовов из Базы Данных

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

Удаление записи об исходящем вызове из Базы Данных системы

callOutgoingList — Список исходящих вызовов

Получение исходящих вызовов из Базы Данных

cardDirect — Выбор карт для прямого взаимодействия

Подключение карт для приема входящих вызовов на Агрегаторах с ограничением количества одновременно опрашиваемых модемов

cardEdit — Редактирование данных СИМ-карты

Изменение одного или нескольких полей записи о СИМ-карте в Базе Данных системы

cardList — Список СИМ-карт

Получение детальной информации о СИМ-картах

cardSelect — Выбор активных карт

Подключение карт к модемам для работы в режиме онлайн (для агрегаторов с СИМ-банками)

deviceEdit — Редактирование данных агрегатора

Изменение одного или нескольких полей записи об агрегаторе в Базе Данных системы

deviceList — Список агрегаторов

Получение детальной информации об агрегаторах

deviceState — Статус агрегатора

Возвращает статусы каждого модема устройства

operatorEdit — Редактирование данных мобильного агрегатора

Изменение одного или нескольких полей записи о мобильном операторе в Базе Данных системы

operatorList — Список мобильных операторов

Получение мобильных операторов из Базы Данных

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

Запрос текущих системных настроек уведомлений о событиях

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

Установка текущих системных настроек уведомлений о событиях

smsDelete — Удаление входящего SMS

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

smsList — Список входящих СМС

Получение входящих СМС из Базы Данных

smsOutgoingDelete — Удаление исходящего SMS

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

smsOutgoingList — Получение исходящих СМС

Получение исходящих СМС из Базы Данных

smsSend — Отправка SMS

Прямая отправка SMS через агрегатор

telegramSend — Отправка сообщения в Телеграм

Отправка сообщения себе через Telegram-бота системы

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

Удаление полученного ответа на USSD-запрос из базы данных системы

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

Получение ответов на USSD-запросы из базы данных

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

Прямая отправка USSD через агрегатор

version — Версия API

Текущая версия этого API

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

Включить/Выключить нужное уведомление можно методом settingsSet.

deviceState — Изменилось состояние устройства

включается настройками: online/offline
Возвращаемые значения: device_id, device_title, state (online/offline)

ussdReceived — Получен ответ на USSD-запрос

Возвращаемые значения: device_id, device_title, card_id, number, name, msg (сообщение)

smsReceived — Получено входящее СМС

Возвращаемые значения: time, device_id, device_title, card_id, number, name, sender, msg (сообщение)

smsSended — Отправлено исходящее СМС

Возвращаемые значения: device_id, device_title, card_id, number, name, addressee, status (0-ошибка при отправке/1-успешно отправлено/2-успешно отправлено и доставлено)

callIncoming — Поступил входящий вызов

Возвращаемые значения: time, device_id, device_title, card_id, number, name, incoming

callBegin — Прием входящего вызова

Возвращаемые значения: time, device_id, device_title, card_id, number, name, incoming

callEnd — Завершение входящего вызова

Возвращаемые значения: time, device_id, device_title, card_id, number, name, incoming

callOutgoing — Начат исходящий вызов

Возвращаемые значения: time, device_id, device_title, card_id, number, name, outgoing

simStatus — Изменился статус СИМ-карты

Возвращаемые значения: device_id, device_title, card_id, number, name, state (-3-Выключена/-1-Включается/0-Нет регистрации в сети/1-Активна/2-Идет регистрация в сети/3-Заблокирована/4-Ошибка регистрации/5-Роуминг/6-Карта отсутствует)