9.75.5 SMPP UDRs

The SMPP Receiver agent generates DELIVER_SM UDRs and receives DELIVER_SM_RESP UDRs, while the SMPP Transmitter agent receives SUBMIT_SM UDRs and generates SUBMIT_SM_RESP UDRs.

DELIVER_SM UDRs

The following fields are included in the DELIVER_SM UDRs:


Field
Description
data_coding (int)

This field defines the encoding scheme of the short message user data, (3) Latin-1 (ISO-8859-1), or (8), USC2 (UTF-16BE).

Note!

Even though there are several other encoding schemes defined, the mentioned schemes are the only ones currently supported by the SMPP agents.

dest_addr_npi (int)This field indicates the NPI (Numbering Plan Indicator) of the destination address.
dest_addr_ton (int)This field indicates the TON (Type Of Number) of the destination address.
destination_addr (string)This field contains the destination address.
esm_class (int)

This field is used for indicating special message attributes associated with the short message.

Note!

Currently only the messaging mode Store and Forward is supported.

priority_flag (int)This field designates the priority level of the message.
protocol_id (int)This field contains the Protocol Identifier. This is a network specific field.
registered_delivery (int)This field indicates whether an SMSC delivery receipt or an SME acknowledgement is required or not.
replace_if_present_flag (int)This field indicates whether a submitted message should replace an existing message or not.
schedule_delivery_time (string)This field defines when the short message is to be scheduled by the SMSC for delivery. Set to NULL for immediate message delivery.
sequence_number (int)This field is used for correlating responses with requests.

The allowed sequence_number range is from 0x00000001 to 0x7FFFFFFF.

service_type (string)This field can be used to indicate the SMS Application service associated with the message. Set to NULL for default SMSC settings.
short_message (bytearray)

This field contains the actual SM (Short Message) which can consist of up to 254 octets of user data.

Note!

Long messages are not supported.

sm_default_msg_id (int)If the SM is to be sent from a list of pre-defined ('canned') SMs stored on the SMSC, this field indicates the ID of the SM. If not using an SMSC canned message, set to NULL.
source_addr (string)This field contains the source address.
source_addr_npi (int)This field indicates the NPI (Numbering Plan Indicator) of the source address.
source_addr_ton (int)This field indicates the TON (Type Of Number) of the source address.
validity_period (string)This field indicates the validity period of this message. Set to NULL to request the SMSC default validity period.
OriginalData (bytearray)This field contains the original data in bytearray format.

DELIVER_SM_RESP UDRs

The following fields are included in the DELIVER_SM_RESP UDRs:


Field
Description
command_status (int)This field of an SMPP message response indicates the success or failure of an SMPP request.
OriginalData (bytearray)This field contains the original data in bytearray format.

SUBMIT_SM UDRs

The following fields are included in the SUBMIT_SM UDRs:


Field
Description
data_coding (int)

This field defines the encoding scheme of the short message user data, (3) Latin-1 (ISO-8859-1), or (8), USC2 UTF-16BE).

Note!

Even though there are several other encoding schemes defined, the mentioned schemes are the only ones currently supported by the SMPP agents.

dest_addr_npi (int)This field indicates the NPI (Numbering Plan Indicator) of the destination address.
dest_addr_ton (int)This field indicates the TON (Type Of Number) of the destination address.
destination_addr (string)This field contains the destination address.
esm_class (int)

This field is used for indicating special message attributes associated with the short message.

Note!

Currently only the messaging mode Store and Forward is supported.

priority_flag (int)This field designates the priority level of the message.
protocol_id (int)This field contains the Protocol Identifier. This is a network specific field.
registered_delivery (int)This field indicates whether an SMSC delivery receipt or an SME acknowledgement is required or not.
replace_if_present_flag (int)This field indicates whether a submitted message should replace an existing message or not.
schedule_delivery_time (string)This field defines when the short message is to be scheduled by the SMSC for delivery. Set to NULL for immediate message delivery.
service_type (string)This field can be used to indicate the SMS Application service associated with the message. Set to NULL for default SMSC settings.
short_message (bytearray)

This field contains the actual SM (Short Message) which can consist of up to 254 octets of user data.

Note!

Long messages are not supported.

sm_default_msg_id (int)If the SM is to be sent from a list of pre-defined ('canned') SMs stored on the SMSC, this field indicates the ID of the SM. If not using an SMSC canned message, set to NULL.
source_addr (string)This field contains the source address.
source_addr_npi (int)This field indicates the NPI (Numbering Plan Indicator) of the source address.
source_addr_ton (int)This field indicates the TON (Type Of Number) of the source address.
validity_period (string)This field indicates the validity period of this message. Set to NULL to request the SMSC default validity period.
OriginalData (bytearray)This field contains the original data in bytearray format.

SUBMIT_SM_RESP UDRs

The following fields are included SUBMIT_SM_RESP UDRs:


Field
Description
command_status (int)This field of an SMPP message response indicates the success or failure of an SMPP request.
message_id (string)This field contains the unique message identifier reference assigned by the SMSC to each submitted short message. It is an opaque value and is set according to SMSC implementation.
submitSmUDR (SUBMIT_SM (SMPP))his field contains the SUBMIT_SM UDR for which this SUBMIT_SM_RESP has been received.
OriginalData (bytearray)This field contains the original data in bytearray format.