Callcenter developers
If you are working on telephone solutions, please check
out the Ozeki VoIP SIP SDK.
It can be used to create: |
Webphone solutions:
- Adobe Flash video phone
- Silverlight video phone
- Web to web calls
- Web to VoIP calls
Custom SIP clients:
- Silverlight SIP VoIP client
- Flash SIP VoIP client
- C# .net SIP VoIP client
- ASP .net SIP VoIP client
- Web based SIP VoIP client
Custom VoIP solutions:
- VoIP SIP softphones
- VoIP call center clients
- VoIP IVR systems
- VoIP predictive dialer systems
- VoIP auto dialer systems
- VoIP call assistant
- VoIP call recording systems
- VoIP intercom solutions
|
Service provider connection handling via HTTP API
On this page you will find an example on
how you can manage Service provider connections in Ozeki NG SMS Gateway via HTTP API. Please note that this
feature available in Ozeki NG - SMS Gateway v4.1.12 and above.
In this page, the Service provider connections in Ozeki NG - SMS Gateway are referred as Driver.
General driver actions
| Action name |
Description |
Parameters |
Example |
| createdriver |
You can create a new driver with this action type. |
type |
http://127.0.0.1:9501/api?action=createdriver&username=admin& password=abc123&type=SMPP |
| deletedriver |
You can delete an existing driver with this action type. |
name |
http://127.0.0.1:9501/api?action=deletedriver&username=admin& password=abc123&name=username |
| startuser |
You can start a driver with this action type. |
name |
http://127.0.0.1:9501/api?action=startdriver&username=admin& password=abc123&name=username |
| stopuser |
You can stop a driver with this action type. |
name |
http://127.0.0.1:9501/api?action=stopdriver&username=admin& password=abc123&name=username |
Driver configuration
You can configure the service provider connections with the configdriver action in Ozeki NG. Required parameter: name.
After the name of the driver, you type the parameter you wish to config and the value of it.
[config_entry] = value
Here you can find all the service provider connections and their default values:
GSM/GPRS Modem Connection
| AUTOCONNECT | on |
| BAUDRATE | 19200 |
| CBADDRESSHIDING | off |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| DATABITS | 8 bits |
| DELAYAFTERSUBMIT | on |
| DELAYINTERVAL | 1 |
| DELIVERYREPORT | on |
| DISCONNECTONTIMEOUT | off |
| DOWNLOADMMS | on |
| GPRSAPN | |
| GPRSDIALSTRING | *99***1# |
| GPRSPASSWORD | |
| GPRSUSERNAME | |
| GSMMODEMINIT | AT |
| GSMMODEMINIT2 | |
| GSMMODEMINIT3 | |
| HWHANDSHAKE | Rts/Cts |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LEAVEMESSAGES | off |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| METHODTOUSE | CMGL |
| MMSCURL | |
| MMSPROVIDER | Hungary / Pannon |
| MODEMORPORT | COM1 |
| NOLOOPBACK | off |
| NOPDUMODE | off |
| OPERATOR | GSMModem0 |
| OVERRIDESIMSMSC | off |
| PARITY | None |
| PHONEMEMORYCELLS | 10 |
| PHONENUMBER | +441234567 |
| PINCODE | |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | GSMModem |
| RECEIVE | on |
| SCAINPDU | off |
| SEND | on |
| SENDMETHOD | CMGS |
| SIMMEMORYCELLS | 10 |
| SLOWMODEM | off |
| SMSSERVICECENTERADDRESS | |
| STOPBITS | 1 bits |
| SUBMITTIMEOUT | 30 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| SWHANDSHAKE | None |
| USEGPRS | off |
| USEINTERNETFORMMS | off |
| USSDMETHOD | AT+CUSD |
| WAPGATEWAY | |
| WINDOWSIZE | 20 |
CIMD2 connection
| AUTOCONNECT | on |
| BINDTOHOSTIP | 0.0.0.0 |
| BINDTOPORT | 0 |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| CONVERTTOISOLATIN | off |
| DELIVERYREPORT | on |
| ETXHEXSTRING | 03 |
| EXCLUDEMOREMESSAGEPARAMETER | off |
| EXCLUDEORIGINATOR | on |
| HOST | 127.0.0.1 |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| NEWLINEREPLACEMENT | Pannon shift |
| OPERATOR | CIMD20 |
| PHONENUMBER | +441234567 |
| PORT | 9876 |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | CIMD2 |
| PROTOCOLWINDOWSIZE | 1 |
| RECEIVE | on |
| REPLACESTXNULLETXCRLF | off |
| SEND | on |
| SENDCHECKSUMS | on |
| SKIPPROTOCOLCHECKS | on |
| STXHEXSTRING | 02 |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| USEHEXLOG | off |
| WINDOWSIZE | 20 |
SMPP connection
| ADDRESSRANGE | |
| AUTOCONNECT | on |
| BINDNPI | |
| BINDTOHOSTIP | 0.0.0.0 |
| BINDTON | |
| BINDTOPORT | 0 |
| CBALTERNATIVEREPORTS | off |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| DCSHEXCHAR | 00 |
| DELIVERYREPORT | on |
| DELIVERYREPORTDATEFORMAT | yyMMddHHmm |
| DESTNPI | |
| DESTTON | |
| HOST | 127.0.0.1 |
| IDOVERRIDE | off |
| INCLUDEDRINESM | on |
| INCLUDEUDHIINESMBIN | on |
| INCLUDEUDHIINESMTEXT | on |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LEAVEPLUSSIGNINTELNUM | off |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| MODE | Transceiver |
| OPERATOR | SMPP0 |
| OPTIONALPARAMETER | |
| OVERRIDEDCS | off |
| PHONENUMBER | +441234567 |
| PORT | 9876 |
| PREFEREDCHARSET | Default |
| PROTOCOL | SMPP |
| PROTOCOLVERSION | 34 |
| PROTOCOLWINDOWSIZE | 1 |
| RECEIVE | on |
| SEND | on |
| SENDUNBIND | off |
| SERVICETYPEHEXSTR | 00 |
| SOURCENPI | |
| SOURCETON | |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| SYSTEMTYPE | SMPP |
| UNSPECIFIEDTON | International |
| USEANSIATSIGN | off |
| USEGSM7BITPACKEDENCODING | off |
| USEGSMDECODINGONINCOMING | on |
| USESAR | on |
| USETLVMESSAGEPAYLOAD | off |
| USETLVUDH4BIN | off |
| USETLVUDH4TEXT | off |
| WINDOWSIZE | 20 |
UCP connection
| AUTOCONNECT | on |
| BINDTOHOSTIP | 0.0.0.0 |
| BINDTOPORT | 0 |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| DELIVERYREPORT | on |
| HOST | 127.0.0.1 |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| NOTIFICATIONTYPE | 7 |
| OPERATOR | UCP0 |
| PHONENUMBER | +441234567 |
| PORT | 9876 |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | UCP |
| PROTOCOLWINDOWSIZE | 1 |
| RECEIVE | on |
| REQUIRELOGIN | on |
| SEND | on |
| SENDCHECKSUMS | on |
| SMTIDENTIFICATION | Empty |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| USELAID | on |
| WINDOWSIZE | 20 |
HTTP server connection
| AUTOCONNECT | on |
| BASEURL | http://127.0.0.1:9400 |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| DELIVERYREPORT | on |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| OPERATOR | HTTPServer0 |
| PARAMNAMEMESSAGEDATA | msg |
| PARAMNAMEMESSAGEID | msgid |
| PARAMNAMEMESSAGETYPE | msgtype |
| PARAMNAMEORIGINATOR | originator |
| PARAMNAMERECIPIENT | recipient |
| PARAMNAMESENTTIME | senttime |
| PARAMNAMESUBJECT | subject |
| PHONENUMBER | +441234567 |
| POLLINTERVAL | 2 |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | HTTPServer |
| RECEIVE | on |
| RESPONSETEMPLATE | Message was accepted id: $msgid |
| SEND | off |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| USEBACKENDRESPONSE | off |
| USEOUTBOXFILE | off |
| WINDOWSIZE | 20 |
HTTP Client Connection
| AUTOCONNECT | on |
| CBMULTIPARTASBIN | off |
| CBSEGMENT | on |
| CBSLOWCOMMUNICATION | off |
| CBTEXTASBIN | off |
| CBUNICODEASBIN | on |
| CBUSEHTTP10 | off |
| CERTFILE | C:\mycert.cer |
| CHARSETHANDLING | Best match |
| DELIVERYREPORT | on |
| ENCODINGCHARSET | utf-8 |
| HTTPAUTHORIZATIONMETHOD | |
| HTTPAUTHORIZATIONPASSWORD | |
| HTTPAUTHORIZATIONUSER | |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| NOURLENCODING | off |
| OPERATOR | HTTPClient0 |
| PASSWORDCERT | |
| PHONENUMBER | +441234567 |
| POLLINTERVAL | 2 |
| POSTDATACONTENTTYPE | application/x-www-form-urlencoded |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | HTTPClient |
| PROXY | |
| PROXYPASSWORD | |
| PROXYPORT | 8080 |
| PROXYUSER | |
| RECEIVE | on |
| REQUESTMETHOD | Get |
| RESPFAILED | |
| RESPSUCCESS | |
| SEND | on |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| TARGETURL | http://server.sms.com/send.cgi?receiver=$recipient &sender=$originator &msg=$messagedata&id=$messageid |
| TARGETURLBIN | http://server.sms.com/send.cgi?receiver=$recipient&sender= $originator&udh= $udhHEX&ud=$udHEX&dcs=$dcsHEX&PID=$pidHEX |
| USECERT | off |
| USERAGENT | OzekiNG/4.1.12 (+http://www.ozekisms.com) |
| USEXMLENCODING | off |
| WINDOWSIZE | 20 |
SMTP (E-mail to SMS) Connection
| CBSLOWCOMMUNICATION | off
|
| CHARACTERSETBODY | Default
|
| CHARACTERSETSUBJECT | Default
|
| CHARSETHANDLING | Best match
|
| DELIVERYREPORT | on
|
| IDOVERRIDE | off
|
| KEEPALIVEPERIOD | 30
|
| KEEPALIVEREQUEST | on
|
| LIMITTOMPM | 240
|
| LOGCOMMUNICATION | off
|
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
|
| LOGHISTORYCOUNT | 4
|
| LOGLINESBEFORECHECKSIZE | 20
|
| LOGMAXFILESIZE | 8000
|
| LOGMESSAGES | on
|
| MAILBODY | $messagetext
|
| MAILFROM | sms@mycompany.com
|
| MAILSUBJECT | $messagetext
|
| MAILTO | $recipient@serviceprovider.com
|
| OPERATOR | SMTP0
|
| PASSWORDSMTP |
|
| PHONENUMBER | +441234567
|
| PREFEREDCHARSET | GSM7bit
|
| PROTOCOL | SMTP
|
| RECEIVE | on
|
| SEND | on
|
| SMTPAUTH | off
|
| SMTPPORT | 25
|
| SMTPSERVER | mail.mailserver.com
|
| SMTPSSL | off
|
| SUBMITTIMEOUT | 60
|
| SUBMITTIMEOUTACTION | SubmitFailed
|
| USERNAMESMTP |
|
| WINDOWSIZE | 20 |
EAIF Connection
| AUTOCONNECT | on
|
| CBSLOWCOMMUNICATION | off
|
| CHARSETHANDLING | Best match
|
| DELIVERYREPORT | on
|
| HTTPUSERNAME |
|
| IDOVERRIDE | off
|
| KEEPALIVEPERIOD | 30
|
| KEEPALIVEREQUEST | on
|
| LIMITTOMPM | 240
|
| LOGCOMMUNICATION | off
|
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs
|
| LOGHISTORYCOUNT | 4
|
| LOGLINESBEFORECHECKSIZE | 20
|
| LOGMAXFILESIZE | 8000
|
| LOGMESSAGES | on
|
| OPERATOR | EAIFMMS0
|
| PASSWORDHTTP |
|
| PHONENUMBER | +441234567
|
| PREFEREDCHARSET | GSM7bit
|
| PROTOCOL | EAIFMMS
|
| RECEIVE | on
|
| SEND | on
|
| SUBMITTIMEOUT | 60
|
| SUBMITTIMEOUTACTION | SubmitFailed
|
| TBLISTENINGADDRESS | http://+:8189/
|
| TBTERMINATINGAA | http://127.0.0.1:8189/
|
| WINDOWSIZE | 20 |
MM7 Connection
| AUTOCONNECT | on |
| CBSLOWCOMMUNICATION | off |
| CERTFILE | C:\mycert.cer |
| CHARSETHANDLING | Best match |
| CUSTOMXML | |
| DELIVERYREPORT | on |
| HTTPAuthorizationMethod | None |
| HTTPAUTHORIZATIONMETHOD | |
| HTTPUSERNAME | |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LINKEDID | |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| MM7LISTENERURL | |
| MM7SCHEMA | REL-5-MM7-1-0 |
| MM7SUBMITURL | http://192.168.90.194:8080/vasp/MMCEmulator |
| MMSVERSION | 5.3.0 |
| OPERATOR | MM7MMS0 |
| PASSWORDCERT | |
| PASSWORDHTTP | |
| PHONENUMBER | +441234567 |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | MM7MMS |
| PROXY | |
| PROXYPASSWORD | |
| PROXYPORT | 8080 |
| PROXYUSER | |
| RECEIVE | on |
| SEND | on |
| SERVICECODE | |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| USECERT | off |
| USESIMPLENUMBERFORMAT | off |
| VASID | OZK |
| VASPID | News |
| WINDOWSIZE | 20 |
VoIP Autodialer
| AUTOCONNECT | on |
| CBACCREGISTRATIONREQUIRED | off |
| CBSLOWCOMMUNICATION | off |
| CHARSETHANDLING | Best match |
| CONNECTION | ATA |
| DELIVERYREPORT | on |
| IDOVERRIDE | off |
| KEEPALIVEPERIOD | 30 |
| KEEPALIVEREQUEST | on |
| LIMITTOMPM | 240 |
| LOGCOMMUNICATION | off |
| LOGDIRECTORY | C:\Program Files (x86)\Ozeki\OzekiNG - SMS Gateway\Logs |
| LOGHISTORYCOUNT | 4 |
| LOGLINESBEFORECHECKSIZE | 20 |
| LOGMAXFILESIZE | 8000 |
| LOGMESSAGES | on |
| MAXMESSAGELENGTH | 0 |
| NATTYPE | STUN |
| OPERATOR | ozVoIP0 |
| PHONENUMBER | +441234567 |
| PREFEREDCHARSET | GSM7bit |
| PROTOCOL | ozVoIP |
| RECEIVE | on |
| SEND | on |
| STUNPASSWORD | |
| STUNSERVER | stun.ozekiphone.com |
| STUNUSERNAME | |
| SUBMITTIMEOUT | 60 |
| SUBMITTIMEOUTACTION | SubmitFailed |
| TBACCDISPLAYNAME | |
| TBACCDOMAINSERVER | |
| TBACCREGISTERNAME | |
| TBACCREGISTERPASSWORD | |
| TBACCUSERID | |
| TBADVLOCALIP | 192.168.113.16 |
| TBADVLOCALPORTMAX | 5100 |
| TBADVLOCALPORTMIN | 5000 |
| TBADVLOCALSIPPORT | 5060 |
| TBATAADDRESS | 192.168.100.1 |
| TBATAPORT | 5060 |
| WINDOWSIZE | 20 |
| TBADVLOCALPORTSIP | 5060 |
Next page:
Reporting API
|
