Output SMS event adapter 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 be configured with XML, text, and JSON output mappings.
Before the configuration starts, follow the steps below to configure the SMS sender.
Edit systemId
, password
, and other relevant properties of SMS sender configuration in <PRODUCT_HOME>/repository/conf/axis2/axis2_client.xml
file. For example,
<axisconfig name="AxisJava2.0"> ... <transportSender class="org.apache.axis2.transport.sms.SMSSender" name="sms"> <parameter name="systemType"></parameter> <parameter name="systemId">cep1</parameter> <parameter name="password">cep123</parameter> <parameter name="host">localhost</parameter> <parameter name="port">2775</parameter> <parameter name="phoneNumber">CEP1</parameter> </transportSender> ... </axisconfig>
Copy following libraries to <PRODUCT_HOME>/repository/components/lib/
directory.
You can configure output SMS event adapter using the management console or using a configuration file.
Follow the instructions below to configure output SMS event adapter using the management console. This deploys the event adapter in the <PRODUCT_HOME>
/
repository/
deployment/
server/out
puteventadaptors/
directory.
Enter outputSMSAdaptor
for Event Adaptor Name, and select sms
for Event Adaptor Type as shown below.
Follow the instructions below to configure output SMS event adapter using a configuration file.
Create an XML file with the following output SMS event adapter configurations. Output event adapter implementation must start with <outputEventAdaptor>
as the root element.
<outputEventAdaptor name="outputSMSAdaptor" type="sms" xmlns="http://wso2.org/carbon/eventadaptormanager"/>
<PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/
directory. Since hot deployment is supported in the product, you can simply add/remove output event adapter configuration files to deploy/undeploy output event adapters to/from the server.After an adapter is successfully added, it gets added to the list of adapters displayed under Event Processor Configs in the Configure menu of the product's management console. Click Edit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event adapter configurations from the UI. Do your modifications and click Update. You can also delete it, enable/disable statistics or enable/disable tracing on it using the provided options in the UI.
Follow the instructions below to set up and configure SMCC server to receive messages. This example uses Logica SMSC simulator.
Navigate to SMSC Simulator directory, and add the following name-value pairs to users.txt
file. (The folder must also contain smpp.jar
and smscsim.jar
files.)
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.
name=cep1 password=cep123 timeout=unlimited
java -cp smpp.jar:smscsim.jar com.logica.smscsim.Simulator
Enter 2775 as the port number (this port is equal to the port defined in the SMS transport sender configuration.)
Starting listener... started
log is displayed on the console, the SMSC simulator is ready to accept messages.sms
output event adapter type can be configured as follows.Click the name of the event formatter to which the relevant output event adapter is connected. This opens the Event Formatter Details page.
The message properties of an sms
output event adapter are described below. Change the property values as required.
Property | Description |
---|---|
Phone No | Phone number of the SMS receiver. |
Output Event Type | The outgoing event type to be mapped. The output SMS event adapter supports text, XML, and JSON mappings. |