Vendor-specific optional parameters (TLVs)
Only the vendor-specific optional parameters listed in the PDU details are supported – any other TLV will be ignored (so sending unsupported TLVs will not break the SMSC).
Client Message ID
Read more here.
This is a message ID defined by the ESME for message tracking. Up to 32 characters are allowed, anything longer will cause the parameter to be ignored. It will be returned to the ESME in the delivery receipt (if enabled via registered_delivery).
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1401 (5121 decimal) |
Length |
2 |
Integer |
Must be 0x0002 to 0x0021 (2 – 33 decimal) |
Value |
Variable |
C-Octet String |
The value must be NULL-terminated, hence the minimum length is 2 (1 character + 1 NULL octet) and the maximum length is 33 (32 characters + 1 NULL octet). |
Gateway Escalation
Read more here.
Prompts an escalation to an alternative (more expensive) route if messages are queued or delayed on the least-cost routes.
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1402 (5122 decimal) |
Length |
2 |
Integer |
Must be 0x0001 (1 decimal) |
Value |
1 |
Integer |
0 – Off |
Delivery Queue
Read more here.
Delivers the message through one of three queues assigned to each client account. Messages in the highest priority queue will be delivered first.
Field |
Size Octets |
Type |
Description |
Parameter tag |
2 |
Integer |
Always 0x1403 (5123 decimal) |
Length |
2 |
Integer |
Must be 0x0001 (1 decimal) |
Value |
1 |
Integer |
1 – Highest priority queue (fastest delivery). 2 – Medium priority queue. 3 – Lowest priority queue (slowest delivery). Any other value will use the lowest priority queue. |
Maximum Credits
Read more here.
This parameter can be used to limit the cost of a message. It overrides the maximum charge associated with message delivery as set by the routing profiles selected within the ESME’s Developers’ Central account.
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1404 (5124 decimal) |
Length |
2 |
Integer |
Must be 0x0002 to 0x000B (2 – 11 decimal) |
Value |
Variable |
C-Octet String |
Typical values are “0.8”, “1”, “1.5”, “2”, “2.5” and “3”. However, any decimal string within the size limitation is valid, e.g. “1.750000”. |
Mobile Originated
Read more here.
This is only applicable to clients that have subscribed to a two-way messaging service. We route via a pre-defined carrier to enable replies to be received.
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1405 (5125 decimal) |
Length |
2 |
Integer |
Must be 0x0001 (1 decimal) |
Value |
1 |
Integer |
0 – Off |
Required Features
Some parameters and features are not set as “required” by default and may be dropped if the least-cost route does not support them. Set this parameter to ensure that the features set when an SMS is sent are supported by the gateway used. If no route is available that supports all the required features, then the message will not be sent (the ESME will receive a failed delivery receipt if requested in the submit_sm PDU).
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1406 (5126 decimal) |
Length |
2 |
Integer |
Must be 0x0004 (4 decimal) |
Value |
4 |
Bitmask |
See below which bits are used. |
Bit Position |
Bit Hex |
Bit Decimal |
Description |
---|---|---|---|
0 |
0x00000001 |
1 |
Text – set automatically for plain text messages |
1 |
0x00000002 |
2 |
8-bit messaging – set automatically for binary messages |
2 |
0x00000004 |
4 |
UDH (Binary) – set automatically when any UDH is specified |
3 |
0x00000008 |
8 |
UCS2 / Unicode – set automatically for Unicode messages |
4 |
0x00000010 |
16 |
Alphanumeric source address |
5 |
0x00000020 |
32 |
Numeric source address |
9 |
0x00000200 |
512 |
Flash messaging (set as part of message class in data_coding parameter) |
14 |
0x00004000 |
16384 |
Concatenation (set automatically when specifying concatenation in the UDH or when using the sar parameters) |
Linked MT Message ID
If MT message linking is enabled on the ESME’s two-way setup, this parameter will contain the 32 alphanumeric character message ID of the original MT message that an MO message is in reply to.
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x1407 (5127 decimal) |
Length |
2 |
Integer |
Always 0x0021 (33 decimal) |
Value |
33 |
C-Octet String |
NULL-terminated 32 alphanumeric characters. |
MO Keyword
By default, if the ESME is using a keyword two-way service, the destination address field will contain the ESME’s two-way number and the keyword, separated by the colon ‘:’ character, e.g. “35050:sport”.
If the ESME would prefer to receive the two-way number and keyword separately, it can be enabled on the ESME’s two-way setup, in which case the destination_addr field will only contain the two-way number, and the MO keyword TLV will contain the keyword.
Field |
Size Octets |
Type |
Description |
Parameter tag |
2 |
Integer |
Always 0x1408 (5128 decimal) |
Length |
2 |
Integer |
Will be 0x0002 to 0x001A (2 – 26 decimal) |
Value |
Variable |
C-Octet String |
The value will be NULL-terminated, hence the minimum length is 2 (1 character + 1 NULL octet) and the maximum length is 36 (25 characters for the keyword + 1 NULL octet). |
MO Message ID
A unique 32 alphanumeric character string to identify the message at the SMSC. This message ID can be used when contacting support if there are any issues regarding the message.
Field |
Size Octets |
Type |
Description |
Parameter tag |
2 |
Integer |
Always 0x1409 (5129 decimal) |
Length |
2 |
Integer |
Always 0x0021 (33 decimal) |
Value |
33 |
C-Octet String |
NULL-terminated 32 alphanumeric characters. |
Network
The ID of the mobile network operator (MNO) that the handset belongs to. The parameter will only be specified if the feature is enabled on the ESME’s account (for DLRs) or on the ESME’s two-way setup (for MO messages).
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x140A (5130 decimal) |
Length |
2 |
Integer |
Always 0x0004 (4 decimal) |
Value |
4 |
Integer |
The SMSC’s network ID value. Please contact support to get a list of network IDs and their corresponding country and network names. |
Bypass DNC Check
This parameter is used to bypass the destination country’s “Do Not Contact/Disturb” list check if the message content allows for such a check to be bypassed. This is country dependent, but usually transactional messages do not need to be checked while marketing-related messages must be checked.
Field |
Size Octets |
Type |
Description |
---|---|---|---|
Parameter tag |
2 |
Integer |
Always 0x140C (5132 decimal) |
Length |
2 |
Integer |
Must be 0x0001 (1 decimal) |
Value |
1 |
Integer |
0 – Do not bypass DNC check 1 – Bypass DNC check |
Submit a Comment
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have