HOW TO USE THE TCP/IP PLUGIN

Ozeki Message Server enables client software installed on the network, to send and receive SMS messages over a TCP/IP link. In order to make this possible for the clients, the TCP/IP plugin needs to be installed and configured in Ozeki Message Server.

PLUGIN INSTALLATION

In the following part we will show the easy process of the plugin installation.

Plugin installation
Figure 1 - Plugin installation

New plugins can be installed by choosing Installed Plugins from the Plugin menu. (Figure 1.)

Available plugins for installation
Figure 2 - Available plugins for installation

In the "Available plugins for installation" window click on the TCP plugin install link and the installation process will start. (Figure 2, Figure 3.).

Starting the configuration
Figure 4 - Starting the configuration

After installation you'll see the TCP plugin appearing on the list of plugins in the "Currently installed plugins" screen. On this form you can start the configuration by cliciking on the Configure link.(Figure 4.)

PLUGIN CONFIGURATION

Automatic startup
Figure 5 - Automatic startup

To start the configuration, click on the Configure URL and type the number of the TCP port into the Port: text box. The TCP server built into the plugin will lisen on this port. If you would like the TCP server of the pluginto start automatically when the Ozeki Message Server software starts, place a checkmark into the "Autoconnect on startup" checkbox and press Ok. (Figure 5.)

STARTING THE PLUGIN

After the plugin has been installed, you need to start it. The startup process means that the plugin allocates the configured TCP port and starts to listen on it for incoming connections. You can start the Ozeki Message Server TCP plugin by clicking on "Connect" in the "Currently installed plugins" screen (Figure 6., Figure 7.).

Starting the plugin
Figure 6 - Starting the plugin

After you have clicked on the Connect URL, you may use the Refresh this page link to check the connection state.

Checking the plugin connection state
Figure 7 - Checking the plugin connection state

If the connection was successfull the Conncetion state will be changed from offline to online. The connection picture also shows the online state.

TESTING THE TCP/IP CONNECTION

To test the functionality of the TCP plugin you can use the default telnet client of Microsoft Windows. To open it click on the windows Start button and select the Run... menu item. (Figure 8.)

Starting the Windows Telnet client
Figure 8 - Starting the Windows Telnet client

In the Run form, type the command you with to execute into the "Opening:" editbox. Use the following command:

telnet 127.0.0.1 9337

The 127.0.0.1 is the default local address for each computer. If you are testing the functionality over the network, you can use the IP address of the server, where Ozeki Message Server is installed. Note that the port number is the same that you set up in the TCP configuration window.

Initial message
Figure 9 - Initial message

If the connection was successfull you will receive the following message from the Ozeki Message Server:

+OK OZEKI TCP server ready

The Ozeki Message server uses login names and passwords to identify the users. The first step in the use of the TCP connection is the authentication. You can identify yourself by providing you username and password. First supply the user name by issuing the user command, then provide the password by issuing the pass command. (Figure 10.)

User authentication
Figure 10 - User authentication


user name

pass password

After authentication you can query incoming messages from the inbox. In this process first you might want to find out how many messages are there. For this task you may use that stat command. In our example (Figure 11.) there are two incoming messages in the inbox.

The stat command
Figure 11 - The stat command

stat
If you issue the stat command, the server will respond with the number of the SMS messages in the Inbox.

Example:
stat
+OK 2

To list these messages use the list command.

The list command
Figure 12 - The list command

list
If you use the list command, all messages will be listed in the Telnet window. Each line starts with a number. This number is separated from the phone number with a space. (Figure 12.) This number can be used as message reference. For example if you would like to delete a message you should refer to this number.

Example:
list
+ OK Mailbox scan listing follows
1 +36203105366 Hello world
2 +36203105366 OZEKI MESSAGE SERVER TRIAL - WWW.OZEKI.HU

The delete command
Figure 13 - The delete command

dele
Use the dele command with the message reference number to delete a message. Note that the deletion sets a flag for the message and the message is not actually deleted while your TCP session is active. The message will be deleted after you issue the quit command.

Sending an SMS
Figure 14 - Sending an SMS

postsms

You can use the postsms command to send messages using the Ozeki Message Server. You need to issue this command for each message. The first parameter of the command is the recepient phone number and the second parameter is the message text. (Figure 14.) The message ends with the new line character. (cr+lf)

Send SMS messages from the Telnet
Example:

postsms +36205444423 Hello bello haliho

If the SMS sending was successfull you will receive the following message:
+OK message sent
The outgoing message will be inserted into the Sent items box in the Ozeki SMS Message Server.

The quit command
Figure 15 - The quit command

quit

If you would like to close the Telnet window and you would like to end your TCP session type the quitcommand (Figure 15).

The inbox folder
Figure 16 - The inbox folder

When you quit the TCP session, the deleted messages will disappear from the Inbox in the Ozeki Message Server (Figure 16).

More information