...
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.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.
Code Block |
---|
smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer
|
The following message headers can be used to affect the behavior of the SMPP producer
splittingPolicy | ALLOW | Camel 2.14.1 and 2.15.0: You can specify a policy for handling long messages: - ALLOW - the default, long messages are split to 140 bytes per message
- TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered.
- REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long.
|
|
You can have as many of these options as you like.
Code Block |
---|
smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer
|
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 |
|
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. 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 destination address parameters. Use the sourceAddrTon URI option values defined above. | CamelSmppSourceAddrNpi CamelSmppDestAddrNpi
| Byte
| only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator destination address parameters. Use the URI option sourceAddrNpi values defined above. | CamelSmppServiceType 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
| 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 Integer -> org.jsmpp.bean.OptionalParameter.Int Short -> org.jsmpp.bean.OptionalParameter.Short null -> org.jsmpp.bean.OptionalParameter.Null | CamelSmppEncoding | String | Camel 2.14.1 and Camel 2.15.0 onwards and only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter encoding | CamelSmppSplittingPolicy | String | Camel 2.14.1 and Camel 2.15.0 onwards and only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter splittingPolicy |
|
The following message headers are used by the SMPP producer to set the response from the SMSC in the message header
...