Configuring SMPP - Stonesoft

StoneGate SSL VPN Technical Note 2084 

Configuring SMPP

Table of Contents 

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 

Configuring SMPP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 8 

Feedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 8 

Table of Contents 2

Introduction 

This technical note describes how to configure the short message peer-to-peer protocol (SMPP) for use with 

StoneGate SSL VPN. 

This technical note assumes a thorough understanding of StoneGate SSL VPN administration and SMPP. Use the 

further reading to gain the required knowledge. 

Further Reading 

More information on StoneGate SSL VPN administration can be found in the StoneGate SSL VPN Administrator’s 

Guide, the Online Help, and the Technical Note repository provided with the product. Another source of information 

is the Stonesoft Support site, which can be found at http://www.stonesoft.com/support/. 

For more information on related subjects, visit http://smsforum.net. 

Overview 

The short message peer-to-peer protocol (SMPP) is a telecommunications industry protocol for exchanging SMS 

messages between SMS peer entities such as short message service centres. It is often used to allow third parties 

(e.g. value-added service providers like news organizations) to submit messages, often in bulk. 

SMPP was originally designed by Aldiscon, a small Irish company that was later bought by Logica. In 1999, SMPP 

was formally handed over to the SMPP Developers Forum, later renamed as The SMS Forum. 

The protocol is based on pairs of request/response PDUs (protocol data units, or packets) exchanged over OSI 

layer 4 (TCP/IP session or X.25 SVC3) connections. PDUs are binary encoded for efficiency. 

The most commonly used versions of SMPP are v3.3, the most widely supported standard, and v3.4, which adds 

transceiver support (single connections that can send and receive messages). Data exchange may be synchronous, 

where each peer must wait for a response for each PDU being sent, and asynchronous, where receiving and 

transmitting go in independent threads with the use of buffers and timers. The latest version of SMPP is v5.0. 

StoneGate SSL VPN currently supports v3.4. 

Configuring SMPP 

The SMPP parameters are configured by adding Additional Configuration in “Manage System/Notification 

Settings/SMS Channel”. Click “Add Additional Configuration…” for the SMS channel and insert the key name 

and appropriate value from the table below or as supplied by your SMS provider. 

Table 1 below lists relevant SMPP keys that can be used to configure your StoneGate SSL VPN setup. Table 2 on 

page 6 contains error codes. 

TABLE 1 SMPP Keys 

Key 

Used at 

Possible 

Values 

Default 

Value 

Description 

smpp-version 

Bind 

51 – 3.3 

52 – 3.4 

51 

This parameter is used to indicate the version of the SMPP 

protocol. The following interface version values are defined, 0- 

51 (0x00-0x33) Indicates that the EMSE supports version 3.3 

or earlier of the SMPP protocol. 52 (0x34) Indicates that the 

ESME is supporting SMPP version 3.4 

smpp-timeout Connect Integer 10000 

Timeout used when trying to communicate with SMPP server. 

Defined in milliseconds. 

Introduction 3

TABLE 1 SMPP Keys (Continued) 

Key 

Used at 

Possible 

Values 

Default 

Value 

Description 

smpp-bindsystem-type 

Bind 

String 

The system_type parameter is used to categorize the type of 

ESME that is binding to the SMSC. Examples include “VMS” 

(voice mail system) and “OTA” (over-the-air activation system). 

Specification of the system_type is optional - some SMSCs 

may not require ESMEs to provide this detail. In this case, the 

ESME can set the system_type to NULL. 

smpp-bindaddr-ton 

Bind 

0 – Unknown 

1 – International 

2 – National 

3 – Network 

Specific 

4 – Subscriber 

Number 

5 – 

Alphanumeric 

6 - Abbreviated 

0 

Indicates Type of Number of the ESME address. If not known 

set to Unknown. 

smpp-bindaddr-npi 

Bind 

0 – Unknown 

1 – ISDN 

3 – Data 

4 – Telex 

6 – Land Mobile 


9 – Private 

10 – ERMES 

14 – Internet 

18 – WAP Client 

Id 

0 

Numbering Plan Indicator for ESME address. If not known set 

to Unknown. 

smpp-submitservice-type 

Submit 

String 

The service_type parameter can be used to indicate the SMS 

Application service associated with the message. “” (NULL) 

Default, “CMT” Cellular Messaging, “CPT” Cellular Paging, 

“VMN” Voice Mail Notification, “VMA” Voice Mail Alerting, 

“WAP” Wireless Application Protocol, “USSD” Unstructured 

Supplementary Services Data 

smpp-submitdest-addr-ton 

Submit 

0 – Unknown 



3 – Network 

Specific 


Number 

5 – 

Alphanumeric 


1 Destination Address TON. Type of Number for destination. 

Configuring SMPP 4


Key 

Used at 

Possible 

Values 

Default 

Value 

Description 

smpp-submitdest-addr-npi 

Submit 

0 – Unknown 

1 – ISDN 

3 – Data 

4 – Telex 



9 – Private 

10 – ERMES 



Id 

0 

Destination Address NPI. Numbering Plan Indicator for 

destination. 

smpp-submitesm-class 

smpp-submitprotocol-id 

Submit Integer 0 


The esm_class parameter is used to indicate special 

message attributes associated with the short message. 

GSM: Set according to GSM 03.40 [GSM 03.40], ANSI-136 

(TDMA): For mobile terminated messages, this field is not 

used and is therefore ignored by the SMSC. For ANSI-136 

mobile originated messages, the SMSC should set this value 

to NULL. IS-95 (CDMA): For mobile terminated messages, this 

field is not used and is therefore ignored by the SMSC. For IS- 

95 mobile originated messages, the SMSC should set this 

value to NULL. 

smpp-submitsource-addrton 

Submit 

0 – Unknown 



3 – Network 

Specific 


Number 

5 – 

Alphanumeric 


0 

Source Address TON. Type of Number for source address. If 

not known, set to 0 (Unknown). 

smpp-submitsource-addrnpi 

Submit 

0 – Unknown 

1 – ISDN 

3 – Data 

4 – Telex 



9 – Private 

10 – ERMES 



Id 

0 

Source Address NPI. Numbering Plan Indicator for source 

address. If not known, set to 0 (Unknown). 

smpp-submitsource-addr 

Submit 

Specifies the address of SME which originated this message. 

An ESME which is implemented as a single SME address, may 

set this field to NULL to allow the SMSC to default the source 

address of the submitted message. 



Key 

Used at 

Possible 

Values 

Default 

Value 

Description 

smpp-submitdata-coding 

smpp-submitdata-charset 


Submit String ISO8859-1 

Encoding of data according the SMPP 3.4 specification, 

section 5.2.19. Example data encodings are “SMSC Default 

Alphabet” (0), IA5/ASCII (1), Octet unspecified (2), Latin 1/ 

ISO-8859-1 (3), Cyrllic/ISO-8859-5 (6), Latin/Hebrew/ISO- 

8859-8 (7). 

Character set to use in conjunction with Data Coding when 

converting from Unicode to output format. 

TABLE 2 SMPP Error Codes 

Error Error Code Description 

ESME_ROK 0x00000000 No Error 

ESME_RINVMSGLEN 0x00000001 Message Length is invalid 

ESME_RINVCMDLEN 0x00000002 Command Length is invalid 

ESME_RINVCMDID 0x00000003 Invalid Command ID 

ESME_RINVBNDSTS 0x00000004 Incorrect BIND Status for given command 

ESME_RALYBND 0x00000005 ESME Already in Bound State 

ESME_RINVPRTFLG 0x00000006 Invalid Priority Flag 

ESME_RINVREGDLVFLG 0x00000007 Invalid Registered Delivery Flag 

ESME_RSYSERR 0x00000008 System Error 

Reserved 0x00000009 Reserved 

ESME_RINVSRCADR 0x0000000A Invalid Source Address 

ESME_RINVDSTADR 0x0000000B Invalid Dest Addr 

ESME_RINVMSGID 0x0000000C Message ID is invalid 

ESME_RBINDFAIL 0x0000000D Bind Failed 

ESME_RINVPASWD 0x0000000E Invalid Password 

ESME_RINVSYSID 0x0000000F Invalid System ID 


ESME_RCANCELFAIL 0x00000011 Cancel SM Failed 


ESME_RREPLACEFAIL 0x00000013 Replace SM Failed 

ESME_RMSGQFUL 0x00000014 Message Queue Full 

ESME_RINVSERTYP 0x00000015 Invalid Service Type 

Reserved 0x00000016-0x00000032 Reserved 

ESME_RINVNUMDESTS 0x00000033 Invalid number of destinations 


TABLE 2 SMPP Error Codes (Continued) 


ESME_RINVDLNAME 0x00000034 Invalid Distribution List name 

Reserved 0x00000035-0x0000003F Reserved 

ESME_RINVDESTFLAG 0x00000040 Destination flag is invalid (submit_multi) 


ESME_RINVSUBREP 

0x00000042 

Invalid ‘submit with replace’ request (i.e. 

submit_sm with replace_if_present_flag set) 

ESME_RINVESMCLASS 0x00000043 Invalid esm_class field data 

ESME_RCNTSUBDL 0x00000044 Cannot Submit to Distribution List 

ESME_RSUBMITFAIL 0x00000045 submit_sm or submit_multi failed 


ESME_RINVSRCTON 0x00000048 Invalid Source address TON 

ESME_RINVSRCNPI 0x00000049 Invalid Source address NPI 

ESME_RINVDSTTON 0x00000050 Invalid Destination address TON 

ESME_RINVDSTNPI 0x00000051 Invalid Destination address NPI 


ESME_RINVSYSTYP 0x00000053 Invalid system_type field 

ESME_RINVREPFLAG 0x00000054 Invalid replace_if_present flag 

ESME_RINVNUMMSGS 0x00000055 Invalid number of messages 


ESME_RTHROTTLED 

0x00000058 

Throttling error (ESME has exceeded allowed 

message limits) 


ESME_RINVSCHED 0x00000061 Invalid Scheduled Delivery Time 

ESME_RINVEXPIRY 0x00000062 Invalid message validity period (Expiry time) 

ESME_RINVDFTMSGID 0x00000063 Predefined Message Invalid or Not Found 

ESME_RX_T_APPN 0x00000064 ESME Receiver Temporary App Error Code 

ESME_RX_P_APPN 0x00000065 ESME Receiver Permanent App Error Code 

ESME_RX_R_APPN 0x00000066 ESME Receiver Reject Message Error Code 

ESME_RQUERYFAIL 0x00000067 query_sm request failed 

Reserved 0x00000068-0x000000BF Reserved 

ESME_RINVOPTPARSTREAM 0x000000C0 Error in the optional part of the PDU Body. 

ESME_ROPTPARNOTALLWD 0x000000C1 Optional Parameter not allowed 

ESME_RINVPARLEN 0x000000C2 Invalid Parameter Length. 

ESME_RMISSINGOPTPARAM 0x000000C3 Expected Optional Parameter missing 


TABLE 2 SMPP Error Codes (Continued) 


ESME_RINVOPTPARAMVAL 0x000000C4 Invalid Optional Parameter Value 

Reserved 0x000000C5-0x000000FD Reserved 

ESME_RDELIVERYFAILURE 0x000000FE Delivery Failure (used for data_sm_resp) 

ESME_RUNKNOWNERR 0x000000FF Unknown Error 

Reserved for SMPP extension 0x00000100-0x000003FF Reserved for SMPP extension 

Reserved for SMSC vendor specific errors 0x00000400-0x000004FF Reserved for SMSC vendor specific errors 

Reserved 0x00000500-0xFFFFFFFF Reserved 

Troubleshooting 

To see what packets are sent to and received from the SMPP gateway, enable debug logging (Monitor System/ 

Logging/Manage Global Logging Settings…/Enable debug logging) and search the debug log for “SMPP”. 

When an error occurs during communication the System log may echo something like: “SMPP command failed with 

error code 0xd”. The error codes are explained in the SMPP Error Codes table above. 

Feedback 

Stonesoft is always interested in feedback from our users. 

• For comments regarding Stonesoft’s products, contact feedback@stonesoft.com. 

• For comments regarding this technical note, contact documentation@stonesoft.com. 

Troubleshooting 8

Trademarks and Patents 

Stonesoft, the Stonesoft logo and StoneGate are all trademarks or registered trademarks of Stonesoft Corporation. Multi-link 

technology, multi-link VPN, and the StoneGate clustering technology-as well as other technologies included in StoneGate-are protected 

by patents or pending patent applications in the U.S. and other countries. All other trademarks or registered trademarks 

are property of their respective owners. 

SSL VPN Powered by PortWise 

Copyright and Disclaimer 

Copyright © 2000–2007 Stonesoft Corporation. All rights reserved. 

These materials, Stonesoft products and related documentation are protected by copyright and other laws, international treaties 

and conventions. All rights, title and interest in the materials, Stonesoft products and related documentation shall remain with 

Stonesoft and its licensors. All registered or unregistered trademarks in these materials are the sole property of their respective 

owners. No part of this document or related Stonesoft products may be reproduced in any form, or by any means without written 

authorization of Stonesoft Corporation. 

Stonesoft provides these materials for informational purposes only. They are subject to change without notice and do not represent 

a commitment on the part of Stonesoft. Stonesoft assumes no liability for any errors or inaccuracies that may appear in 

these materials or for incompatibility between different hardware components, required BIOS settings, NIC drivers, or any NIC 

configuration issues. Use these materials at your own risk. Stonesoft does not warrant or endorse any third party products 

described herein. 

THESE MATERIALS ARE PROVIDED "AS-IS." STONESOFT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO, THE INFORMA- 

TION CONTAINED HEREIN. IN ADDITION, STONESOFT MAKES NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR 

FITNESS FOR A PARTICULAR PURPOSE OR USE WITH RESPECT THE INFORMATION CONTAINED IN THESE MATERIALS. 

IN NO EVENT SHALL STONESOFT BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL OR INCIDENTAL DAMAGES, INCLUD- 

ING, BUT NOT LIMITED TO, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING FROM THE USE OF THESE MATERIALS, EVEN 

IF ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES. 

SG_SVTN_2084_20070625 

www.stonesoft.com 

Stonesoft Corp. 

Itälahdenkatu 22a 

FIN-00210 Helsinki 

Finland 

tel. +358 9 4767 11 

fax +358 9 4767 1234 

Stonesoft Inc. 

1050 Crown Pointe Parkway 

Suite 900 

Atlanta, GA 30338 USA 

tel. +1 770 668 1125 

fax +1 770 668 1131 

9

Configuring SMPP - Stonesoft

Create successful ePaper yourself

Delete template?

Save as template?