User handling

On this page you will find an example on how you can manage users in Ozeki NG SMS Gateway via HTTP API. Please note that this feature available in Ozeki NG - SMS Gateway v4.1.12 and above.

General user actions

Action name Description Parameters Example
createuser You can create a new user with this action type. type, name http://127.0.0.1:9501/api?action=createuser&username=admin& password=abc123&type=SMPP&name=username
deleteuser You can delete an existing user with this action type. name http://127.0.0.1:9501/api?action=deleteuser&username=admin& password=abc123&name=username
startuser You can start a user with this action type. name http://127.0.0.1:9501/api?action=startuser&username=admin& password=abc123&name=username
stopuser You can stop a user with this action type. name http://127.0.0.1:9501/api?action=stopuser&username=admin& password=abc123&name=username

User configuration

You can configure the users with the configuser action in Ozeki NG. Required parameter: name.

The users divided into two parts in Ozeki NG - SMS Gateway.

  • Fully configurable users :
    Standard, Database, File, Email, HTTP Client, HTTP Server, SMPP, Application starter, Autoreply, Autoreply easy, Colour SMS
  • Users with restricted configurability :
    ASP, Autoreply Database, Forwarder, FTP, Outlook Mobile Service, RSS, PDF, WCF, Voting

Standard user

These are the configurable parameters and their default values

ACCOUNTING on
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE on
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE on
LASTLOGIN 2011.09.01. 13:59:36
LOGCOMMUNICATION on
LOGDIRECTORYC:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT4
LOGLINESBEFORECHECKSIZE20
LOGMAXFILESIZE2000
LOGMESSAGES on
PASSWORD_ENC_VjVkuhNaT1w=
PHONENUMBER
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\admin\Addressbook
TYPE** Standard
USERNAME admin
Example: http://127.0.0.1:9501/api?action=configuser &username=admin&password=abc123&name=username&IDOVERRIDE=off

** = you can only use this parameter in the createuser action (only).

Database user

These are the configurable parameters and their default values

ACCOUNTINGoff
ADDRESSBOOKTYPEFile Addressbook
ALLOWROUTEOVERRIDEoff
ALLOWUNICODETEMPLATESoff
AUTOCONNECTon
CONNECTIONRECEIVINGon
CONNECTIONSENDINGon
DATABASECONNECTIONSTRINGProvider=SQLNCLI;Server=YourServer; Database=YourDatabase;UID=YourUsername;PWD=YourPassword;
DATABASEPROVIDERTYPESQLServer
GUIACCESS on
IDOVERRIDEoff
LOGCOMMUNICATIONoff
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE20
LOGMAXFILESIZE 8000
LOGMESSAGES on
LOGSELECTSoff
LOGUPDATES off
MAXQUEUESIZE 2000
PASSWORD_ENC_kzsoj3/WucoRch3cEisbfQ==
PHONENUMBERdbuser
POLLINTERVAL10
SQLCOMMANDTIMEOUT60
SQLDATETIMEFORMATyyyy-MM-dd HH:mm:ss
SQLINSERTRECEIVEDSTRINGINSERT INTO ozekimessagein (sender, receiver, msg, senttime, receivedtime, msgtype, operator) VALUES ('$originator','$recipient','$messagedata', '$senttime','$receivedtime','$messagetype','$operatornames')
SQLPOLLMESSAGENUM10
SQLSELECTSENDSTRINGSELECT id,sender,receiver,msg,msgtype,operator FROM ozekimessageout WHERE status='send'
SQLUPDATEDELIVEREDSTRINGUPDATE ozekimessageout SET status='delivered' WHERE id='$id'
SQLUPDATENOTSENTSTRINGUPDATE ozekimessageout SET status='notsent' WHERE id='$id'
SQLUPDATESENDINGSTRINGUPDATE ozekimessageout SET status='sending' WHERE id='$id'
SQLUPDATESENTSTRINGUPDATE ozekimessageout SET status='sent', senttime='$senttime' WHERE id='$id'
SQLUPDATEUNDELIVEREDSTRINGUPDATE ozekimessageout SET status='undelivered' WHERE id='$id'
SQLVALUEREPLACEFROM1'
SQLVALUEREPLACEFROM2"
SQLVALUEREPLACETO1''
SQLVALUEREPLACETO2""
TBPATHC:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\dbuser\Addressbook
TYPE**SQL
USEDAILYSQLoff
USERNAMEdbuser

** = you can only use this parameter in the createuser action (only).

File user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
CHARACTERSET Default
DIRDELIVEREDC:\smsTemp\smsdelivered
DIRINBOXC:\smsTemp\smsin
DIRNOTSENT C:\smsTemp\smsfailed
DIROUTBOX C:\smsTemp\smsout
DIRSENTC:\smsTemp\smssent
FILEFORMATXML
GUIACCESSon
IDOVERRIDEoff
LOGCOMMUNICATION off
LOGDIRECTORYC:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_De0Mze9cXlYRch3cEisbfQ==
PHONENUMBER file
POLLINTERVAL 10
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\file\Addressbook
TYPE**File
USERNAMEfile

** = you can only use this parameter in the createuser action (only).

E-mail user

These are the configurable parameters and their default values

ACCOUNTINGoff
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
DELFILTEREDONLYoff
DELIVERYERRORoff
DELIVERYTOHANDSEToff
DELIVERYTONETWORKoff
GUIACCESSon
IDOVERRIDEoff
INCLUDEPHONEINSENDERoff
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGINCOMINGoff
LOGLINESBEFORECHECKSIZE20
LOGMAXFILESIZE 8000
LOGMESSAGES on
LOGOUTGOINGoff
PASSWORD_ENC_1/24J0aNTwoRch3cEisbfQ==
PASSWORDPOP3 password
PASSWORDSMTPpassword
PHONENUMBERemail
POLLINTERVAL 10
POP3DELETEEMAIL on
POP3FROMADDR
POP3FROMNUMBER+36201234565
POP3KEYWORDS
POP3MAXMESSAGELENGTH160
POP3NUMBERINSUBJECToff
POP3PORT110
POP3SENDERADDRESSINSMSoff
POP3SERVERNAME192.168.91.51
POP3SSL off
POP3TOADDR
POP3TONUMBER +36201234567
POP3USERNAME username
SMTPAUTHoff
SMTPFROMADDRESS info@ozeki.hu
SMTPISADDRESSINSMSoff
SMTPSERVERNAMEmail.server.com
SMTPSERVERPORT25
SMTPSERVERUSERNAMEusername
SMTPSSLoff
SMTPTOADDRESSnoreply@ozeki.hu
SMTPTOADDRESSCC
SUBJECTENCODINGNone
SUBJECTLENGTH 32
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\email\Addressbook
TYPE**Email
USEEMAILTOSMS off
USENUMBERINEMAILTOoff
USERNAME email
USESMSTOEMAILoff

** = you can only use this parameter in the createuser action (only).

HTTP client user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
HTTPAUTHORIZATIONMETHOD
HTTPAUTHORIZATIONPASSWORD
HTTPAUTHORIZATIONUSER
HTTPREQUESTTIMEOUT 10
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION on
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_0Ho6YnsfFwMRch3cEisbfQ==
PHONENUMBER httpcl
POLLINTERVAL 10
POLLURL http://127.0.0.1/sms/outgoing.php
POSTDATACONTENTTYPE application/x-www-form-urlencoded
POSTDATATEMPLATEFILEBINARYMESSAGES
POSTDATATEMPLATEFILETEXTMESSAGES
PROXY
PROXYPASSWORD
PROXYPORT 8080
PROXYUSER
REPORTURLERROR http://127.0.0.1/sms/outgoingstat.php?state=deliveryerror &errormessage=$errormessage&sender=$originator&receiver=$recipient&msgdata= $messagedata&recvtime=$receivedtime&msgid=$messageid
REPORTURLHANDSET http://127.0.0.1/sms/outgoingstat.php?state=deliveredtohandset &sender=$originator&receiver=$recipient&msgdata=$messagedata&recvtime= $receivedtime&msgid=$messageid
REPORTURLNETWORK http://127.0.0.1/sms/outgoingstat.php?state=deliveredtonetwork &sender=$originator&receiver=$recipient&msgdata=$messagedata&recvtime= $receivedtime12&senttime=$senttime12&msgid=$messageid
REQUESTMETHOD Post
TARGETURL http://192.168.91.169:8877/sms/incoming.php?sender=$originator &receiver=$recipient&msgdata=$messagedata&recvtime=$receivedtime12 &senttime=$senttime12
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\httpcl\Addressbook
TYPE** HTTPClient
USEINCOMING on
USEOUTGOINGSTATUS off
USEPOLLING off
USERAGENT OzekiNG/1.0 (+http://www.ozekisms.com)
USERNAME httpcl

** = you can only use this parameter in the createuser action (only).

HTTP server user

These are the configurable parameters and their default values

ACCOUNTING on
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION on
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_VjVkuhNaT1w=
PHONENUMBER http
tbPath C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\http\Addressbook
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\http\Addressbook
TYPE** HTTPServer
USERNAME http

** = you can only use this parameter in the createuser action (only).

SMPP user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
DELIVERYREPORTACTION deliveredtohandset
GUIACCESS on
IDOVERRIDE off
LASTLOGIN 2011.08.31. 7:06:05
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
MESSAGEIDFORMAT Hexadecimal
PASSWORD _ENC_5g1cUar+T20=
PHONENUMBER smpp
SMSCCHARSET GSM 7 bit
tbPath C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\smpp\Addressbook
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\smpp\Addressbook
TYPE** SMPP
USERNAME smpp

** = you can only use this parameter in the createuser action (only).

Application Starter user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
EXECUTECOMMAND C:\process.bat "$SENDER" "$MSG"
GUIACCESS on
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_lzXKmWPJChoRch3cEisbfQ==
PHONENUMBER appstarter
PROCESSRESPONSE on
tbPath C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\appstarter\Addressbook
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\appstarter\Addressbook
TYPE** Appstarter
USERNAME appstarter

** = you can only use this parameter in the createuser action (only).

Autoreply user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_Nz/Qqup9Q64Rch3cEisbfQ==
PHONENUMBER AutoReply
REPLYSCRIPT autoreply_AutoReply.txt
RESPONSELIMIT 10
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\AutoReply\Addressbook
TYPE** AutoReply
USERNAME AutoReply

** = you can only use this parameter in the createuser action (only).

Autoreply easy user

These are the configurable parameters and their default values

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
AUTOREPLYTYPE SMS:TEXT
GUIACCESS on
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_M6vT3+296SQRch3cEisbfQ==
PHONENUMBER AutoReplyEasy
REPLYSCRIPT autoreply_AutoReplyEasy.txt
REPLYSCRIPTFILE This is the reply message.
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\AutoReplyEasy\Addressbook
TYPE** AutoReplyEasy
USERNAME AutoReplyEasy

** = you can only use this parameter in the createuser action (only).

Colour SMS user

These are the configurable parameters and their default values

ACCOUNTING
off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
HTTPAUTHORIZATIONMETHOD
HTTPAUTHORIZATIONPASSWORD
HTTPAUTHORIZATIONUSER
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_DzINAClbKLURch3cEisbfQ==
PHONENUMBER Colour_SMS
POSTDATACONTENTTYPE application/x-www-form-urlencoded
POSTDATATEMPLATEFILEBINARYMESSAGES
POSTDATATEMPLATEFILETEXTMESSAGES
PROXY
PROXYPASSWORD
PROXYPORT 8080
PROXYUSER
REQUESTMETHOD Get
TARGETURL http://www.yoursite.com/coloursms.php?sessionid= $messageid&srcaddr=$sender&destaddr= $receiver&serviceid=sms&data=$messagedata
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\Colour_SMS\Addressbook
TYPE** ColourSMS
USERAGENT OzekiNG/1.0 (+http://www.ozekisms.com)
USERNAME Colour_SMS

** = you can only use this parameter in the createuser action (only).

Users with restricted configuration

Users:
ASP, Autoreply Database, Forwarder, FTP, Outlook Mobile Service, RSS, PDF, WCF, Voting

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LASTLOGIN
LOGCOMMUNICATION off
LOGDIRECTORY C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
LOGMESSAGES on
PASSWORD _ENC_UD9IBjOvbUQRch3cEisbfQ==
PHONENUMBER rss
TBPATH C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\rss\Addressbook
USERNAME rss

More information