SMPP-S Messages

Introduction

The SMPP Application uses SMPP-S-... messages to communicate with other applications (such as the LogicApp) to handle inbound SMPP requests received from an external SMPP entity.

The following applications from the core n2svcd module send SMPP-S-... messages to the SMPP Application:

The following LuaApp agents from the core n2svcd module send SMPP-S-... messages to the SMPP Application:

The internal SMPP-S-... messages are:

SMPP-S-REQUEST

The SMPP-S-REQUEST message is sent by the SMPP Application to the application that is configured for handling of inbound SMPP requests.

Refer to the SMPP Application Configuration documentation for more information on configuring application parameters.

The attributes of the SMPP-S-REQUEST message are:

Attribute Type Description
smpp Object [Always Present] Container for the parameters of the SMPP request that were received.
.bytes Object [Always Present] The raw received SMPP request bytes.
.pdu String [Always Present] The name of the SMPP operation received, either submit_sm or deliver_sm.
.connection Object [Always Present] Container for information about the network element that sent the SMPP operation.
.far_system_id String [Always Present] The SMPP system_id of the network element that sent the SMPP operation.
.remote_host String [Always Present] The remote IP address from where the SMPP operation was sent.
.remote_port Integer [Always Present] The remote IP port from where the SMPP operation was sent.
.command_id Integer [Always Present] The SMPP header command_id for the received operation.
.sequence_number Integer [Always Present] The SMPP header sequence_number for the received operation.
.fields Object [Always Present] Container for the fields received in the SMPP operation.
.service_type String [Always Present] The SMS Application service associated with the message.
.source_addr_ton Integer [Always Present] The type of number for the source address of the message. Possible values are:
  • 0 - Unknown
  • 1 - International
  • 2 - National
  • 3 - Network Specific
  • 4 - Subscriber Number
  • 5 - Alphanumeric
  • 6 - Abbreviated
.source_addr_npi Integer [Always Present] The numbering plan for the source address of the message. Possible values are:
  • 0 - Unknown
  • 1 - ISDN (E163/E164)
  • 3 - Data (X.121)
  • 4 - Telex (F.69)
  • 6 - Land Mobile (E.212)
  • 8 - National
  • 9 - Private
  • 10 - ERMES
  • 14 - Internet (IP)
  • 18 - WAP Client Id
.source_addr String [Always Present] Address of the SME from which the message originated.
.dest_addr_ton Integer [Always Present] The type of number for the destination address of the message. Possible values are as for the source_addr_ton parameter.
.dest_addr_npi Integer [Always Present] The numbering plan for the destination address of the message. Possible values are as for the source_addr_npi parameter.
.destination_addr String [Always Present] Destination address of the short message.
.esm_class Integer [Always Present] Bitmask to indicate special message parameters in the range 0..255. Refer to the SMPP standard for details of the bitmask format.
.protocol_id Integer [Always Present] Bitmask to indicate higher-level network protocol in the range 0..255. Refer to information on the TP-Protocol-Identifier parameter in GSM 03.30 for details of the bitmask format.
.priority_flag Integer [Always Present] The priority of the short message. Possible values (for GSM / ANSI-136 / IS-95 respectively) are:
  • 0 - Level 0 (lowest) priority (Non-priority / Bulk / Normal)
  • 1 - Level 1 priority (Priority / Normal / Interactive)
  • 2 - Level 2 priority (Priority / Urgent / Urgent)
  • 3 - Level 3 (highest) priority (Priority / Very Urgent / Emergency)
.schedule_delivery_time String [Always Present] The scheduled delivery time of the short message, in Absolute or Relative time format, as per SMPP 3.4 specification section 7.1.1.
.validity_period String [Always Present] The validity period of the short message, in Absolute or Relative time format, as per SMPP 3.4 specification section 7.1.1.
.registered_delivery Integer [Always Present] Bitmask to indicate the SMSC delivery receipt mode in the range 0..16. Refer to the SMPP standard for details of the bitmask format.
.replace_if_present_flag Integer [Always Present] Whether to replace (1) an existing message or not (0).
.flash Integer [Always Present] Set to 1 if the received message class should be treated as a flash message (i.e. display without storage), otherwise 0 for normal messages. Refer to the Inbound Flash Message Decoding configuration documentation for details on how this flag is inferred.
.data_coding Integer [Always Present] The data coding value received for the message, used automatically to set the decoded short_message_text.
.sm_default_msg_id Integer [Always Present] The identifier for a per-SMSC prebuilt message in the range 1..254.
.short_message Binary String [Always Present] The encoded bytes of message content received as binary data. The decoded message content is returned in the short_message_text field.
.short_message_text String [Always Present] The decoded message text. This may be taken from the body short_message parameter or the TLV payload, depending on which field was populated in the received message.
.tlvs Object Container for the TLVs received in the SMPP operation. Only present if TLVs were received.
(numeric TLV tag value) String or Integer A tag-value pair. For each TLV received in the message, one instance will be present in the tlvs object.
.udh Object Container for the userdata header received in the SMPP operation. Only present if a userdata header was received.
.message_identifier Integer [Always Present] The message identifier from the userdata header.
.total_message_parts Integer [Always Present] The total number of messages for the userdata header message identifier.
.current_message_part Integer [Always Present] The message number for the current message from the userdata header.

SMPP-S-RESPONSE

The SMPP-S-RESPONSE message is sent back to the SMPP Application by the handling application when it is ready to send an SMPP response for the original received SMPP request.

The attributes of the SMPP-S-RESPONSE message are:

Field Type Description
success 0/1 [Required] Indicates if the request was successful (1) or not (0). If not successful, no response will be sent to the network entity.
error String Indicates the reason why the request failed. Only present if success is 0.
smpp Object [Required] Container for the SMPP response parameters received. Present only if success is 1.
.command_status String [Required] The SMPP command_status to return to the network entity. Refer to the SMPP specification for possible values.
.fields String [Required] Container for the fields of the SMPP response to send.
.message_id String The generated message ID to return.

All other attributes of the SMPP response are determined automatically by the SMPP Application.