SMPP Protocol Providers

The following table describes the settings for SMPP Protocol Providers.

Note: xMatters supports SMPP version 3.4 only.
SMPP Provider Details

Setting

Description

Name

Name of the protocol provider.

Description

A brief description of the provider (optional).

Maximum Retries

Number of times to resend a notification before potentially using an alternate service provider; allowable values are from 0 to 10.

Retry interval

Amount of time in seconds to wait between retries.

Maximum session size

Number of notifications per connection/session.

Split long message

Controls whether notifications that exceed the number of characters specified by the Split size setting are split into multiple smaller messages or sent as a single message.

Split size

Determines the maximum number of characters per message sent to this Protocol Provider. This setting applies only if the Split long message check box is selected.

If you are using the SAR concatenation method, refer to the "SAR Split Size" note following this table for more information about this setting.

Maximum message length

If enforced by this provider, the maximum number of characters allowed per notification. For more information, see Setting Maximum Message Length.

Maximum PIN length

If enforced by this provider, the maximum number of characters allowed in a PIN. If the PIN is longer than the maximum PIN length, the leading characters are truncated.

Split Method

Specifies the concatenation mechanism used by the provider when splitting and reassembling long SMS messages. With concatenation, it is possible to send a single long message to a mobile station as a series of several short messages, and to display them as one message on the target Device.

Concatenation is performed at the Device itself, which uses additional information fields within the messages to identify, sort, and join the content into a single message. Up to a maximum of 255 short messages (of less than 160 characters each) can be joined in this way. xMatters provides two methods of concatenating messages: GSM User Data Headers (UDH) and SMPP Segmentation and Reassembly (SAR).

Select one of the following options:

  • None: do not specify a concatenation method.
  • Message Payload: deliver long messages using a separate parameter (message_payload) that supports up to 64K worth of characters. This method does not split and reassemble the message.
  • SAR: split messages using SAR concatenation. See the "SAR Split Size" note following this table for more information about this setting.
  • UDH: split messages using UDH concatenation.
Important Deployment Considerations

While xMatters supports these protocols, it has no control over how carriers and aggregators handle the requests. You will have to work closely with your carriers to establish the appropriate handling, and then thoroughly test your deployment and message delivery to ensure that you have accounted for the different methods used by your required providers to handle long SMS messages.

Note also that some CDMA Devices cannot receive messages longer than 160 characters. In most cases, no warnings or errors are returned, but the SMS aggregator never delivers the messages to the Device. Be sure to check your deployment for CDMA-compatibility before configuring your long message settings.

Supports New Line

Indicates whether the Protocol Provider supports new line characters (line breaks).

Short Code Compliance

Select an option to specify when xMatters should send a notification explaining terms of service to each SMS Device:

  • None: xMatters will not send a notification to the Device when it is added, modified, or activated.
  • Send Welcome: xMatters will send a Welcome notification to an SMS Device when it is added, modified, or activated. (The content of this message is defined in the SMSCONFIRMMSG Constant.)
  • Send Custom: xMatters will send a Custom notification to an SMS Device when it is added, modified, or activated. (The content of this message is defined in the SMSFIRSTMMSG Constant.)
  • Send Welcome and Custom: Sends both the Welcome and the Custom messages.

In addition to modifying the content of the Custom message, you can modify its behavior and other properties using the xMatters scripts. For example, you could extend the functionality of the Custom message to include a validation request, and then select the "Send Welcome and Custom" option. Whenever a User added a new Device, xMatters would send a Welcome message containing the standard terms and conditions, and then automatically send a validation request to the Device three seconds later.

Note that specific content for these messages may be required by local regulations or your SMS provider; for more information about specifying their content, see SMS Confirmation and First Alert Messages Constants.

After changing this value, you must restart any Device Engines using this Protocol Provider for the changes to be applied.

Source Address

Number associated with your SMPP account. This number is used to indicate the sender for outgoing messages. If specified, this value will override the Device Engine setting.

Source Address TON

Your SMPP account’s TON to be used during the server session. If specified, this value will override the Device Engine setting.

Source Address NPI

Client’s NPI required by your service provider for the source address. If specified, this value will override the Device Engine setting.

Prepend + to Dest

Indicates whether to add a plus symbol (+) to the beginning of each phone number sent to the SMPP engine.

This feature is available only on deployments where all text phone Devices were created after 4.1 patch 006 or later. If you have text phone Devices that were added prior to applying the required patch, you must either delete the Devices (which will automatically enable this feature) or work with xMatters Support to reconfigure your existing Devices.

Default Dest Address TON

TON required by your service provider for the default destination address. If specified, this value will override the Device Engine setting.

Default Dest Address NPI

NPI required by your service provider for the default destination address. If specified, this value will override the Device Engine setting.

Dest Address Subunit

Specifies where to store the message on the target Device (e.g., in a SIM card).

Deactivation Error Codes

A comma-separated list of error codes that indicate a Device has been delisted or deactivated by its service provider. If one of these codes is returned from the Protocol Provider, xMatters will deactivate the targeted Device and, based on the selected option in the Notifiy Upon Deactivation drop-down list, notify the User and their supervisors.

For more information about configuring this feature, see Configuring automatic SMS Device deactivation.

Notify Upon Deactivation

Specifies who should be notified when a Device has been marked as delisted or deactivated by its service provider; select one of the following:

  • Supervisors and Device Owners: (default) notifies the User who owns the Device, their direct supervisors, and the supervisor of any Groups to which the User belongs.
  • Device Owners: notifies only the User (or Users) who owns the Device.
  • Supervisors: notifies the direct supervisors and Group Supervisors for the User who owns the Device.
  • Do Not Notify: does not send notifications.

Note that the notification will automatically be sent to the User or supervisor's email Device; if the recipient does not have an email Device, the notification is sent to their default Device.

Add New Tag/Value Pair

Allows you to define optional tag/value pairs that can be used to sort messages. For example, “XYZ Marketing”, “XYZ Sales”, “XYZ Data_Center”.

When adding a new tag/value pair, select one of the following types:

  • C-String: any character string; e.g., "Billing Department"
  • Octets: any string in hex format; e.g., "233A4500112F" or "0A"
  • Integer: any integer between -2147483648 and 2147483647
  • Short: any integer between -32768 and 32767
  • Byte: any two characters in hex mode; e.g., "1A", "00", or "0C".

Country-Specific Overrides

You can set country-specific overrides for the Protocol Provider's Source Address, Source Address TON and Source Address NPI settings. If a country override exists that matches the country specified for a User's text phone Device details, the Protocol Provider will use the source address overrides.

To add a new country override, click Add New Country, and select the country for which you want to configure the override from the Country drop-down list. Select the Short Code Compliance check box if you want to send a welcome notification to Users whose Devices match the specified country. (Note that this setting takes precedence over the Protocol Provider setting.)

Set the Source Address, Source TON, and Source NPI you want to use. You do not need to enter information into all of the fields; if a field is left blank, the override will use the default settings configured for the Protocol Provider.

You can also specify a separate address to which recipients should send their responses. If you specify an address in the Reply To field, the response portion of the SMS message includes "Send reply to <address>." Note that this does not override or affect the original source of the message; it provides a visual reminder to the recipient that they should respond to a different address.

Note: This feature requires that you have configured simple SMS replies, as described in Configuring simple SMS replies.

This feature is available only on deployments where all text phone Devices were created after 4.1 patch 006 or later. If you have text phone Devices that were added prior to applying the required patch, you must either delete the Devices (which will automatically enable this feature) or work with xMatters Support to reconfigure your existing Devices.

SAR Split Size

The SAR split mechanism for SMPP requires that the actual message size be smaller than the pre-configured size (i.e., the size specified in the Split Size field). The purpose of this size difference is to leave room for adding the SAR header. For example, if you configure the Split Size setting to 160, the actual split size will be smaller than 160.

The precise size difference is determined by the type of characters within the message. There are three different character types: 7 bits for ASCII and GSM, 8 bits for western Europe, and 16 bits for the rest of the world. The size specified in the Split Size field is for 7-bit characters.

For example, if the Split Size field is set to 160: