API list

Base URL
http://host:8080/api/v1/

Example, in PowerShell, to set Regex (must be URL encoded) for Belgian mobile phone number ^(\+32|0032|0)4[5-9]\d{7}$
curl -i "http://host:8080/api/v1/setprm?RegexValid=%5E%28%5C%2B32%7C0032%7C0%294%5B5-9%5D%5Cd%7B7%7D%24" --digest --user admin:admin

GET

start: start sending SMS

stop: stop sending SMS

status: get memory / battery / uptime status in JSON format

sendsms: send a SMS

num: phone number
msg: message
idext: external id (optional)
prio: priority (optional, 1-3, default: 2)
exp: expiration (optional, yyyy-MM-ddTHH:mm:ss)
gsmid: id of SIM card (optional, 0-1, default: 0)
Returns id of SMS (code 200 if valid number or 422 if rejected number)

getsmsstatus: get status of a SMS

id: id of SMS
OR idext: external id returns last SMS found
Returns status of SMS

getsmsout: get list of outgoing SMS (only SMS sent by the server)

id: id of SMS
OR idext: external id
OR dtefrom: from (optional, yyyy-MM-ddTHH:mm:ss, default: 1 day ago)
dteto: to (optional, yyyy-MM-ddTHH:mm:ss, default: now)
gsmid: id of SIM card (optional, 0-1, default: all)
Returns list of SMS in JSON format

You can also use the Chrome extension 'JSON -> TABLE'.

getsmsin: get list of incoming SMS (only SMS received when the server is running)

dtefrom: from (optional, yyyy-MM-ddTHH:mm:ss, default: 1 day ago)
dteto: to (optional, yyyy-MM-ddTHH:mm:ss, default: now)
gsmid: id of SIM card (optional, 0-1, default: all)
Returns list of SMS in JSON format

You can also use the Chrome extension 'JSON -> TABLE'.

senddummy: send virtual SMS to test loop process

gsmid: id of SIM card (optional, 0-1, default: 0))
Returns id of SMS

abort: abort all SMS waiting to be sent

gsmid: id of SIM card (optional, 0-1, default: 0))

setprm: set parameters (one or several)

MinMsWaitAfterSend: min. ms to wait after sending a SMS
MaxMsWaitAfterSend: max. ms to wait after sending a SMS
SentIntentMsTimeout: timeout in ms to wait for sent status
DelSmsinOlderThanXDays: delete SMS in older than x days
DelSmsoutOlderThanXDays: delete SMS out older than x days
AutoStartOnBoot: true or false
AutoRestart: true or false, tries to restart if closed by Android
RegexValid: regex to validate or reject phone number

validatenumber: validate or reject phone number

num: phone number
Returns code 200 if valid number or 422 if rejected number

setpwd: change password

pwd: new password
The user is always 'admin'.
The initial password is 'admin'. The new password must have at least 5 chars.
The change will be active on next server restart.
For security reason, it is preferred to call this API locally on the phone.

POST

importcsv: import csv file

gsmid: id of SIM card (optional, 0-1; default: unset, use all SIM cards)

UTF8 CSV file with 2 columns (number, messages), separated by a tabulation, without header line.