Name
SMPP — provides access to an SMSC (Short Message Service Center) over the SMPP protocol
Overview
This component provides access to an SMSC (Short Message Service Center) over the SMPP protocol to send and receive SMS. The JSMPP library is used to implement the connections.
URI format
The URI scheme for an SMPP endpoint is as follows:
smpp://[username@]hostname[:port][?options] smpps://[username@]hostname[:port][?options]
If no username is provided, Apache Camel will provide the default value
smppclient.
If no port number is provided, Apache Camel will
provide the default value 2775.
If the protocol name is smpps, Apache Camel will try to use SSLSocket to
initialize a connection to the server.
Options
Table 7.11 lists the options for a SMPP endpoint.
Table 7.11. SMPP 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
|
Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. Example data encodings are:
|
encoding
| ISO-8859-1
| 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
|
Is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
The following values are defined: |
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:
|
sourceAddr
| 1616
| Defines the address of SME (Short Message Entity) which originated this message. |
destAddr
| 1717
| 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:
|
destAddrTon
| 0
|
Defines the type of number (TON) to be used in the SME destination address parameters. The following TON values are defined:
|
sourceAddrNpi
| 0
|
Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined:
|
destAddrNpi
| 0
|
Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. The following NPI values are defined:
|
priorityFlag
| 1
|
Allows the originating SME to assign a priority level to the short message. Four Priority Levels are supported:
|
replaceIfPresentFlag
| 0
|
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:
|
dataCoding
| 0
|
Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. Example data encodings are:
|
typeOfNumber
| 0
|
Defines the type of number (TON) to be used in the SME. The following TON values are defined:
|
numberingPlanIndicator
| 0
|
Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined:
|
Message headers
Table 7.12 describes the message headers that affect the behavior of the SMPP producer.
Table 7.12. SMPP producer headers
| Header | Description |
|---|---|
CamelSmppDestAddr
| Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. |
CamelSmppDestAddrTon
|
Defines the type of number (TON) to be used in the SME destination address parameters. The following TON values are defined:
|
CamelSmppDestAddrNpi
|
Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. The following NPI values are defined:
|
CamelSmppSourceAddr
| Defines the address of SME (Short Message Entity) which originated this message. |
CamelSmppSourceAddrTon
|
Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined:
|
CamelSmppSourceAddrNpi
|
Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined:
|
CamelSmppServiceType
|
The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined:
|
CamelSmppRegisteredDelivery
|
Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined:
|
CamelSmppPriorityFlag
|
Allows the originating SME to assign a priority level to the short message. Four Priority Levels are supported:
|
CamelSmppScheduleDeliveryTime
| 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
| 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 chapter 7.1.1 in the smpp specification v3.4. |
CamelSmppReplaceIfPresentFlag
|
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:
|
CamelSmppDataCoding
|
The data coding according to the SMPP 3.4 specification, section 5.2.19:
|
The following message headers are used by the SMPP producer to set the response from the SMSC in the message header
Table 7.13. SMPP headers for the SMSC
| Header | Description |
|---|---|
CamelSmppId
| the id to identify the submitted short message for later use (delivery receipt, query sm, cancel sm, replace sm). |
The following message headers are used by the SMPP consumer to set the request data from the SMSC in the message header.
Table 7.14. SMMP consumer headers
| Header | Description |
|---|---|
CamelSmppSequenceNumber
| only for alert notification, deliver sm and data sm: A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field. |
CamelSmppCommandId
| only for alert notification, deliver sm and data sm: 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
| only for alert notification, deliver sm and data sm: Defines the address of SME (Short Message Entity) which originated this message. |
CamelSmppSourceAddrNpi
|
only for alert notification and data sm: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined:
|
CamelSmppSourceAddrTon
|
only for alert notification and data sm: Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined:
|
CamelSmppEsmeAddr
| only for alert notification: Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS. |
CamelSmppEsmeAddrNpi
|
only for alert notification: Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. The following NPI values are defined:
|
CamelSmppEsmeAddrTon
|
only for alert notification: Defines the type of number (TON) to be used in the ESME originator address parameters. The following TON values are defined:
|
CamelSmppId
| only for smsc delivery receipt and data sm: The message ID allocated to the message by the SMSC when originally submitted. |
CamelSmppDelivered
| only for smsc delivery receipt: 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
| only for smsc delivery receipt: The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm. |
CamelSmppStatus
|
only for smsc delivery receipt and data sm: The final status of the message. The following values are defined:
|
CamelSmppError
| only for smsc delivery receipt: 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
| only for smsc delivery receipt: 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
| only for smsc delivery receipt: 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
| only for deliver sm and data sm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. |
CamelSmppScheduleDeliveryTime
| only for deliver sm and data sm: 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
| only for deliver sm: 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
| only for deliver sm and data sm: The service type parameter indicates the SMS Application service associated with the message. |
CamelSmppRegisteredDelivery
|
only for data sm: Is used to request an delivery
receipt and/or SME originated acknowledgements. The following values are defined:
|
CamelSmppDestAddrNpi
|
only for data sm: Defines the numeric plan
indicator (NPI) in the destination address parameters. The following NPI values are
defined: |
CamelSmppDestAddrTon
|
only for data sm: Defines the type of number (TON)
in the destination address parameters. The following TON values are defined:
|
 |  |  |
 |
