Products
Ozeki 10
Apps
Chat
SMS Gateway
Quick Start Guide
SMS with Client Software
HTTP API
Get Started
HTTP API Tester
Send message
Receive message
Billing methods
URL encode
Select operator
Operate with single message
Query the addressbook
Operations with message folders
Examples
User handling
configuser
Service Provider Connection Handling
Reporting API
Dynamic SMPP parameters
SMS from/to Database
PHP SMS API
Solutions
C# SMS API
VB.NET SMS API
SQL Logging
System Database
Robot Controller
Softphone
PBX
Connections
Installation guide
Terms and Definitions
HTTP API
SMS
Bulk Messenger
Cluster
Developer tools
Robots
Hardware
Installer
Technology
Company


Ozeki 10 - SMS Gateway server software
User handling User handling | Service Provider Connection Handling Service Provider Connection Handling

HTTP API - User configuration

The 'configuser' action can set user parameters in Ozeki SMS Gateway by identifying the user by 'name', which is a mandatory parameter. You can configure several types of existing users. Each usertype is configured by using the 'configuser' action with different kind of parameters.

There are two user type groups in Ozeki SMS Gateway:

For more details, please read the user type documentation.

'Standard' user

A standard user is most likely a human being with the rights to use Ozeki SMS Gateway. Standard users are used for logging in on the user interface and to send or receive messages. You can configure any previously created standard user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123&
Name=Alice&PASSWORD=ExamplePassword&PHONENUMBER=0036203334444

HTTP response:

StatusCode: 200
XML: Ok

Parameters:

Parameter Description Possible values Example M/O*
name The name of the user which will be configured. URL encoded string name=Alice M
ACCOUNTING If enabled, a credit limit can be set for the user. The user will not be allowed to send more messages than the credit limit. on, off ACCOUNTING=off
(default value: on)
O
ADDRESSBOOKTYPE The type of the Addressbook. File, LDAP, SQL addressbook ADDRESSBOOKTYPE=LDAP
(default value: File)
O
ALLOWROUTEOVERRIDE Specifies if the routing table can be overriden, so the prefered service provider connection can be set for each message. on, off ALLOWROUTEOVERRIDE=off
(default value: on)
O
AUTOCONNECT Automatically enable user at every startup. on, off AUTOCONNECT=off
(default value: on)
O
GUIACCESS Specifies if the user gets webbrowser GUI access. on, off GUIACCESS=off
(default value: on)
O
IDOVERRIDE Specifies if the 'PHONENUMBER' can be overridden. on, off IDOVERRIDE=off
(default value: on)
O
LOGCOMMUNICATION Log low level communication of the user. on, off LOGCOMMUNICATION=off
(default value: on)
O
LOGMESSAGES Log sent and received messages of the user in human readable format. on, off LOGMESSAGES=off
(default value: on)
O
LOGDIRECTORY Directory of the user logs. URL encoded string LOGDIRECTORY=
C%3A%5CSMSGateway_Logs
(C:\SMSGateway_Logs)
(default value:
C:\...\Ozeki10\Data\NG\Logs )
O
LOGHISTORYCOUNT The maximum number of log files. These files will be rotated. numbers LOGHISTORYCOUNT=5
(default value: 4)
O
LOGLINESBEFORECHECKSIZE Specify the number of new lines before rechecking the size of the log file in kB. numbers LOGLINESBEFORECHECKSIZE=5
(default value: 20)
O
LOGMAXFILESIZE If the checked size of the log file gets bigger, the log will continue in a new file, while the old one gets zipped. The file size is in kB. numbers LOGMAXFILESIZE=100
(default value: 2000)
O
PASSWORD Sets the password of the user. URL encoded string PASSWORD=
ExamplePassword
(no default value)
O
PHONENUMBER Sets the phone number of the user. URL encoded string value in any phone number format PHONENUMBER=
0036203334444
(no default value)
O
TBPATH Directory of the user addressbooks. URL encoded string TBPATH=
C%3A%5CSMSGateway_Addressbook
(C:\SMSGateway_Addressbook)
(default value: C:\...\Ozeki10\Data\NG\
Users\admin\Addressbook )
O

* M = Mandatory parameter, O = Optional parameter

'SQL' user

An SQL user can connect to any SQL database to send or receive messages. You can connect to the database with the 'DATABASECONNECTIONSTRING' parameter than you can select the messages to send with 'SQLSELECTSENDSTRING'. You can configure any previously created SQL user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&DATABASECONNECTIONSTRING=Provider%3dSQLNCLI%3bServer%3dYourServer%3b
+Database%3dYourDatabase%3bUID%3dYourUsername%3bPWD%3dYourPassword%3b
&SQLSELECTSENDSTRING=SELECT+id%2csender%2creceiver%2cmsg%2cmsgtype%2coperator
+FROM+ozekimessageout+WHERE+status%3d%27send%27
&name=SQLUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the SQL user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER dbuser
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
ALLOWUNICODETEMPLATES Enable this option if you wish to include special charactes in table names. on, off ALLOWUNICODETEMPLATES=on
(default value: off)
O
CONNECTIONRECEIVING Use this user connection for receiving messages. on, off CONNECTIONRECEIVING=off
(default value: on)
O
CONNECTIONSENDING Use this user connection for sending messages. on, off CONNECTIONSENDING=off
(default value: on)
O
DATABASECONNECTIONSTRING You can connect to your database by using this connection string. URL encoded string DATABASECONNECTIONSTRING= Provider=SQLNCLI;Server=YourServer; Database=YourDatabase;UID=YourUsername; PWD=YourPassword; O
DATABASEPROVIDERTYPE Selects the database type of this user. URL encoded string DATABASEPROVIDERTYPE=Oracle
(default value: SQLServer)
O
LOGSELECTS Log SQL SELECT statements. on, off LOGSELECTS=on
(default value: off)
O
LOGUPDATES Log SQL UPDATE statements. on, off LOGUPDATES=on
(default value: off)
O
POLLINTERVAL Specifies the polling interval in seconds for checking the SQL table for outgoing messages (default table: 'ozekimessageout'). numbers POLLINTERVAL=20
(default value: 10)
O
SQLCOMMANDTIMEOUT Specify the maximum time in seconds to wait for an SQL command to execute. numbers SQLCOMMANDTIMEOUT=100
(default value: 60)
O
SQLDATETIMEFORMAT Specify the date format used to create the date value for the SQL statements. date format SQLDATETIMEFORMAT=
yyyy.MM.dd HH:mm:ss
(default value: yyyy-MM-dd HH:mm:ss)
O
SQLINSERTRECEIVEDSTRING Inserts received messages to SQL table (default table: 'ozekimessagein'). URL encoded string SQLINSERTRECEIVEDSTRING=
INSERT INTO ozekimessagein (sender, receiver, msg, senttime, receivedtime, msgtype, operator)
VALUES ('$originator','$recipient','$messagedata', '$senttime', '$receivedtime', '$messagetype', '$operatornames')
O
SQLPOLLMESSAGENUM Maximum number of messages to send with one poll. numbers SQLPOLLMESSAGENUM=20
(default value: 10)
O
SQLSELECTSENDSTRING Selects the messages to send from the SQL table (default table: 'ozekimessageout'). URL encoded string SQLSELECTSENDSTRING=
SELECT id,sender,receiver,msg,msgtype,operator
FROM ozekimessageout
WHERE status='send'
O
SQLUPDATESENDINGSTRING Sets 'status' SQL attribute to 'sending'. URL encoded string SQLUPDATESENDINGSTRING=
UPDATE ozekimessageout
SET status='sending'
WHERE id='$id'
O
SQLUPDATESENTSTRING Sets 'status' SQL attribute to 'sent' and 'senttime' attribute to the time the message was sent. URL encoded string SQLUPDATESENTSTRING=
UPDATE ozekimessageout
SET status='sent', senttime='$senttime'
WHERE id='$id'
O
SQLUPDATENOTSENTSTRING Sets 'status' SQL attribute to 'notsent'. URL encoded string SQLUPDATENOTSENTSTRING=
UPDATE ozekimessageout
SET status='notsent'
WHERE id='$id
O
SQLUPDATEDELIVEREDSTRING Sets 'status' SQL attribute to 'delivered'. URL encoded string SQLUPDATEDELIVEREDSTRING=
UPDATE ozekimessageout
SET status='delivered'
WHERE id='$id'
O
SQLUPDATEUNDELIVEREDSTRING Sets 'status' SQL attribute to 'undelivered'. URL encoded string SQLUPDATEUNDELIVEREDSTRING=
UPDATE ozekimessageout
SET status='undelivered'
WHERE id='$id'
O
SQLVALUEREPLACEFROM1 Replaces this value in the INSERT INTO statement with SQLVALUEREPLACETO1 URL encoded string SQLVALUEREPLACEFROM1=%27
(%27 is ')
(default value: ')
O
SQLVALUEREPLACEFROM2 Replaces this value in the INSERT INTO statement with SQLVALUEREPLACETO2 URL encoded string SQLVALUEREPLACEFROM2=%22
(%22 is ")
(default value: ")
O
SQLVALUEREPLACETO1 Replaces SQLVALUEREPLACEFROM1 values in the INSERT INTO statement. URL encoded string SQLVALUEREPLACETO1=%22
(%22 is ")
(default value: '')
O
SQLVALUEREPLACETO2 Replaces SQLVALUEREPLACEFROM2 values in the INSERT INTO statement. URL encoded string SQLVALUEREPLACETO2=%27
(%27 is ')
(default value: "")
O

* M = Mandatory parameter, O = Optional parameter

'File' user

It can store sent or received messages in the following file formats: Simple, Text, Verbose, List, CSV, XML, SAP, ATF, KAL. You can configure any previously created File user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&FILEFORMAT=XML&name=FileUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the File user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER file
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
CHARACTERSET Character encoding. e.g.: utf-8, Default, None, ASMO-708, big5, cp1025, ... CHARACTERSET=utf-8
(default value: Default)
O
DIRINBOX Save incoming messages into this directory. URL encoded string DIRINBOX=C%3A%5CInbox
(C:\Inbox)
(default value: C:\smsTemp\smsin)
O
DIROUTBOX Outgoing directory searched for text files containing outgoing messages. URL encoded string DIROUTBOX=C%3A%5COutbox
(C:\Outbox)
(default value: C:\smsTemp\smsout)
O
DIRSENT Successfully sent messages will be saved into this directory. URL encoded string DIRSENT=C%3A%5CSent
(C:\Sent)
(default value: C:\smsTemp\smssent)
O
DIRNOTSENT Messages that have failed to be sent will be saved into this directory. URL encoded string DIRNOTSENT=C%3A%5CFailedToSend
(C:\FailedToSend)
(default value: C:\smsTemp\smsfailed)
O
DIRDELIVERED Delivered messages will be saved into this directory. URL encoded string DIRDELIVERED=C%3A%5CDelivered
(C:\Delivered)
(default value: C:\smsTemp\smsdelivered)
O
FILEFORMAT The file format. Simple, Text, Verbose, List, CSV, XML, SAP, ATF, KAL FILEFORMAT=Text
(default value: XML)
O

* M = Mandatory parameter, O = Optional parameter

'Email' user

This user can send SMS messages from the arrived Email content and also send Emails from any arrived SMS content. The Email to SMS functionality uses the POP3 protocol, while the SMS to Email function uses the SMTP protocol. You can configure any previously created Email user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&PASSWORDPOP3=POP3ExamplePassword&POP3SERVERNAME=mail.server.com&POP3PORT=110&POP3USERNAME=POP3Username
&SMTPFROMADDRESS=info%40corporation.com&SMTPSERVERNAME=smtp.gmail.com&SMTPSERVERPORT=465
&SUBJECTENCODING=None
&name=EmailUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the Email user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER email
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
DELFILTEREDONLY Only delete e-mails from the POP3 server that match the conditions. on, off DELFILTEREDONLY=on
(default value: off)
O
DELIVERYERROR Send e-mail to sender if SMS was not delivered because of an error. on, off DELIVERYERROR=on
(default value: off)
O
DELIVERYTOHANDSET Send e-mail to sender if SMS was delivered to handset. on, off DELIVERYTOHANDSET=on
(default value: off)
O
DELIVERYTONETWORK Send e-mail to sender if SMS was delivered to network. on, off DELIVERYTONETWORK=on
(default value: off)
O
LOGINCOMING Log incoming messages. on, off LOGINCOMING=on
(default value: off)
O
LOGOUTGOING Log outgoing messages. on, off LOGOUTGOING=on
(default value: off)
O
POP3DELETEEMAIL Delete downloaded e-mails from the POP3 server. on, off POP3DELETEEMAIL=on
(default value: off)
O
POP3FROMADDR Emails that sent from these addresses should be forwarded as SMS. Addresses must be separated with semicolons. URL encoded string POP3FROMADDR= address1%40domain.com%3B
address2%40domain.com%3B
(address1@domain.com; address2@domain.com;)
(no default value)
O
POP3KEYWORDS You can specify one or more keywords that should be included in the subject line(s) of email(s) to be forwarded via SMS. Keywords must be separated by semicolons. URL encoded string POP3KEYWORDS=bill%3B%20receipt%3B
(bill; receipt;)
(no default value)
O
POP3MAXMESSAGELENGTH The SMS generated from the POP3 server must not be longer than this value. number POP3MAXMESSAGELENGTH=240
(default value: 160)
O
POP3NUMBERINSUBJECT Specifies if phone numbers can be used in the e-mail's subject. on, off POP3NUMBERINSUBJECT=on
(default value: off)
O
POP3SENDERADDRESSINSMS Include the sender's e-mail address in the SMS. on, off POP3SENDERADDRESSINSMS=on
(default value: off)
O
POP3SERVERNAME POP3 server's IP adddress or domain name. URL encoded string POP3SERVERNAME
=192.168.91.51
(no default value)
O
POP3PORT POP3 server's port number. numbers POP3PORT
=110
(default value: 110)
O
POP3SSL Specifies if the POP3 server requires SSL connection. on, off POP3SSL=on
(default value: off)
O
POP3TOADDR Emails that have these destination addresses should be forwarded as SMS. Use semicolons to separate multiple addresses. URL encoded string POP3TOADDR
info%40corporation.com
(info@corporation.com)
(no default value)
O
POP3TONUMBER Send SMS to phone numbers (separated by semicolons). URL encoded string POP3TONUMBER
=+441632960941
(no default value)
O
POP3USERNAME The username for the POP3 account. URL encoded string POP3USERNAME
=POP3_UserName
(no default value)
O
PASSWORDPOP3 POP3 user's password. URL encoded string PASSWORDPOP3
=POP3_Password
(no default value)
O
SMTPAUTH Specifies if your SMTP server requires authentication. on, off SMTPAUTH=on
(default value: off)
O
SMTPFROMADDRESS The e-mail address of the sender. URL encoded string SMTPFROMADDRESS
=info%40corporation.com
(info@corporation.com)
(no default value)
O
SMTPISADDRESSINSMS Specifies if the e-mail address should be used in the SMS. on, off SMTPISADDRESSINSMS=on
(default value: off)
O
SMTPSERVERNAME SMTP server's IP adddress or domain name. URL encoded string SMTPSERVERNAME
=smtp.gmail.com
(default value: mail.server.com)
O
SMTPSERVERPORT SMTP server's port number. numbers SMTPSERVERPORT=465
(default value: 25)
O
SMTPSERVERUSERNAME A username for the SMTP server. In most cases it is not required. URL encoded string SMTPSERVERUSERNAME
=SMTP_UserName
(no default value)
O
PASSWORDSMTP SMTP user's password. In some cases it is not required. URL encoded string PASSWORDSMTP=SMTP_Password
(no default value)
O
SMTPSSL Specifies if the SMTP server requires SSL connection. on, off SMTPSSL=on
(default value: off)
O
SMTPTOADDRESS Recipient address of the e-mail. URL encoded string SMTPTOADDRESS
=info%40corporation.com
(info@corporation.com)
(no default value)
O
SMTPTOADDRESSCC CC email address(es). Multiple emails should be separated by semicolons. URL encoded string SMTPTOADDRESSCC
=info%40corporation2.com
(info@corporation2.com)
(no default value)
O
SUBJECTENCODING The character encoding of the subject line. e.g.: utf-8, Default, None, ASMO-708, big5, cp1025, ... SUBJECTENCODING=utf-8
(default value: Default)
O
SUBJECTLENGTH The maximum character length of the subject. numbers SUBJECTLENGTH=40
(default value: 32)
O
USEEMAILTOSMS Enable E-mail to SMS forwarding. on, off USEEMAILTOSMS=on
(default value: off)
O
USESMSTOEMAIL Enable SMS to E-mail forwarding. on, off USESMSTOEMAIL=on
(default value: off)
O
INCLUDEPHONEINSENDER Include phone number in the sender's address in phone_number@domain.com format. on, off INCLUDEPHONEINSENDER=on
(default value: off)
O
USENUMBERINEMAILTO Include phone number in the recipient's address in phone_number@domain.com format. on, off USENUMBERINEMAILTO=on
(default value: off)
O

* M = Mandatory parameter, O = Optional parameter

'HTTPClient' user

It can send HTTP requests after any delivered or received SMS. These HTTP requests can contain the message content. To see some example requests, you can scroll down. You can configure any previously created HTTP Client user with a simple 'configuser' action.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&REPORTURLNETWORK=http%3a%2f%2f127.0.0.1%2fsms%2foutgoingstat.php%3fstate%3ddeliveredtonetwork
%26sender%3d%24originator%26receiver%3d%24recipient%26msgdata%3d%24messagedata
%26recvtime%3d%24receivedtime%26msgid%3d%24messageid
&TARGETURL=http%3a%2f%2f127.0.0.1%2fsms%2fincoming.php%3fsender%3d%24originator
%26receiver%3d%24recipient%26msgdata%3d%24messagedata%26recvtime%3d%24receivedtime%26msgid%3d%24messageid
&name=HTTPClientUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the HTTP Client user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION on
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD _ENC_0Ho6YnsfFwMRch3cEisbfQ==
PHONENUMBER httpcl
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
HTTPAUTHORIZATIONMETHOD Authentication method. None, Basic, Digest HTTPAUTHORIZATIONMETHOD
=Basic
(default value: None)
O
HTTPAUTHORIZATIONUSER HTTP authentication username. URL encoded string HTTPAUTHORIZATIONUSER
=HTTPAuthUsername
(default value: None)
O
HTTPAUTHORIZATIONPASSWORD HTTP authorization password. URL encoded string HTTPAUTHORIZATIONPASSWORD
=HTTPAuthPswd
(default value: None)
O
HTTPREQUESTTIMEOUT HTTP request timeout in seconds. Numbers HTTPREQUESTTIMEOUT=20
(default value: 10)
O
POLLINTERVAL SMS polling period in seconds. Numbers POLLINTERVAL=20
(default value: 10)
O
POLLURL Download outgoing messages from this URL. URL unicode strings POLLURL=
http%3A%2F%2F127.0.0.1
%2Fsms%2Foutgoing.php
(default value:
http://127.0.0.1/sms/outgoing.php)
O
POSTDATACONTENTTYPE POSTs content type. URL unicode strings POSTDATACONTENTTYPE
=application%2Fx-www-form-urlencoded
(default value: application/x-www-form-urlencoded)
O
POSTDATATEMPLATEFILEBINARYMESSAGES POST template binary. URL unicode strings POSTDATATEMPLATEFILEBINARYMESSAGES
=01001111
(no default value)
O
POSTDATATEMPLATEFILETEXTMESSAGES POST template binary. URL unicode strings POSTDATATEMPLATEFILETEXTMESSAGES
=Ok
(no default value)
O
PROXY Proxy host's IP address or domain name. URL unicode strings PROXY=127.0.0.1
(no default value)
O
PROXYUSER The username belonging to the proxy host. URL unicode strings PROXYUSER=ProxUser
(no default value)
O
PROXYPASSWORD The password belonging to the proxy host. URL unicode strings PROXYPASSWORD=ProxyPassword
(no default value)
O
PROXYPORT The password belonging to the proxy host. Numbers PROXYPORT=8080
(default value: 8080)
O
REPORTURLERROR HTTP URL to be called on message delivery errors. URL unicode strings REPORTURLERROR=
http://127.0.0.1/sms/outgoingstat.php?state=deliveredtonetwork
&sender=$originator&receiver=$recipient
&msgdata=$messagedata
&recvtime=$receivedtime&msgid=$messageid
(...%26msgdata%3D%24messagedata...)
(no default value)
O
REPORTURLHANDSET HTTP URL to be called when a message is successfully delivered to the handset. URL unicode strings REPORTURLHANDSET=
http://127.0.0.1/sms/outgoingstat.php?
state=deliveredtonetwork
&sender=$originator&receiver=$recipient
&msgdata=$messagedata
&recvtime=$receivedtime&msgid=$messageid
(...%26msgdata%3D%24messagedata...)
(no default value)
O
REPORTURLNETWORK HTTP URL to be called when a message is successfully delivered to the network. URL unicode strings REPORTURLNETWORK=
http://127.0.0.1/sms/outgoingstat.php?
state=deliveredtonetwork
&sender=$originator&receiver=$recipient
&msgdata=$messagedata
&recvtime=$receivedtime&msgid=$messageid
(...%26msgdata%3D%24messagedata...)
(no default value)
O
REQUESTMETHOD HTTP request method. EMPTY, GET, POST REQUESTMETHOD=GET
(default value: POST)
O
TARGETURL HTTP URL to be called if an SMS message arrives. URL unicode strings TARGETURL=
http://127.0.0.1/sms/incoming.php?
sender=$originator&receiver=$recipient
&msgdata=$messagedata
&recvtime=$receivedtime&msgid=$messageid
(...%26msgdata%3D%24messagedata...)
(no default value)
O
USEINCOMING Specifies if the incoming message should be forwarded using HTTP. on, off USEINCOMING=off
(default value: on)
O
USEOUTGOINGSTATUS Specifies if delivery report information should be forwarded about outgoing messages using HTTP. on, off USEOUTGOINGSTATUS=on
(default value: off)
O
USEPOLLING Enables outgoing message downloading from the POLLURL. on, off USEPOLLING=on
(default value: off)
O

* M = Mandatory parameter, O = Optional parameter

'HTTPServer' user

It can use the HTTP API and the built in HTTP Server of Ozeki SMS Gateway to send or receive SMS and MMS messages. It is useful if you would like to use the 'reporturl' parameter in the 'sendmessage' action. You can configure any previously created HTTP Server user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&name=HTTPServerUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

Parameters:

ACCOUNTING on
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION on
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD _ENC_VjVkuhNaT1w=
PHONENUMBER http
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

'SMPP' user

It can log in to send and receive SMS messages using the SMPP protocol. You can configure any previously created SMPP user with a simple 'configuser' HTTP request.

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&DELIVERYREPORTACTION=both&name=SMPPUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the SMPP user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER smpp
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
DELIVERYREPORTACTION Delivery report. deliveredtohandset, deliveredtonetwork, both, none DELIVERYREPORTACTION
=deliveredtohandset
(default value: deliveredtohandset)
O
MESSAGEIDFORMAT Message ID format. Hexadecimal, Integer, GUID MESSAGEIDFORMAT
=Hexadecimal
(default value: Hexadecimal)
O
SMSCCHARSET SMSC default character set. Default, GSM 7-bit, UCS-2 SMSCCHARSET
=GSM 7-bit
(default value: GSM 7-bit)
O

* M = Mandatory parameter, O = Optional parameter

'Appstarter' user

If a message arrives the specified application is launched. You may specify the following parameters as command line arguments:
$SENDER, $RECEIVER, $MSG, $SENTTIME, $RECEIVEDTIME, $MSGTYPE, $MSGID, $OPERATOR

Example configuration:
HTTP request:

http://127.0.0.1:9505/api?action=configuser&username=admin&password=abc123
&EXECUTECOMMAND=C%3a%5cprocess.bat+%22%24SENDER%22+%22%24MSG%22
&name=AppstarterUser1&PASSWORD=ExamplePassword

HTTP response:

StatusCode: 200
XML: Ok

The basic parameters for the Appstarter user are the Standard user parameters.

Basic parameter default values:
ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER appstarter
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Parameters:

Parameter Description Possible values Example M/O*
EXECUTECOMMAND Command which should be executed. URL encoded string EXECUTECOMMAND
=C:\process.bat "$SENDER" "$MSG"
(C%3A%5Cprocess.bat
%20%22%24SENDER%22%20%22%24MSG%22)
(no default value)
O
PROCESSRESPONSE Specifies if process response messages should be returned by the application on it's standard output. on, off PROCESSRESPONSE=off (default value: on) O

* M = Mandatory parameter, O = Optional parameter

'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).


'AutoReplyEasy' 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).


Users with restricted configurability
(only Standard user parameters are configurable)

The following users have restricted configurability:
ASP, AutoreplyDatabase, Loopback, FTP, OutlookMobileService, RSS, PDF, WCF, Voting

Parameters:

ACCOUNTING off
ADDRESSBOOKTYPE File Addressbook
ALLOWROUTEOVERRIDE off
AUTOCONNECT on
GUIACCESS on
IDOVERRIDE off
LOGCOMMUNICATION off
LOGMESSAGES on
LOGDIRECTORY C:\Program Files\Ozeki\Ozeki10\Data\NG\Logs
LOGHISTORYCOUNT 4
LOGLINESBEFORECHECKSIZE 20
LOGMAXFILESIZE 8000
PASSWORD
PHONENUMBER rss
TBPATH C:\Program Files\Ozeki\Ozeki10\Data\NG\Users\admin\Addressbook

Copyright © 2000- - Ozeki Ltd | info@ozeki.hu
Home > Products > Ozeki 10 > Apps > SMS Gateway > HTTP API > User handling > configuser
Legal | Privacy policy | Terms of use
Page: 5703 | Login | 3.95.131.97