Descripción de la API de SimFolder

API can work in one-way or two-way modes:

In one-way synchronous mode, the User's Computer sends GET or POST requests to https://simfolder.com/api/ and receives a response from the SimFolder Server in JSON format.

In two-way asynchronous mode, the User's Server also sends requests to the SimFolder Server, and SimFolder in turn notifies the User's Server about events, listed in notification settings. Notifications are sent to the specified URL as POST requests.

A mandatory attribute of the request to the SimFolder Server is api_key, which can be obtained and, if necessary, changed in the User Profile section.

Métodos de la API

atList — Respuestas del módem

Recuperación de respuestas del módem de la Base de Datos

atSend — Enviando un comando AT

Envío directo de un comando AT al módem seleccionado

callAnswer — Respondiendo a una llamada entrante

Enviando un comando para responder a una llamada entrante

callBegin — Llamar

Realizando una llamada saliente

callDelete — Eliminación de una llamada entrante

Eliminación de un registro de una llamada entrante de la Base de Datos del sistema

callEnd — Colgar

Finalización de una llamada saliente

callList — Lista de llamadas entrantes

Recuperación de llamadas entrantes de la Base de Datos

callOutgoingDelete — Eliminación de una llamada saliente

Eliminación de un registro de una llamada saliente de la Base de Datos del sistema

callOutgoingList — Lista de llamadas salientes

Recuperación de llamadas salientes de la Base de Datos

cardDirect — Selección de tarjetas para interacción directa

Conexión de tarjetas para recibir llamadas entrantes en Agregadores con un límite en el número de módems consultados simultáneamente

cardEdit — Edición de datos de la tarjeta SIM

Modificación de uno o más campos de un registro de tarjeta SIM en la Base de Datos del sistema

cardList — Lista de tarjetas SIM

Obtención de información detallada sobre tarjetas SIM

cardSelect — Selección de tarjetas activas

Conexión de tarjetas a módems para operación en modo en línea (para agregadores con bancos de SIM)

deviceEdit — Edición de datos del agregador

Modificación de uno o más campos de un registro de agregador en la Base de Datos del sistema

deviceList — Lista de agregadores

Obtención de información detallada sobre los agregadores

deviceState — Estado del agregador

Devuelve los estados de cada módem del dispositivo

operatorEdit — Edición de datos del agregador móvil

Modificación de uno o más campos de un registro de operador móvil en la Base de Datos del sistema

operatorList — Lista de operadores móviles

Recuperación de operadores móviles de la Base de Datos

settingsGet — Recuperación de configuraciones de notificaciones

Solicitando la configuración actual del sistema de notificaciones para eventos

settingsSet — Configuración de las opciones de notificación

Configuración de las configuraciones actuales del sistema de notificaciones para eventos

smsDelete — Eliminación de SMS entrantes

Eliminando SMS entrantes de la base de datos del sistema

smsList — Lista de SMS entrantes

Recuperación de SMS entrantes de la Base de Datos

smsOutgoingDelete — Eliminando SMS salientes

Eliminando SMS salientes de la base de datos del sistema

smsOutgoingList — Recuperación de SMS salientes

Recuperación de SMS salientes de la Base de Datos

smsSend — Enviando SMS

Envío directo de SMS a través del agregador

telegramSend — Envío de mensaje a Telegram

Envío de un mensaje a uno mismo a través del bot de Telegram del sistema

ussdDelete — Eliminación de la respuesta USSD

Eliminación de la respuesta USSD recibida de la base de datos del sistema

ussdList — Lista de respuestas USSD

Obtención de respuestas USSD desde la Base de Datos

ussdSend — Envío de solicitud USSD

Envío directo de USSD a través del agregador

version — Versión del API

Versión actual de este API

Notificaciones de eventos

You can enable/disable the desired notification using the settingsSet method.
Notifications are received in POST requests, in JSON.

deviceState — Device State Changed

enabled by settings: online/offline
Return values: device_id, device_title, state (online/offline)

ussdReceived — USSD Request Response Received

Return values: device_id, device_title, card_id, number, name, msg (message)

smsReceived — Incoming SMS Received

Return values: time, device_id, device_title, card_id, number, name, sender, msg (message)

smsSended — Outgoing SMS Sent

Return values: device_id, device_title, card_id, number, name, addressee, status (0-sending error/1-sent successfully/2-sent and delivered)

callIncoming — Incoming Call Received

Return values: time, device_id, device_title, card_id, number, name, incoming

callBegin — Incoming Call Answered

Return values: time, device_id, device_title, card_id, number, name, incoming

callEnd — Incoming Call Ended

Return values: time, device_id, device_title, card_id, number, name, incoming

callOutgoing — Outgoing Call Started

Return values: time, device_id, device_title, card_id, number, name, outgoing

simStatus — SIM Card Status Changed

Return values: device_id, device_title, card_id, number, name, state (-3-Turned off/-1-Turning on/0-No network registration/1-Active/2-Registering in network/3-Blocked/4-Registration error/5-Roaming/6-Card absent)