URI Format and options - 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
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. 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&..., where option can be:

Table 20. 

Name

Default Value

Description

password

password

Specifies the password to use to log into 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).

alphabet

0

Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0 : SMSC Default Alphabet 4 : 8 bit Alphabet 8 : UCS2 Alphabet

encoding

ISO-8859-1

Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti.

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 (that is, 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 and 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 URI options listed 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 URI options listed above.

priorityFlag

1

Only for SubmitSm, 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, 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. Same as the sourceAddrTon URI options listed above.

numberingPlanIndicator

0

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

lazySessionCreationfalseSessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Starting with Camel 2.11, Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use this information to connect to the SMSC.
httpProxyHostnullIf you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy.
httpProxyPort3128If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
httpProxyUsernamenullIf your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
httpProxyPasswordnullIf your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
sessionStateListenernullYou can refer to a org.jsmpp. session. SessionStateListener in the Registry to receive callbacks when the session state changed.
addressRangenullStarting with 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, for example:

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