Page History

h2. SMPP Component
*Available as of Camel 2.2*

This component provides access to an SMSC (Short Message Service Center) over the [SMPP|http://smsforum.net/SMPP_v3_4_Issue1_2.zip] protocol to send and receive SMS. The [JSMPP|http://code.google.com/p/jsmpp/] is used.

*Starting with Camel 2.9*, you are also able to execute ReplaceSm, QuerySm, SubmitMulti, CancelSm and DataSm. 

Maven users will need to add the following dependency to their {{pom.xml}} for this component:
{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-smpp</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
{code}

h3. URI format

{code}
smpp://[username@]hostname[:port][?options]
smpps://[username@]hostname[:port][?options]
{code}

If no *username* is provided, then Camel will provide the default value {{smppclient}}.
If no *port* number is provided, then Camel will provide the default value {{2775}}.
*Camel 2.3:* If the protocol name is "smpps", camel-smpp with try to use SSLSocket to init a connection to the server.

You can append query options to the URI in the following format, {{?option=value&option=value&...}}

h3. URI Options

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{password}} | {{password}} | Specifies the password to use to log in to the SMSC. |
| {{systemType}} | {{cp}} | This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). |
| {{dataCoding}} | {{0}} | *Camel 2.5 onwarts untilthrough Camel 2.8.x* Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. Example data encodings are:\\
{{0}}: SMSC Default Alphabet\\
{{4}}: 8 bit Alphabet\\
{{8}}: UCS2 Alphabet|
| {{alphabet}} | {{0}} | *Camel 2.9 onwartsonwards* Defines the alphabet of the data according the SMPP 3.4 specification, section 5.2.19. Example alphabet encodings are:\\
{{-1}}: The SMPP component will try to determine the actual alphabet to be used. The message will be sent using UCS2 encoding if it contains non standard GSM characters.\\
{{0}}: SMSC Default Alphabet\\
{{4}}: 8 bit Alphabet\\
{{8}}: UCS2 Alphabet|
| {{encoding}} | {{ISO-8859-1}} | *only for SubmitSm, ReplaceSm and SubmitMulti* Defines the encoding scheme of the short message user data. |
| {{enquireLinkTimer}} | {{5000}} | Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC. |
| {{transactionTimer}} | {{10000}} | Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME). |
| {{initialReconnectDelay}} | {{5000}} | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. |
| {{reconnectDelay}} | {{5000}} | Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. |
| {{registeredDelivery}} | {{1}} | *only for SubmitSm, ReplaceSm, SubmitMulti and DataSm* Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined:\\
{{0}}: No SMSC delivery receipt requested.\\
{{1}}: SMSC delivery receipt requested where final delivery outcome is success or failure.\\
{{2}}: SMSC delivery receipt requested where the final delivery outcome is delivery failure. |
| {{serviceType}} | {{CMT}} | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined:\\
{{CMT}}: Cellular Messaging\\
{{CPT}}: Cellular Paging\\
{{VMN}}: Voice Mail Notification\\
{{VMA}}: Voice Mail Alerting\\
{{WAP}}: Wireless Application Protocol\\
{{USSD}}: Unstructured Supplementary Services Data |
| {{sourceAddr}} | {{1616}} | Defines the address of SME (Short Message Entity) which originated this message. |
| {{destAddr}} | {{1717}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. |
| {{sourceAddrTon}} | {{0}} | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{destAddrTon}} | {{0}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the type of number (TON) to be used in the SME destination address parameters. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{sourceAddrNpi}} | {{0}} | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{destAddrNpi}} | {{0}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{priorityFlag}} | {{1}} | *only for SubmitSm and SubmitMulti* Allows the originating SME to assign a priority level to the short message. Four Priority Levels are supported:\\
{{0}}: Level 0 (lowest) priority\\
{{1}}: Level 1 priority\\
{{2}}: Level 2 priority\\
{{3}}: Level 3 (highest) priority |
| {{replaceIfPresentFlag}} | {{0}} | *only for SubmitSm and SubmitMulti* Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: \\
{{0}}: Don't replace\\
{{1}}: Replace |
| {{typeOfNumber}} | {{0}} | Defines the type of number (TON) to be used in the SME. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{numberingPlanIndicator}} | {{0}} | Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{lazySessionCreation}} | {{false}} | *Camel 2.8 onwartsonwards* Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. |
| {{httpProxyHost}} | {{null}} | *Camel 2.9.1:* If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy. |
| {{httpProxyPort}} | {{3128}} | *Camel 2.9.1:* If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. |
| {{httpProxyUsername}} | {{null}} | *Camel 2.9.1:* If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy. |
| {{httpProxyPassword}} | {{null}} | *Camel 2.9.1:* If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy. |
{div}

You can have as many of these options as you like.
{code}
smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer
{code}


h3. Producer Message Headers

The following message headers can be used to affect the behavior of the SMPP producer
{div:class=confluenceTableSmall}
|| Header || Type || Description ||
| {{CamelSmppDestAddr}} | {{List}}/{{String}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. Is must be a {{List<String>}} for SubmitMulti and a {{String}} otherwise. |
| {{CamelSmppDestAddrTon}} | {{Byte}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the type of number (TON) to be used in the SME destination address parameters. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{CamelSmppDestAddrNpi}} | {{Byte}} | *only for SubmitSm, SubmitMulti, CancelSm and DataSm* Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{CamelSmppSourceAddr}} | {{String}} | Defines the address of SME (Short Message Entity) which originated this message. |
| {{CamelSmppSourceAddrTon}} | {{Byte}} | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{CamelSmppSourceAddrNpi}} | {{Byte}} | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{CamelSmppServiceType}} | {{String}} | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined:\\
{{CMT}}: Cellular Messaging\\
{{CPT}}: Cellular Paging\\
{{VMN}}: Voice Mail Notification\\
{{VMA}}: Voice Mail Alerting\\
{{WAP}}: Wireless Application Protocol\\
{{USSD}}: Unstructured Supplementary Services Data |
| {{CamelSmppRegisteredDelivery}} | {{Byte}} | *only for SubmitSm, ReplaceSm, SubmitMulti and DataSm* Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined:\\
{{0}}: No SMSC delivery receipt requested.\\
{{1}}: SMSC delivery receipt requested where final delivery outcome is success or failure.\\
{{2}}: SMSC delivery receipt requested where the final delivery outcome is delivery failure. |
| {{CamelSmppPriorityFlag}} | {{Byte}} | *only for SubmitSm and SubmitMulti* Allows the originating SME to assign a priority level to the short message. Four Priority Levels are supported:\\
{{0}}: Level 0 (lowest) priority\\
{{1}}: Level 1 priority\\
{{2}}: Level 2 priority\\
{{3}}: Level 3 (highest) priority |
| {{CamelSmppScheduleDeliveryTime}} | {{Date}} | *only for SubmitSm, SubmitMulti and ReplaceSm* This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. |
| {{CamelSmppValidityPeriod}} | {{String}}/{{Date}} | *only for SubmitSm, SubmitMulti and ReplaceSm* The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as {{Date}}, it's interpreted as absolute time. *Camel 2.9.1 onwartsonwards:* It can be defined in absolute time format or relative time format if you provide it as {{String}} as specified in chapter 7.1.1 in the smpp specification v3.4. | 
| {{CamelSmppReplaceIfPresentFlag}} | {{Byte}} | *only for SubmitSm and SubmitMulti* The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: \\
{{0}}: Don't replace\\
{{1}}: Replace |
| {{CamelSmppDataCoding}} | {{Byte}} | *Camel 2.5 onwarts untilthrough Camel 2.8.x* The data coding according to the SMPP 3.4 specification, section 5.2.19: \\
{{0}}: SMSC Default Alphabet\\
{{4}}: 8 bit Alphabet\\
{{8}}: UCS2 Alphabet|
| {{CamelSmppAlphabet}} | {{Byte}} | *Camel 2.9 onwartsonwards only for SubmitSm, SubmitMulti and ReplaceSm* The data coding according to the SMPP 3.4 specification, section 5.2.19: \\
{{-1}}: The SMPP component will try to determine the actual alphabet to be used. The message will be sent using UCS2 encoding if it contains non standard GSM characters.\\
{{0}}: SMSC Default Alphabet\\
{{4}}: 8 bit Alphabet\\
{{8}}: UCS2 Alphabet|
{div}

The following message headers are used by the SMPP producer to set the response from the SMSC in the message header
{div:class=confluenceTableSmall}
|| Header || Type || Description ||
| {{CamelSmppId}} | {{List<String>}}/{{String}} | The id to identify the submitted short message(s) for later use. *From Camel 2.9.0*: In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header vaule is a {{String}}. In case of a SubmitSm or SubmitMultiSm this header vaule is a {{List<String>}}. |
| {{CamelSmppSentMessageCount}} | {{Integer}} | *From Camel 2.9 onwartsonwards only for SubmitSm and SubmitMultiSm* The total number of messages which has been sent. |
| {{CamelSmppError}} | {{Map<String, List<Map<String, Object>>>}} | *From Camel 2.9 onwartsonwards only for SubmitMultiSm* The errors which occurred by sending the short message(s) the form {{Map<String, List<Map<String, Object>>>}} (messageID : (destAddr : address, error : errorCode)). |
{div}

h3. Consumer Message Headers

The following message headers are used by the SMPP consumer to set the request data from the SMSC in the message header
{div:class=confluenceTableSmall}
|| Header || Type || Description ||
| {{CamelSmppSequenceNumber}} | {{Integer}} | *only for AlertNotification, DeliverSm and DataSm* A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field. |
| {{CamelSmppCommandId}} | {{Integer}} | *only for AlertNotification, DeliverSm and DataSm* The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4. |
| {{CamelSmppSourceAddr}} | {{String}} | *only for AlertNotification, DeliverSm and DataSm* Defines the address of SME (Short Message Entity) which originated this message. |
| {{CamelSmppSourceAddrNpi}} | {{Byte}} | *only for AlertNotification and DataSm* Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) Same values as in Producer header list above. |
| {{CamelSmppSourceAddrTon}} | {{Byte}} | *only for AlertNotification and DataSm* Defines the type of number (TON) to be used in the SME originator address parameters. Same values as in Producer header list above. |
| {{CamelSmppSourceAddrTonCamelSmppEsmeAddr}} | {{ByteString}} | *only for AlertNotification and DataSm* Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated |
| {{CamelSmppEsmeAddr}} | {{String}} | *only for AlertNotification* Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS. |
| {{CamelSmppEsmeAddrNpi}} | {destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS. |
| {{CamelSmppEsmeAddrNpi}} | {{Byte}} | *only for AlertNotification* Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum) |
| {{CamelSmppEsmeAddrTon}} | {{Byte}} | *only for AlertNotification* Defines the numerictype planof indicatornumber (NPITON) to be used in the ESME originator address parameters. The following NPITON values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)International\\
{{2}}: Data (X.121)National\\
{{3}}: Telex (F.69)Network Specific\\
{{64}}: Land Mobile (E.212)Subscriber Number\\
{{85}}: NationalAlphanumeric\\
{{96}}: Abbreviated Private\\|
| {{10CamelSmppId}}: ERMES\\
 | {{13String}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum)| *only for smsc DeliveryReceipt and DataSm* The message ID allocated to the message by the SMSC when originally submitted. |
| {{CamelSmppEsmeAddrTonCamelSmppDelivered}} | {{ByteInteger}} | *only for smsc AlertNotificationDeliveryReceipt* DefinesNumber theof typeshort ofmessages number (TON) to be used indelivered. This is only relevant where the ESMEoriginal originatormessage addresswas parameters.submitted Theto followinga TONdistribution valueslist.The are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviatedvalue is padded with leading zeros if necessary. |
| {{CamelSmppIdCamelSmppDoneDate}} | {{StringDate}} | *only for smsc DeliveryReceipt and DataSm* The messagetime IDand allocateddate toat which the short message by the SMSC when originally submittedreached it's final state. The format is as follows: YYMMDDhhmm. |
| {{CamelSmppDeliveredCamelSmppFinalStatus}} | {{IntegerDeliveryReceiptState}} | *only for smsc DeliveryReceipt:* The Numberfinal status of shortthe messages deliveredmessage. ThisThe isfollowing onlyvalues relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary. |
| {{CamelSmppDoneDate}} | {{Date}} | *only for smsc DeliveryReceipt* The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.are defined:\\
{{DELIVRD}}: Message is delivered to destination\\
{{EXPIRED}}: Message validity period has expired.\\
{{DELETED}}: Message has been deleted.\\
{{UNDELIV}}: Message is undeliverable\\
{{ACCEPTD}}: Message is in accepted state (i.e. has been manually read on behalf of the subscriber by customer service)\\
{{UNKNOWN}}: Message is in invalid state\\
{{REJECTD}}: Message is in a rejected state |
| {{CamelSmppFinalStatusCamelSmppCommandStatus}} | {{DeliveryReceiptStateInteger}} | *only for smsc DeliveryReceipt:DataSm* The finalCommand status of the message. The following values are defined:\\
{{DELIVRD}}: Message is delivered to destination\\
{{EXPIRED}}: Message validity period has expired.\\
{{DELETED}}: Message has been deleted.\\
{{UNDELIV}}: Message is undeliverable\\
{{ACCEPTD}}: Message is in accepted state (i.e. has been manually read on behalf of the subscriber by customer service)\\
{{UNKNOWN}}: Message is in invalid state\\
{{REJECTD}}: Message is in a rejected state |
| {{CamelSmppCommandStatus}} | {{Integer|
| {{CamelSmppError}} | {{String}} | *only for smsc DeliveryReceipt* Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here. |
| {{CamelSmppSubmitDate}} | {{Date}} | *only for smsc DataSmDeliveryReceipt* The Command status oftime and date at which the short message was submitted. |
| {{CamelSmppError}} | {{String}} | *only for smsc DeliveryReceipt* Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included hereIn the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm. |
| {{CamelSmppSubmitDateCamelSmppSubmitted}} | {{DateInteger}} | *only for smsc DeliveryReceipt* The time and date at which Number of short messages originally submitted. This is only relevant when the shortoriginal message was submitted. Into thea casedistribution oflist.The avalue messageis whichpadded haswith beenleading replaced,zeros this is the date that the original message was replaced. The format is as follows: YYMMDDhhmmif necessary. |
| {{CamelSmppDestAddr}} | {{String}} | *only for DeliverSm and DataSm:* Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. |
| {{CamelSmppSubmittedCamelSmppScheduleDeliveryTime}} | {{IntegerString}} | *only for smsc DeliveryReceiptDeliverSm:* NumberThis ofparameter shortspecifies messagesthe originallyscheduled submitted.time Thisat iswhich onlythe relevantmessage whendelivery theshould originalbe messagefirst wasattempted. submittedIt todefines aeither distributionthe list.Theabsolute valuedate isand paddedtime withor leadingrelative zerostime iffrom necessary. |
| {{CamelSmppDestAddr}} | {{String}} | *only for DeliverSm and DataSm:* Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MSthe current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time	format is specified in Section 7.1.1. in the smpp specification v3.4. |
| {{CamelSmppScheduleDeliveryTimeCamelSmppValidityPeriod}} | {{String}} | *only for DeliverSm:* The Thisvalidity period parameter specifiesindicates the SMSC scheduledexpiration time, atafter which the message delivery should be first attempted discarded if not delivered to the destination. It definescan be eitherdefined thein absolute datetime and timeformat or relative time fromformat. theThe current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format orencoding of absolute and relative time format. The encoding of a time	format is specified in Section 7.1.1. in the smpp specification v3.4. |
| {{CamelSmppValidityPeriodCamelSmppServiceType}} | {{String}} | *only for DeliverSm and DataSm* The validityservice periodtype parameter indicates the SMSCSMS expirationApplication time,service afterassociated whichwith the message. should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4. |
| {{CamelSmppServiceType}} | {{String}} | *only for DeliverSm and DataSm* The service type parameter indicates the SMS Application service associated with the message. |
| {{CamelSmppRegisteredDelivery}} | {{Byte}} | *only for DataSm* Is used to request an delivery receipt and/or SME originated acknowledgements. The following values are defined:\\
{{0}}: No SMSC delivery receipt requested.\\
{{1}}: SMSC delivery receipt requested where final delivery outcome is success or failure.\\
{{2}}: SMSC delivery receipt requested where the final delivery outcome is delivery failure.  |
| {{CamelSmppDestAddrNpi}} | {{Byte}} | *only for DataSm* Defines the numeric plan indicator (NPI) in the destination address parameters. The following NPI values are defined: \\
{{0}}: Unknown\\
{{1}}: ISDN (E163/E164)\\
{{2}}: Data (X.121)\\
{{3}}: Telex (F.69)\\
{{6}}: Land Mobile (E.212)\\
{{8}}: National\\
{{9}}: Private\\
{{10}}: ERMES\\
{{13}}: Internet (IP)\\
{{18}}: WAP Client Id (to be defined by WAP Forum)|
| {{CamelSmppRegisteredDelivery}} | {{Byte}} | *only for DataSm* Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.  |
| {{CamelSmppDestAddrNpi}} | {{Byte}} | *only for DataSm* Defines the numeric plan indicator (NPI) in the destination address parameters. Same values as in Producer header list above. |
| {{CamelSmppDestAddrTon}} | {{Byte}} | *only for DataSm* Defines the type of number (TON) in the destination address parameters. TheSame following TON values are defined:\\
{{0}}: Unknown\\
{{1}}: International\\
{{2}}: National\\
{{3}}: Network Specific\\
{{4}}: Subscriber Number\\
{{5}}: Alphanumeric\\
{{6}}: Abbreviated as in Producer header list above. |
| {{CamelSmppMessageType}} | {{String}} | *Camel 2.6 onwartsonwards*: Identifies the type of an incoming message:\\
{{AlertNotification}}: an SMSC alert notification\\
{{DataSm}}: an SMSC data short message\\
{{DeliveryReceipt}}: an SMSC delivery receipt\\
{{DeliverSm}}: an SMSC deliver short message |
{div}

{tip:title=JSMPP library}
See the documentation of the [JSMPP Library|http://code.google.com/p/jsmpp/] for more details about the underlying library.
{tip}


h3. Exception handling
This component supports the general Camel exception handling capabilities.
*Camel 2.8 onwartsonwards*: When the SMPP consumer receives a {{DeliverSm}} or {{DataSm}} short message and the processing of these messages fails, you can also throw a {{ProcessRequestException}} instead of handle the failure. In this case, this exception is forwarded to the underlying [JSMPP library|http://code.google.com/p/jsmpp/] which will return the included error code to the SMSC. This feature is useful to e.g. instruct the SMSC to resend the short message at a later time. This could be done with the following lines of code:
{code:java}
from("smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer")
  .doTry()
    .to("bean:dao?method=updateSmsState")
  .doCatch(Exception.class)
    .throwException(new ProcessRequestException("update of sms state failed", 100))
  .end();
{code}

Please refer to the [SMPP specification|http://smsforum.net/SMPP_v3_4_Issue1_2.zip] for the complete list of error codes and their meanings.

h3. Samples

A route which sends an SMS using the Java DSL:
{code}
from("direct:start")
  .to("smpp://smppclient@localhost:2775?
      password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=producer");
{code}

A route which sends an SMS using the Spring XML DSL:
{code:xml}
<route>
  <from uri="direct:start"/>
  <to uri="smpp://smppclient@localhost:2775?
           password=password&amp;enquireLinkTimer=3000&amp;transactionTimer=5000&amp;systemType=producer"/>
</route>
{code}

A route which receives an SMS using the Java DSL:
{code}
from("smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer")
  .to("bean:foo");
{code}

A route which receives an SMS using the Spring XML DSL:
{code:xml}
  <route>
     <from uri="smpp://smppclient@localhost:2775?
                password=password&amp;enquireLinkTimer=3000&amp;transactionTimer=5000&amp;systemType=consumer"/>
     <to uri="bean:foo"/>
  </route>
{code}

{tip:title=SMSC simulator}
If you need an SMSC simulator for your test, you can use the simulator provided by [Logica|http://opensmpp.logica.com/CommonPart/Download/download2.html#simulator].
{tip}

h3. Debug logging

This component has log level *DEBUG*, which can be helpful in debugging problems. If you use log4j, you can add the following line to your configuration:
{code}
log4j.logger.org.apache.camel.component.smpp=DEBUG
{code}


{include:Endpoint See Also}