Producer Message Headers - 6.3

Talend ESB Mediation Developer Guide

EnrichVersion
6.3
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend ESB

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. For mobile terminated messages, this is the directory number of the recipient MS.

CamelSmppDestAddrTon

Byte

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

CamelSmppSourceAddrNpi

Byte

Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Same as the sourceAddrNpi URI options listed above.

CamelSmppServiceType

String

The service type parameter can be used to indicate the SMS Application service associated with the message. Same as the serviceType URI options listed above.

CamelSmppRegistered Delivery

Byte

Only for SubmitSm, SubmitMulti, CancelSm and DataSm. Same as the registeredDelivery URI options listed above.

CamelSmppPriorityFlag

Byte

Only for SubmitSm and SubmitMulti. Same as the priorityFlag URI options listed above.

CamelSmppSchedule DeliveryTime

Date

Only for SubmitSm, SubmitMulti, 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. 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.

CamelSmppReplace IfPresentFlag

Byte

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

Only for SubmitSm, SubmitMulti and ReplaceSm. Same as the alphabet URI options listed 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

String or List<String>

the id to identify the submitted short message for later use (delivery receipt, query sm, cancel sm, replace sm). In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header vaule is a List<String>.

CamelSmppSent MessageCountIntegerFor SubmitSm and SubmitMultiSm only - the total number of messages which has been sent.
CamelSmppErrorMap<String, List<Map<String, Object>>>For SubmitMultiSm only - The errors which occurred by sending the short message(s) the form Map<String, List<Map<String, Object>>>}} (messageID : (destAddr : address, error : errorCode)).
CamelSmppOptionalParametersMap<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.

CamelSmppOptionalParameterMap<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.Optional

Parameter.COctetString -> String

org.jsmpp.bean.Optional

Parameter.OctetString -> byte[]

org.jsmpp.bean.Optional

Parameter.Byte -> Byte

org.jsmpp.bean.Optional

Parameter.Int -> Integer

org.jsmpp.bean.Optional

Parameter.Short -> Short

org.jsmpp.bean.Optional

Parameter.Null -> null