SimFolder API documentation

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.

API methods

atList — Modem responses

Retrieving modem responses from the Database

atSend — Sending an AT command

Directly sending an AT command to the selected modem

callAnswer — Answering an incoming call

Sending a command to answer an incoming call

callBegin — Call

Making an outgoing call

callDelete — Deleting an incoming call

Deleting a record of an incoming call from the system's Database

callEnd — Hang up

Ending an outgoing call

callList — List of incoming calls

Retrieving incoming calls from the Database

callOutgoingDelete — Deleting an outgoing call

Deleting a record of an outgoing call from the system's Database

callOutgoingList — List of outgoing calls

Retrieving outgoing calls from the Database

cardDirect — Selecting cards for direct interaction

Connecting cards for receiving incoming calls on Aggregators with a limit on the number of modems polled simultaneously

cardEdit — Editing SIM card data

Modifying one or more fields of a SIM card record in the system's Database

cardList — List of SIM cards

Retrieving detailed information about SIM cards

cardSelect — Selecting active cards

Connecting cards to modems for online mode operation (for aggregators with SIM banks)

deviceEdit — Editing aggregator data

Modifying one or more fields of an aggregator record in the system's Database

deviceList — List of aggregators

Retrieving detailed information about aggregators

deviceState — Aggregator status

Returns the statuses of each modem of the device

operatorEdit — Editing mobile aggregator data

Modifying one or more fields of a mobile operator record in the system's Database

operatorList — List of mobile operators

Retrieving mobile operators from the Database

settingsGet — Retrieving notification settings

Requesting current system notification settings for events

settingsSet — Setting notification settings

Setting current system notification settings for events

smsDelete — Deleting incoming SMS

Deleting incoming SMS from the system database

smsList — List of incoming SMS

Retrieving incoming SMS from the Database

smsOutgoingDelete — Deleting outgoing SMS

Deleting outgoing SMS from the system database

smsOutgoingList — Retrieving outgoing SMS

Retrieving outgoing SMS from the Database

smsSend — Sending SMS

Direct SMS sending via aggregator

telegramSend — Sending message to Telegram

Sending a message to oneself via the system's Telegram bot

ussdDelete — Deleting the USSD response

Deleting the received USSD response from the system database

ussdList — List of USSD responses

Retrieving USSD responses from the Database

ussdSend — USSD request sending

Direct USSD sending via aggregator

version — API Version

Current version of this API

Event notifications

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)