- Product Manual
- Introduction
- PDF Generation
- Installation Guide
- User Guide
- Developers Guide
- Tutorials
- ASP SMS API
- PHP SMS API
- HTTP SMS API
- Send message
- Receive message
- Billing methods
- Urlencode
- Select operator
- Operate with single message
- Query the addressbook
- Operations with message folders
- Examples
- User handling
- Service Provider Connection Handling
- Reporting API
- Dynamic SMPP parameters
- SQL SMS API
- C# SMS API
- AJAX SMS API
- Delphi SMS API
- Cpp SMS API
- Java SMS API
- VB.NET SMS API
- Python SMS API
- Perl SMS API
- TCL/TK SMS API
- Coldfusion SMS API
- VB 6 SMS API
- Examples and Solutions
- Appendix
- SMS FAQ
- Feature list
- Commercial Information
- Search
RECOMMENDED FOR YOU:
SMS Gateway software
Ozeki brings you outstanding
SMS Gateway technology. Use our SMS Server products on Windows,Linux, or Android
C# SMS API
Developers can use our C# SMS API to send SMS from C#.Net. The C# SMS API comes with full source code
PHP SMS API
The ozeki PHP SMS gateway software can be used to send SMS from PHP and to receive SMS usig PHP on your website
SMPP SMS Gateway
SMS service providers use our SMPP gateway solution, that offers a high performance SMPP server and SMPP client gateway with amazing routing capabilities
Ozeki brings you outstanding
SMS Gateway technology. Use our SMS Server products on Windows,Linux, or Android
C# SMS API
Developers can use our C# SMS API to send SMS from C#.Net. The C# SMS API comes with full source code
PHP SMS API
The ozeki PHP SMS gateway software can be used to send SMS from PHP and to receive SMS usig PHP on your website
SMPP SMS Gateway
SMS service providers use our SMPP gateway solution, that offers a high performance SMPP server and SMPP client gateway with amazing routing capabilities
Ozeki NG SMS Gateway
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 |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 2000 |
| LOGMESSAGES | on |
| PASSWORD | _ENC_VjVkuhNaT1w= |
| PHONENUMBER | |
| TBPATH | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\admin\Addressbook |
| TYPE** | Standard |
| USERNAME | admin |
** = you can only use this parameter in the createuser action (only).
Database user
These are the configurable parameters and their default values
| ACCOUNTING | off |
| ADDRESSBOOKTYPE | File Addressbook |
| ALLOWROUTEOVERRIDE | off |
| ALLOWUNICODETEMPLATES | off |
| AUTOCONNECT | on |
| CONNECTIONRECEIVING | on |
| CONNECTIONSENDING | on |
| DATABASECONNECTIONSTRING | Provider=SQLNCLI;Server=YourServer; Database=YourDatabase;UID=YourUsername;PWD=YourPassword; |
| DATABASEPROVIDERTYPE | SQLServer |
| GUIACCESS | on |
| IDOVERRIDE | off |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| LOGSELECTS | off |
| LOGUPDATES | off |
| MAXQUEUESIZE | 2000 |
| PASSWORD | _ENC_kzsoj3/WucoRch3cEisbfQ== |
| PHONENUMBER | dbuser |
| POLLINTERVAL | 10 |
| SQLCOMMANDTIMEOUT | 60 |
| SQLDATETIMEFORMAT | yyyy-MM-dd HH:mm:ss |
| SQLINSERTRECEIVEDSTRING | INSERT INTO ozekimessagein (sender, receiver, msg, senttime, receivedtime, msgtype, operator) VALUES ('$originator','$recipient','$messagedata', '$senttime','$receivedtime','$messagetype','$operatornames') |
| SQLPOLLMESSAGENUM | 10 |
| SQLSELECTSENDSTRING | SELECT id,sender,receiver,msg,msgtype,operator FROM ozekimessageout WHERE status='send' |
| SQLUPDATEDELIVEREDSTRING | UPDATE ozekimessageout SET status='delivered' WHERE id='$id' |
| SQLUPDATENOTSENTSTRING | UPDATE ozekimessageout SET status='notsent' WHERE id='$id' |
| SQLUPDATESENDINGSTRING | UPDATE ozekimessageout SET status='sending' WHERE id='$id' |
| SQLUPDATESENTSTRING | UPDATE ozekimessageout SET status='sent', senttime='$senttime' WHERE id='$id' |
| SQLUPDATEUNDELIVEREDSTRING | UPDATE ozekimessageout SET status='undelivered' WHERE id='$id' |
| SQLVALUEREPLACEFROM1 | ' |
| SQLVALUEREPLACEFROM2 | " |
| SQLVALUEREPLACETO1 | '' |
| SQLVALUEREPLACETO2 | "" |
| TBPATH | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\dbuser\Addressbook |
| TYPE** | SQL |
| USEDAILYSQL | off |
| USERNAME | dbuser |
** = 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 |
| DIRDELIVERED | C:\smsTemp\smsdelivered |
| DIRINBOX | C:\smsTemp\smsin |
| DIRNOTSENT | C:\smsTemp\smsfailed |
| DIROUTBOX | C:\smsTemp\smsout |
| DIRSENT | C:\smsTemp\smssent |
| FILEFORMAT | XML |
| GUIACCESS | on |
| IDOVERRIDE | off |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| 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 |
| USERNAME | file |
** = you can only use this parameter in the createuser action (only).
E-mail user
These are the configurable parameters and their default values
| ACCOUNTING | off |
| ADDRESSBOOKTYPE | File Addressbook |
| ALLOWROUTEOVERRIDE | off |
| AUTOCONNECT | on |
| DELFILTEREDONLY | off |
| DELIVERYERROR | off |
| DELIVERYTOHANDSET | off |
| DELIVERYTONETWORK | off |
| GUIACCESS | on |
| IDOVERRIDE | off |
| INCLUDEPHONEINSENDER | off |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGINCOMING | off |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| LOGOUTGOING | off |
| PASSWORD | _ENC_1/24J0aNTwoRch3cEisbfQ== |
| PASSWORDPOP3 | password |
| PASSWORDSMTP | password |
| PHONENUMBER | |
| POLLINTERVAL | 10 |
| POP3DELETEEMAIL | on |
| POP3FROMADDR | |
| POP3FROMNUMBER | +36201234565 |
| POP3KEYWORDS | |
| POP3MAXMESSAGELENGTH | 160 |
| POP3NUMBERINSUBJECT | off |
| POP3PORT | 110 |
| POP3SENDERADDRESSINSMS | off |
| POP3SERVERNAME | 192.168.91.51 |
| POP3SSL | off |
| POP3TOADDR | |
| POP3TONUMBER | +36201234567 |
| POP3USERNAME | username |
| SMTPAUTH | off |
| SMTPFROMADDRESS | info@ozeki.hu |
| SMTPISADDRESSINSMS | off |
| SMTPSERVERNAME | mail.server.com |
| SMTPSERVERPORT | 25 |
| SMTPSERVERUSERNAME | username |
| SMTPSSL | off |
| SMTPTOADDRESS | noreply@ozeki.hu |
| SMTPTOADDRESSCC | |
| SUBJECTENCODING | None |
| SUBJECTLENGTH | 32 |
| TBPATH | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Users\email\Addressbook |
| TYPE** | |
| USEEMAILTOSMS | off |
| USENUMBERINEMAILTO | off |
| USERNAME | |
| USESMSTOEMAIL | off |
** = 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
| 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
- HTTP SMS API - Overview
- HTTP SMS API - sendmessage method
- HTTP SMS API - receivemessage method
- HTTP SMS API - billing method
- HTTP SMS API - SMS service provider connection selection
- HTTP SMS API - Operate with single message
- How to query the addressbook in Ozeki NG SMS Gateway
- Operations with message folders in HTTP SMS API
- HTTP SMS API Examples
- User handling via HTTP API
- Service provider connection handling via HTTP API
- HTTP API for the Reporting function of Ozeki NG SMS Gateway
- Dynamic SMPP parameters via HTTP
- FAQ of the Ozeki NG SMS Gateway
Copyright © 2000- |
Ozeki Ltd | info@ozeki.hu |