La API puede funcionar en modos unidireccional o bidireccional:

En el modo sincrónico unidireccional, la Computadora del Usuario realiza solicitudes GET o POST a la dirección https://simfolder.com/api/ y recibe una respuesta del Servidor SimFolder en formato JSON.

En el modo asincrónico bidireccional, el Servidor del Usuario también realiza solicitudes al Servidor SimFolder, y SimFolder a su vez notifica al Servidor del Usuario sobre la ocurrencia de eventos enumerados en la configuración de notificaciones. Las notificaciones se envían a la URL especificada en formato POST.

Un atributo obligatorio de la solicitud al Servidor SimFolder es api_key, que se puede obtener o cambiar en la sección Perfil de usuario.

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

Puede activar/desactivar la notificación necesaria utilizando el método settingsSet.

deviceState — Cambió el estado del dispositivo

configurable en: online/offline
Valores devueltos: device_id, device_title, state (online/offline)

ussdReceived — Se recibió una respuesta a la solicitud USSD

Valores devueltos: device_id, device_title, card_id, number, name, msg (mensaje)

smsReceived — Se recibió un SMS entrante

Valores devueltos: time, device_id, device_title, card_id, number, name, sender, msg (mensaje)

smsSended — Se envió un SMS saliente

Valores devueltos: device_id, device_title, card_id, number, name, addressee, status (0-error al enviar/1-enviado con éxito/2-enviado y entregado con éxito)

callIncoming — Se recibió una llamada entrante

Valores devueltos: time, device_id, device_title, card_id, number, name, incoming

callBegin — Recepción de llamada entrante

Valores devueltos: time, device_id, device_title, card_id, number, name, incoming

callEnd — Finalización de llamada entrante

Valores devueltos: time, device_id, device_title, card_id, number, name, incoming

callOutgoing — Comienzo de llamada saliente

Valores devueltos: time, device_id, device_title, card_id, number, name, outgoing

simStatus — Cambió el estado de la tarjeta SIM

Valores devueltos: device_id, device_title, card_id, number, name, state (-3-Apagada/-1-Encendiendo/0-Sin registro en la red/1-Activa/2-Registrando en la red/3-Bloqueada/4-Error de registro/5-Roaming/6-SIM no insertada)