SimFolder API 说明

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 方法


atList — 调制解调器响应
从数据库获取调制解调器响应

atSend — 发送AT命令
直接向选定的调制解调器发送AT命令

callAnswer — 应答来电
发送命令以接听来电

callBegin — 打电话
拨打去电

callDelete — 删除来电
从系统数据库中删除来电记录

callEnd — 挂断
结束去电

callList — 来电列表
从数据库中检索来电

callOutgoingDelete — 删除去电
从系统数据库中删除去电记录

callOutgoingList — 去电列表
从数据库获取去电

cardDirect — 选择卡进行直接交互
连接卡以在具有同时轮询调制解调器数量限制的聚合器上接收来电

cardEdit — 编辑SIM卡数据
修改系统数据库中SIM卡记录的一个或多个字段

cardList — SIM卡列表
获取SIM卡的详细信息

cardSelect — 选择活跃卡片
将卡连接到调制解调器以进行在线模式操作(适用于带有SIM银行的聚合器)

deviceEdit — 编辑聚合器数据
修改系统数据库中聚合器记录的一个或多个字段

deviceList — 聚合器列表
获取有关聚合器的详细信息

deviceState — 聚合器状态
返回设备每个调制解调器的状态

operatorEdit — 编辑移动聚合器数据
修改系统数据库中移动运营商记录的一个或多个字段

operatorList — 移动运营商列表
从数据库中检索移动运营商

settingsGet — 获取通知设置
请求当前系统事件通知设置

settingsSet — 设置通知设置
设置当前系统事件通知设置

smsDelete — 删除收件短信
从系统数据库中删除收件短信

smsList — 来信短信列表
从数据库中检索来电短信

smsOutgoingDelete — 删除已发短信
从系统数据库中删除已发短信

smsOutgoingList — 检索发出的短信
从数据库中检索发出的短信

smsSend — 发送短信
通过聚合器直接发送短信

telegramSend — 发送消息到Telegram
通过系统的Telegram机器人向自己发送消息

ussdDelete — 删除USSD响应
从系统数据库中删除收到的USSD响应

ussdList — USSD响应列表
从数据库中检索USSD响应

ussdSend — USSD请求发送
通过聚合器直接发送USSD

version — API版本
该API的当前版本


事件通知

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)