OZEKI WEBOFFICE: Template for page '71' not found! Create a tepmlate for this page!

How to add an SMPP connection

On this page we provide software developers and system administrators with instructions on how to configure the SMPP connection for SMS messaging with the Ozeki NG SMS Gateway. We provide an SMPP example configuration, and we explain the directives to set.

The SMPP protocol is used for IP SMS connectivity. The installation of the SMPP connection is an easy procedure. Before you start the installation, make sure you have the necessary login information from your IP SMS provider to connect to their service. You will need the IP address of their server, the port number, a username, a password and a telephone number that is assigned to your account. The connection parameters are the host name (sometimes only an IP address is given), the port number, a username and a password. Service providers often use the phone number of the service or the port number as the username.

SMPP Example configuration

<SMSC>
   Protocol SMPP
   Operator Vodafone1
   PhoneNumber +36701234657

   Host smsc1.vodafone.hu
   Port 9876
   User admin
   Password abc123


   Deliveryreport on
   Autoconnect on
   KeepalivePeriod 20
   Send on
   Receive on
   LogCommunication off

   ProtocolVersion 3.4  
   SystemType smpp

   #Comment to use default values
   DestTON 1
   DestNPI 1

   SourceTON 1
   SourceNPI 1
  
   #Mode transmitter
   #Mode receiver
   #Mode transceiver
   Mode transceiver
</SMSC>

Directives

Every connection session consists of a beginning <SMSC> tag and a closing </SMSC> tag.
You have to set the following directives:

Protocol
The protocol name is SMPP.

Protocol SMPP

Operator name
The operator name is used to refer to the SMSC for the routing of messages. The operator name can be any alphanumerical text, which has to be unique if more than one connection is installed in the Ozeki NG SMS Gateway. Mostly we specify the name of the service provider to name and identify the connection, but the operator name can also be different from that of the service provider. However, it is important to note that different connections require different names. If you have different connections from the same service provider, you are well advised to use different names for them, e.g.: Vodafone1, Vodafone2, etc.

Operator <text>

Phone number
The phone number refers to the telephone number assigned to the application. It is usually given by the service provider. In many cases, this phone number can be freely chosen when sending outgoing messages. You can even specify a text, e.g.: OZEKIGateway

PhoneNumber <text>

Hostname
The hostname refers to the server that the Ozeki NG SMS Gateway will connect to. An SMSC connection is described by a hostname that you receive from the service provider, which is an essential part of the SMSC authentication method.

Host <text>

Port
This directive specifies the port that the Ozeki NG SMS Gateway will connect to. This specification allows you to customize a connection. Specifying the port parameter by giving a positive whole number in numerical characters representing a positive whole number is also part of the SMSC authentication method. Valid values range from 1 to 65536.

Port <integer>

Username/Password
Giving the username and the password is an essential part of the authentication method. The username and the password are text attributes which can also include numerical characters. They are specified by the service provider.

User <text>
Password <text>

Delivery report
The delivery report directive is used for receiving feedback on the delivery (or the failure of the delivery) of messages sent between the Ozeki NG SMS Gateway (sender) address and the user address(es) (receiver(s)).

Deliveryreport <on/off>

Autoconnect
This mechanism allows you to initiate a connection between the SMSC and the Ozeki NG SMS Gateway daemon whenever it is possible. If this directive is switched off, the connection has to be initiated manually.

Autoconnect <on/off>

Keepalive period
The keepalive period is the maximal length of idle connection between the Ozeki NG SMS Gateway and the SMSC. It can be specified by giving the number of seconds in numerical characters representing a positive whole number.

KeepalivePeriod <seconds>

Response timeout
The response timeout is the maximum waiting time for an SMSC if there are problems with the connection. It can be specified by giving the number of seconds in numerical characters representing a positive whole number. If there is no response, the program will regard the connection as disconnected.

ResponseTimeout <seconds>

Send
The send directive is essential for two-way communication. If it is switched on, the program will be able to send messages.

Send <on/off>

Receive
The receive directive is essential for two-way communication. If it is switched on, the program will be able to receive messages.

Receive <on/off>

Log Communication
The communication between the SMSC and the server can be logged with this directive. This can be useful for debugging connectivity errors and runtime routing errors.

Log Communication off

Protocol version
The protocol version describes the SMPP protocol version used between the SMSC and your server.

ProtocolVersion <text> default value 3.4

System type
The system type is for assigning the protocol standard of the other side (SMSC). It is specified by the service provider.

SystemType smpp

DestTON
DestTON 1 when the recipient address for a message is in international format (the first character is "+").
DestTON 0 when the recipient address is not in international format (the first character is not "+").

DestTON <0 / 1> Default 1

DestNPI
DestNPI 0 when the sender address is blank or in alphanumerical format.
DestNPI 1 in all other conditions.

DestNPI <0 / 1> Default 1

SourceTON
SourceTON 1 when the sender address for a submitted message is in international format (the first character is "+").
SourceTON 0 when the sender address is not in international format (the first character is not "+")
SourceTON 5 when the sender address is alphanumerical.

SourceTON  <0 / 1 / 5> Default 1

SourceNPI
SourceNPI 0 when the sender address is blank or in alphanumerical format.
SourceNPI 1 in all other conditions.

SourceNPI  <0 / 1> Default 1

Mode
The mode directive describes the way of SMSC communication. There are three ways of communication:
1.)
transmitter - You only use this connection for sending messages.
2.)
receiver - You only use this connection for receiving messages.
3.)
transreceiver - You use this connection for both sending and receiving messages.

Mode <transmitter / receiver / transceiver> Default transceiver

Related page: