EDRs

Introduction

SMPP messages that are sent or received through the JSLEE may have EDRs created for them, if an EDR sink is configured and enabled for the JSLEE SMPP service.

In addition to the common fields written for all EDRs, EDRs generated by the SMPP service have several additional fields.

SMPP service EDRs have a type of smpp-message.

Root Additional Fields

The SMPP service may write the following additional fields to EDRs:

Field Type Presence Description
response-timestamp Timestamp Conditional Represents the time that a response to an SMPP message was sent or received. This field is only present if a response was sent to or received from the network.
msisdn String Always The normalised subscriber MSISDN. Set from the source address for SMPP deliver_sm messages and the destination address for SMPP submit_sm messages.
imsi String Conditional The subscriber IMSI. Only present if the IMSI was supplied by the network as part of an incoming SMS.
short-message-info Object Always Holds information about the short message in the fields described in Short Message Information Field.
message-template String Conditional Holds the template used to generate a short message. Not present for non-templated SMS.

Other Additional Fields

Short Message Information Field

The short message information field (key short-message-info) holds information about the short message that caused the EDR to be created. It may contain the following fields:

Field Type Presence Description
address-from Object Always Holds information about the source of the SMS in the fields described in Address Information Field.
address-to Object Always Holds information about the destination of the SMS in the fields described in Address Information Field.
direction String Always Specifies the direction of the SMS. Possible values are:
  • ORIGINATING: The record is for the originating portion of the transaction.
  • TERMINATING: The record is for the terminating portion of the transaction.
message-text String Always Holds the decoded text of the SMS.
user-data-length Integer Always Holds the length of the message text, as it is encoded in the data-coding scheme.
data-coding Object Always Holds information on the encoding used for the message text in the fields described in Data Coding Field.
msc-address String Conditional Holds the MSC address the subscriber is attached to, if provided by the network.
vlr-number String Conditional Holds the VLR number the subscriber is served by, if provided by the network.
short-message-type String Always Describes the type of message for the event. Possible values are:
  • SUBMIT: The message was sent to a subscriber.
  • DELIVER: The message was received from a subscriber.
short-message-class String Always Describes the class of message for the event. Possible values are:
  • NORMAL: The message has no special class.
  • FLASH: The message is a flash message.
short-message-id String Conditional Holds the generated message ID for the short message that was sent. Only present for oubtound messages.
short-message-sequence Integer Always Holds the SMPP sequence number for the short message.
short-message-priority Integer Always Holds the SMPP priority value ofr the short message.
status-report-requested Boolean Always Indicates whether a delivery report was requested for the message.
delivery-info Object Always Holds information about the short message delivery in the fields described in Delivery Information Field.

Address Information Field

Address information fields hold information about the short message that caused the EDR to be created. It may contain the following fields:

Field Type Presence Description
address-digits String Always Holds the normalised address information.
address-recv String Always Holds the address information as received from the network.
address-recv-type String Conditional Holds the TON received with the address-recv field, if supplied by the network. Possible values are:
  • UNKNOWN: The number type was reported as unknown.
  • INTERNATIONAL: The number type was reported as international.
  • NATIONAL: The number type was reported as national.
  • NETWORK: The number type was reported as network-specific.
  • SUBSCRIBER: The number type was reported as subscriber-specific.
  • ALPHANUMERIC: The number type was reported as alphanumeric.
  • ABBREVIATED: The number type was reported as abbreviated.
  • OTHER: The number type was not recognwased.
address-recv-plan String Conditional Holds the NPI received with the address-recv field, if supplied by the network. Possible values are:
  • UNKNOWN: The number plan was reported as unknown.
  • ISDN: The number plan was reported as ISDN.
  • DATA: The number plan was reported as data.
  • TELEX: The number plan was reported as telex.
  • LAND: The number plan was reported as land mobile.
  • NATIONAL: The number plan was reported as national.
  • PRIVATE: The number plan was reported as private
  • ERMES: The number plan was reported as ERMES.
  • INTERNET: The number plan was reported as internet protocol.
  • WAP: The number plan was reported as WAP
  • OTHER: The number plan was not recognwased.

Data Coding Field

The data coding field holds information on the encoding used for the message text. It may contain the following fields:

Field Type Presence Description
data-coding-type String Always Describes the encoding scheme used for the message text. Possible values are:
  • ASCII: The encoding used was ASCII.
  • LATIN1: The encoding used was ISO 8859 Latin alphabet No. 1.
  • GSM7: The encoding used was GSM 7-bit.
  • GSM8: The encoding used was GSM 8-bit.
  • UCS2: The encoding used was UCS-2.
data-coding-value Integer Always Holds the exact data encoding value sent or received for the message text.

Delivery Information Field

This field holds information about the short message delivery. It may contain the following fields:

Field Type Presence Description
delivery-status String Always Indicates the success or failure of the communication with the network about the message. Possible values are:
  • SUCCESS: The message was delivered successfully.
  • TRANSIENT_FAILURE: The message was not delivered due to a transient failure.
  • PERMANENT_FAILURE: The message was not delivered due to a permanent failure.
  • QUEUED: The message was queued for later delivery.
delivery-status-code Integer Always Represents the SMPP command_status sent or received for a message.
destination-service String Always The configured name for the service on the node that handled the outbound message.
destination-endpoint String Always The configured name for the service endpoint on the node that handled the outbound message.