From commits-return-29510-apmail-camel-commits-archive=camel.apache.org@camel.apache.org  Sun Aug 25 14:33:02 2013
Return-Path: 
X-Original-To: apmail-camel-commits-archive@www.apache.org
Delivered-To: apmail-camel-commits-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 9255E10A0A
	for ; Sun, 25 Aug 2013 14:33:02 +0000 (UTC)
Received: (qmail 18246 invoked by uid 500); 25 Aug 2013 14:33:01 -0000
Delivered-To: apmail-camel-commits-archive@camel.apache.org
Received: (qmail 18162 invoked by uid 500); 25 Aug 2013 14:33:01 -0000
Mailing-List: contact commits-help@camel.apache.org; run by ezmlm
Precedence: bulk
List-Help: 
List-Unsubscribe: 
List-Post: 
List-Id: 
Reply-To: dev@camel.apache.org
Delivered-To: mailing list commits@camel.apache.org
Received: (qmail 18122 invoked by uid 99); 25 Aug 2013 14:33:00 -0000
Received: from cwiki-vm.apache.org (HELO cwiki-vm) (140.211.11.69)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 25 Aug 2013 14:33:00 +0000
Received: from cwiki-vm (localhost [127.0.0.1])
	by cwiki-vm (Postfix) with ESMTP id 74386A2630
	for ; Sun, 25 Aug 2013 14:33:00 +0000 (UTC)
Date: Sun, 25 Aug 2013 14:33:00 +0000 (UTC)
From: "Christian Mueller (Confluence)" 
To: commits@camel.apache.org
Message-ID: <1452918663.10389.1377441180028.JavaMail.confluence@cwiki-vm>
Subject: [CONF] Apache Camel > SMPP
MIME-Version: 1.0
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: 7bit
Auto-Submitted: auto-generated

    SMPP
    Page edited by             Christian Mueller

                         Changes (1)

            ...

            | {{CamelSmppOptionalParameters}} | {{Map<String, String>}} | *Deprecated and will be removed in Camel 2.13.0/3.0.0*\\ 
*From Camel 2.11.1 onwards only for DataSm* The optional parameters which are returned from the SMSC by sending the message. | 

            | {{CamelSmppOptionalParameter}} | {{Map<Short, Object>}} | *From Camel 2.10.7, 2.11.2 onwards only for DataSm* The optional parameter which are returned from the SMSC by sending the message. The key is the {{Short}} code for the optional parameter. The value is converted in the following way: 

            {{org.jsmpp.bean.OptionalParameter.COctetString}} -> {{String}}\\ 
{{org.jsmpp.bean.OptionalParameter.OctetString}} -> {{byte[]}}\\ 

            ...

                            Full Content

        SMPP Component
Available as of Camel 2.2

This component provides access to an SMSC (Short Message Service Center) over the SMPP protocol to send and receive SMS. The 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:

<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>

URI format

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

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&...

URI Options

 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.11 Defines the data coding according the SMPP 3.4 specification, section 5.2.19. (Prior to Camel 2.9, this option is also supported.) Example data encodings are:

0: SMSC Default Alphabet

3: Latin 1 (ISO-8859-1)

4: Octet unspecified (8-bit binary)

8: UCS2 (ISO/IEC-10646)

13: Extended Kanji JIS(X 0212-1990)

 alphabet 
 0 
 Camel 2.5 Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. This option is mapped to Alphabet.java and used to create the byte[] which is send to the SMSC. Example alphabets are:

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. Same as the sourceAddrTon values defined above.

 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. Same as the sourceAddrNpi values defined above.

 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. Use the sourceAddrTon values defined above. 

 numberingPlanIndicator 
 0 
 Defines the numeric plan indicator (NPI) to be used in the SME. Use the sourceAddrNpi values defined above.

 lazySessionCreation 
 false 
 Camel 2.8 onwards Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started.

Camel 2.11 onwards Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC. 

 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. 

 sessionStateListener 
 null 
 Camel 2.9.3: You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. 

 addressRange 
 "" 
 Camel 2.11: You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range. 

You can have as many of these options as you like.

smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer

Producer Message Headers

The following message headers can be used to affect the behavior of the SMPP producer

 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. Use the sourceAddrTon URI option values defined above. 

 CamelSmppDestAddrNpi 
 Byte 
 only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above.

 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. Use the sourceAddrTon URI option values defined above. 

 CamelSmppSourceAddrNpi 
 Byte 
 Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.

 CamelSmppServiceType 
 String 
 The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above.

 CamelSmppRegisteredDelivery 
 Byte 
 only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. 

 CamelSmppPriorityFlag 
 Byte 
 only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.

 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 onwards: 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 

 CamelSmppAlphabet / CamelSmppDataCoding 
 Byte 
 Camel 2.5 For SubmitSm, SubmitMulti and ReplaceSm (Prior to Camel 2.9 use CamelSmppDataCoding instead of CamelSmppAlphabet.) The data coding according to the SMPP 3.4 specification, section 5.2.19.  Use the URI option alphabet settings above. 

 CamelSmppOptionalParameters 
 Map<String, String> 
 Deprecated and will be removed in Camel 2.13.0/3.0.0

Camel 2.10.5 and 2.11.1 onwards and only for SubmitSm, SubmitMulti and DataSm The optional parameters send back by the SMSC. 

 CamelSmppOptionalParameter 
 Map<Short, Object> 
 Camel 2.10.7 and 2.11.2 onwards and only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way:

String -> org.jsmpp.bean.OptionalParameter.COctetString

byte[] -> org.jsmpp.bean.OptionalParameter.OctetString

Byte -> org.jsmpp.bean.OptionalParameter.Byte

Integer -> org.jsmpp.bean.OptionalParameter.Int

Short -> org.jsmpp.bean.OptionalParameter.Short

null -> org.jsmpp.bean.OptionalParameter.Null 

The following message headers are used by the SMPP producer to set the response from the SMSC in the message header

 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 onwards 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 onwards 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)). 

 CamelSmppOptionalParameters 
 Map<String, String> 
 Deprecated and will be removed in Camel 2.13.0/3.0.0

From Camel 2.11.1 onwards only for DataSm The optional parameters which are returned from the SMSC by sending the message. 

 CamelSmppOptionalParameter 
 Map<Short, Object> 
 From Camel 2.10.7, 2.11.2 onwards only for DataSm The optional parameter which are returned from the SMSC by sending the message. The key is the Short code for the optional parameter. The value is converted in the following way:

org.jsmpp.bean.OptionalParameter.COctetString -> String

org.jsmpp.bean.OptionalParameter.OctetString -> byte[]

org.jsmpp.bean.OptionalParameter.Byte -> Byte

org.jsmpp.bean.OptionalParameter.Int -> Integer

org.jsmpp.bean.OptionalParameter.Short -> Short

org.jsmpp.bean.OptionalParameter.Null -> null 

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

 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. Use the URI option sourceAddrNpi values defined above.

 CamelSmppSourceAddrTon 
 Byte 
 only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. 

 CamelSmppEsmeAddr 
 String 
 only for AlertNotification Defines the 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. Use the URI option sourceAddrNpi values defined above.

 CamelSmppEsmeAddrTon 
 Byte 
 only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above. 

 CamelSmppId 
 String 
 only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted. 

 CamelSmppDelivered 
 Integer 
 only for smsc DeliveryReceipt Number of short messages delivered. This is only 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. 

 CamelSmppFinalStatus 
 DeliveryReceiptState 
 only for smsc DeliveryReceipt: The final 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 
 only for DataSm The Command status of the message. 

 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 DeliveryReceipt The time and date at which the short message was submitted. In 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. 

 CamelSmppSubmitted 
 Integer 
 only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if 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. 

 CamelSmppScheduleDeliveryTime 
 String 
 only for DeliverSm: 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 Section 7.1.1. in the smpp specification v3.4. 

 CamelSmppValidityPeriod 
 String 
 only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which 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. Same values as in Producer header list above.  

 CamelSmppDestAddrNpi 
 Byte 
 only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.

 CamelSmppDestAddrTon 
 Byte 
 only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above. 

 CamelSmppMessageType 
 String 
 Camel 2.6 onwards: 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 

 CamelSmppOptionalParameters 
 Map<String, Object> 
 Deprecated and will be removed in Camel 2.13.0/3.0.0

Camel 2.10.5 onwards and only for DeliverSm The optional parameters send back by the SMSC. 

 CamelSmppOptionalParameter 
 Map<Short, Object> 
 Camel 2.10.7, 2.11.2 onwards and only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way:

org.jsmpp.bean.OptionalParameter.COctetString -> String

org.jsmpp.bean.OptionalParameter.OctetString -> byte[]

org.jsmpp.bean.OptionalParameter.Byte -> Byte

org.jsmpp.bean.OptionalParameter.Int -> Integer

org.jsmpp.bean.OptionalParameter.Short -> Short

org.jsmpp.bean.OptionalParameter.Null -> null 

JSMPP library
See the documentation of the JSMPP Library for more details about the underlying library.

Exception handling
This component supports the general Camel exception handling capabilities.

Camel 2.8 onwards: 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 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:

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();

Please refer to the SMPP specification for the complete list of error codes and their meanings.

Samples

A route which sends an SMS using the Java DSL:

from("direct:start")
  .to("smpp://smppclient@localhost:2775?
      password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=producer");

A route which sends an SMS using the Spring XML DSL:

<route>
  <from uri="direct:start"/>
  <to uri="smpp://smppclient@localhost:2775?
           password=password&amp;enquireLinkTimer=3000&amp;transactionTimer=5000&amp;systemType=producer"/>
</route>

A route which receives an SMS using the Java DSL:

from("smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer")
  .to("bean:foo");

A route which receives an SMS using the Spring XML DSL:

  <route>
     <from uri="smpp://smppclient@localhost:2775?
                password=password&amp;enquireLinkTimer=3000&amp;transactionTimer=5000&amp;systemType=consumer"/>
     <to uri="bean:foo"/>
  </route>

SMSC simulator
If you need an SMSC simulator for your test, you can use the simulator provided by Logica.

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:

log4j.logger.org.apache.camel.component.smpp=DEBUG

See Also

	Configuring Camel
	Component
	Endpoint
	Getting Started

                        Stop watching space
            |
                Change email notification preferences

        View Online
        |
        View Changes
                |
        Add Comment

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.11 Defines the data coding according the SMPP 3.4 specification, section 5.2.19. (Prior to Camel 2.9, this option is also supported.) Example data encodings are: `0`: SMSC Default Alphabet `3`: Latin 1 (ISO-8859-1) `4`: Octet unspecified (8-bit binary) `8`: UCS2 (ISO/IEC-10646) `13`: Extended Kanji JIS(X 0212-1990)
`alphabet`	`0`	Camel 2.5 Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. This option is mapped to `Alphabet.java` and used to create the `byte[]` which is send to the SMSC. Example alphabets are: `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. Same as the `sourceAddrTon` values defined above.
`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. Same as the `sourceAddrNpi` values defined above.
`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. Use the `sourceAddrTon` values defined above.
`numberingPlanIndicator`	`0`	Defines the numeric plan indicator (NPI) to be used in the SME. Use the `sourceAddrNpi` values defined above.
`lazySessionCreation`	`false`	Camel 2.8 onwards Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel 2.11 onwards Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC.
`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.
`sessionStateListener`	`null`	Camel 2.9.3: You can refer to a `org.jsmpp.session.SessionStateListener` in the `Registry` to receive callbacks when the session state changed.
`addressRange`	`""`	Camel 2.11: You can specify the address range for the `SmppConsumer` as defined in section 5.2.7 of the SMPP 3.4 specification. The `SmppConsumer` will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range.

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. Use the `sourceAddrTon` URI option values defined above.
`CamelSmppDestAddrNpi`	`Byte`	only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option `sourceAddrNpi` values defined above.
`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. Use the `sourceAddrTon` URI option values defined above.
`CamelSmppSourceAddrNpi`	`Byte`	Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option `sourceAddrNpi` values defined above.
`CamelSmppServiceType`	`String`	The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option `serviceType` settings above.
`CamelSmppRegisteredDelivery`	`Byte`	only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option `registeredDelivery` settings above.
`CamelSmppPriorityFlag`	`Byte`	only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option `priorityFlag` settings above.
`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 onwards: 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
`CamelSmppAlphabet` / `CamelSmppDataCoding`	`Byte`	Camel 2.5 For SubmitSm, SubmitMulti and ReplaceSm (Prior to Camel 2.9 use `CamelSmppDataCoding` instead of `CamelSmppAlphabet`.) The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option `alphabet` settings above.
`CamelSmppOptionalParameters`	`Map<String, String>`	Deprecated and will be removed in Camel 2.13.0/3.0.0 Camel 2.10.5 and 2.11.1 onwards and only for SubmitSm, SubmitMulti and DataSm The optional parameters send back by the SMSC.
`CamelSmppOptionalParameter`	`Map<Short, Object>`	Camel 2.10.7 and 2.11.2 onwards and only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: `String` -> `org.jsmpp.bean.OptionalParameter.COctetString` `byte[]` -> `org.jsmpp.bean.OptionalParameter.OctetString` `Byte` -> `org.jsmpp.bean.OptionalParameter.Byte` `Integer` -> `org.jsmpp.bean.OptionalParameter.Int` `Short` -> `org.jsmpp.bean.OptionalParameter.Short` `null` -> `org.jsmpp.bean.OptionalParameter.Null`

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 onwards 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 onwards 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)).
`CamelSmppOptionalParameters`	`Map<String, String>`	Deprecated and will be removed in Camel 2.13.0/3.0.0 From Camel 2.11.1 onwards only for DataSm The optional parameters which are returned from the SMSC by sending the message.
`CamelSmppOptionalParameter`	`Map<Short, Object>`	From Camel 2.10.7, 2.11.2 onwards only for DataSm The optional parameter which are returned from the SMSC by sending the message. The key is the `Short` code for the optional parameter. The value is converted in the following way: `org.jsmpp.bean.OptionalParameter.COctetString` -> `String` `org.jsmpp.bean.OptionalParameter.OctetString` -> `byte[]` `org.jsmpp.bean.OptionalParameter.Byte` -> `Byte` `org.jsmpp.bean.OptionalParameter.Int` -> `Integer` `org.jsmpp.bean.OptionalParameter.Short` -> `Short` `org.jsmpp.bean.OptionalParameter.Null` -> `null`

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. Use the URI option `sourceAddrNpi` values defined above.
`CamelSmppSourceAddrTon`	`Byte`	only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the `sourceAddrTon` URI option values defined above.
`CamelSmppEsmeAddr`	`String`	only for AlertNotification Defines the 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. Use the URI option `sourceAddrNpi` values defined above.
`CamelSmppEsmeAddrTon`	`Byte`	only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the `sourceAddrTon` URI option values defined above.
`CamelSmppId`	`String`	only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.
`CamelSmppDelivered`	`Integer`	only for smsc DeliveryReceipt Number of short messages delivered. This is only 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.
`CamelSmppFinalStatus`	`DeliveryReceiptState`	only for smsc DeliveryReceipt: The final 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`	only for DataSm The Command status of the message.
`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 DeliveryReceipt The time and date at which the short message was submitted. In 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.
`CamelSmppSubmitted`	`Integer`	only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if 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.
`CamelSmppScheduleDeliveryTime`	`String`	only for DeliverSm: 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 Section 7.1.1. in the smpp specification v3.4.
`CamelSmppValidityPeriod`	`String`	only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which 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. Same values as in Producer header list above.
`CamelSmppDestAddrNpi`	`Byte`	only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option `sourceAddrNpi` values defined above.
`CamelSmppDestAddrTon`	`Byte`	only for DataSm Defines the type of number (TON) in the destination address parameters. Use the `sourceAddrTon` URI option values defined above.
`CamelSmppMessageType`	`String`	Camel 2.6 onwards: 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
`CamelSmppOptionalParameters`	`Map<String, Object>`	Deprecated and will be removed in Camel 2.13.0/3.0.0 Camel 2.10.5 onwards and only for DeliverSm The optional parameters send back by the SMSC.
`CamelSmppOptionalParameter`	`Map<Short, Object>`	Camel 2.10.7, 2.11.2 onwards and only for DeliverSm The optional parameters send back by the SMSC. The key is the `Short` code for the optional parameter. The value is converted in the following way: `org.jsmpp.bean.OptionalParameter.COctetString` -> `String` `org.jsmpp.bean.OptionalParameter.OctetString` -> `byte[]` `org.jsmpp.bean.OptionalParameter.Byte` -> `Byte` `org.jsmpp.bean.OptionalParameter.Int` -> `Integer` `org.jsmpp.bean.OptionalParameter.Short` -> `Short` `org.jsmpp.bean.OptionalParameter.Null` -> `null`