Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

SMS output event adapter is event publisher is used to send message notifications via Short Message Peer-to-Peer Protocol (SMPP). It uses Axis2 SMS events when sending SMSs from WSO2 products. SMPP allows Axis2 to connect to a Short Messaging Service Center (SMSC) and send/receive SMSs. SMS event adapter can publisher can be configured with XML, text, and JSON output mappings.

Table of Contents
maxLevel3

Prerequisites

Follow the steps below to complete the prerequisites before starting the input adapter event publisher configurations.

  1. Add the following configuration under transport senders section in the <CEP<PRODUCT_HOME>/repository/conf/axis2/axis2_client.xml file, to enable SMS Transport.

    Code Block
    <axisconfigname="AxisJava2.0">
       ... 
       <transportSenderclass="org.apache.axis2.transport.sms.SMSSender"name="sms">
            <parametername="systemType"></parameter>
            <parametername="systemId">cep1</parameter>
            <parametername="password">cep123</parameter>
            <parametername="host">localhost</parameter>
            <parametername="port">2775</parameter>
            <parametername="phoneNumber">CEP1</parameter>
        </transportSender>
        ...
    </axisconfig>
  2. Copy the following libraries to <CEP<PRODUCT_HOME>/repository/components/lib/ directory.

Creating a

...

SMS event

...

publisher

For instructions on creating a SMS output event adapterpublisher, see Publishing Events.  

Configuring adapter properties

Specify the Dynamic Adapter Properties, when creating a SMS output event adapter using publisher using the management console as shown below.

...

You can also define the respective adapter properties of the event publisher based on the transport type within the <to> element of the event publisher configuration in the <CEP<PRODUCT_HOME>/repository/deployment/server/eventpublishers/ directory as follows.

...

Adapter Property
Description
Configuration file propertyExample

Phone No

Phone number of the SMS receiver in the following format: [country-code][number]

sms.no

0716453453

Other post configurations that use

...

SMS event

...

publisher

Follow the instructions below to set up and configure a SMSC Simulator to receive messages. This guide uses Logica SMSC simulator.

  1. Navigate to SMSC Simulator directory. The folder must contain following three files.
    smpp.jar
    smscsim.jar
    users.txt
  2. Add the following name-value pairs to users.txt file. 

    Info

    Enter the value of the systemId parameter defined in the above SMS transport sender configuration as the value of the name parameter in the below list.

    Code Block
    name=cep1 
    password=cep123
    timeout=unlimited
  3. Start SMSC Simulator by executing the following command:
    java -cp smpp.jar:smscsim.jar com.logica.smscsim.Simulator
  4. In the console where the command runs:
    • Enter 1 for the prompt to start simulation.
    • Enter 2775 as the port number (this port is equal to the port defined in the SMS transport sender configuration.)

    When the Starting listener... started log is displayed on the console, the SMSC simulator is ready to accept messages as shown below