Consumer Message Headers

Talend ESB Mediation Developer Guide

EnrichVersion
6.2
EnrichProdName
Talend ESB
task
Installation and Upgrade
Design and Development
EnrichPlatform
Talend ESB

The following message headers are used by the SMPP consumer to set the request data from the SMSC in the message header

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. Same as the sourceAddrNpi URI options listed above.

CamelSmppSourceAddrTon

only for alert notification and data sm : Defines the type of number (TON) to be used in the SME originator address parameters. Same as the sourceAddrTon URI options listed above.

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. Same as the sourceAddrNpi URI options listed above.

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: Same as the sourceAddrTon URI options listed above.

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 its 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: 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 (that is, 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

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 DataSm. Is used to request an delivery receipt and/or SME originated acknowledgements. Same as the registeredDelivery URI options listed above.

CamelSmppDestAddrNpi

Only for DataSm. Defines the numeric plan indicator (NPI) in the destination address parameters. Same as the sourceAddrNpi URI options listed above.

CamelSmppDestAddrTon

Only for DataSm. Defines the type of number (TON) in the destination address parameters. Same as the sourceAddrTon URI options listed above.

CamelSmppMessageType

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

A Map<String, Object>. Starting with Camel 2.10.5 onwards, only for DeliverSm. The optional parameters sent back by the SMSC.

Note

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