SMPP Gateway Interface Programming Guide
SMPP Gateway Interface Programming Guide
devCentral Document
This document and the information contained herein (collectively, the "Information") is provided to you (both the individual receiving
this document and any legal entity on behalf of which such individual is acting) ("You" and "Your") by AT&T, on behalf of itself and
its affiliates ("AT&T") for informational purposes only. AT&T is providing the Information to You because AT&T believes the
Information may be useful to You. The Information is provided to You solely on the basis that You will be responsible for making
Your own assessments of the Information and are advised to verify all representations, statements and information before using or
relying upon any of the Information. Although AT&T has exercised reasonable care in providing the Information to You, AT&T does
not warrant the accuracy of the Information and is not responsible for any damages arising from Your use of or reliance upon the
Information. You further understand and agree that AT&T in no way represents, and You in no way rely on a belief, that AT&T is
providing the Information in accordance with any standard or service (routine, customary or otherwise) related to the consulting,
services, hardware or software industries.
AT&T DOES NOT WARRANT THAT THE INFORMATION IS ERROR-FREE. AT&T IS PROVIDING THE INFORMATION TO YOU
"AS IS" AND "WITH ALL FAULTS." AT&T DOES NOT WARRANT, BY VIRTUE OF THIS DOCUMENT, OR BY ANY COURSE OF
PERFORMANCE, COURSE OF DEALING, USAGE OF TRADE OR ANY COLLATERAL DOCUMENT HEREUNDER OR
OTHERWISE, AND HEREBY EXPRESSLY DISCLAIMS, ANY REPRESENTATION OR WARRANTY OF ANY KIND WITH
RESPECT TO THE INFORMATION, INCLUDING, WITHOUT LIMITATION, ANY REPRESENTATION OR WARRANTY OF
DESIGN, PERFORMANCE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, OR
ANY REPRESENTATION OR WARRANTY THAT THE INFORMATION IS APPLICABLE TO OR INTEROPERABLE WITH ANY
SYSTEM, DATA, HARDWARE OR SOFTWARE OF ANY KIND. AT&T DISCLAIMS AND IN NO EVENT SHALL BE LIABLE FOR
ANY LOSSES OR DAMAGES OF ANY KIND, WHETHER DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, PUNITIVE,
SPECIAL OR EXEMPLARY, INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION, LOSS OF BUSINESS INFORMATION, LOSS OF GOODWILL, COVER, TORTIOUS CONDUCT OR OTHER
PECUNIARY LOSS, ARISING OUT OF OR IN ANY WAY RELATED TO THE PROVISION, NON-PROVISION, USE OR NON-USE
OF THE INFORMATION, EVEN IF AT&T HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSSES OR DAMAGES.
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 ii
Revision History
All marks, trademarks, and product names used in this document are the property of their respective owners.
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 iii
Table of Contents
1. Introduction ............................................................................................................................................. 1
1.1 Contact Information ...................................................................................................................... 1
1.2 Resources ..................................................................................................................................... 1
1.2.1 AT&T Resources.............................................................................................................. 1
1.2.2 Other Resources .............................................................................................................. 1
1.3 Terms and Acronyms.................................................................................................................... 1
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 iv
Guide for ESME SMPP
Connections to the
AT&T SMS Network
1. Introduction
The purpose of this document is to specify the requirements and information for
External Short Message Entities ESMEs connecting to the AT&T SMS network.
All ESMEs are required to pass AT&T SMPP certification prior to connecting to
the wireless AT&T production network. The purpose of this testing is to ensure
an ESME’s implementation of SMPP meets the AT&T requirements.
Note: AT&T uses PDU formats from the SMPP 3.4 specifications. The
ESME must accept the response in the SMPP 3.4 format. This is
discussed in Sections 2.3 and 2.4.
1.2 Resources
Short Message Peer-to-Peer Protocol Specification 3.4
AT&T SMPP Gateway Certification Test Plan
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 1
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 2
Guide for ESME SMPP
Connections to the
AT&T SMS Network
2. ESME Requirements
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 3
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 4
Guide for ESME SMPP
Connections to the
AT&T SMS Network
2.3 Binding
Bind Credentials AT&T will provide a system_ID, system_type, and a
password.
Address_range Unless otherwise instructed by AT&T Engineers the
address_range field in the bind request PDU should be null.
Establishing A connection must have been established and an
ESME SMPP authenticated Tx, Rx bind request must be successfully
Connection acknowledged before short messages can be exchanged.
Connection It is the ESME’s responsibility to ensure their binds are
Management connected at all times. It is not acceptable for ESMEs to only
bind in when they have MT traffic to send.
AT&T will not alarm on loss of binds; it is the ESME’s
responsibility to recognize broken connections and resolve
them.
Excessive bind/unbinds per day is not acceptable. The ESME
is required to implement sound bind management methods,
typically by using IP session monitoring and the Enquire_Link
PDU.
Enquire_link PDU The Enquire_link and Enquire_Link_Resp messages are used
to maintain confidence in the connections. Connections that
do not respond to Enquire_Link PDUs must be deemed
unreliable and dropped. The ESME must immediately
respond to the Enquire_Link message from the MA with an
Enquire_Link_Resp. The MA uses a one-minute inactivity
timer; when there is no activity for one minute on the
connection, the MA will send the Enquire_Link. If the ESME
does not respond to the Enquire_Link within 15 seconds, the
MA will drop the connection.
The ESME is required to use Enquire_Link to actively
manage their links. The MA will respond with the
Enquire_Link_Resp. If the MA does not respond with the
Enquire_Link_Resp within 15 seconds, the ESME should
assume the connection is unreliable. The ESME is requested
to send an Unbind command before dropping the connection.
The ESME may then proceed with establishing a new session
and bind.
Terminating ESME When the ESME needs to terminate communications with the
SMPP Connection SMSC, it should issue an Unbind request prior to dropping the
IP session. This enables the SMSC to terminate
communications in an orderly fashion. Otherwise, the AT&T
SMS gateway may take up to 5 minutes to determine that the
bind is gone. Attempts to rebind during this time will result in
the Bind Failed error (x0D)
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 5
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 6
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 7
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 8
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 9
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 10
Guide for ESME SMPP
Connections to the
AT&T SMS Network
MO rate The AT&T SMS network does not limit the rate of MO
messages that it sends to ESMEs, therefore it is possible for
an ESME to receive a burst of MO in a very short period of
time. The ESME application should be designed to
accommodate this.
Deliver_sm_resp ESMEs should respond to deliver_sm messages with in 1
second.
TON and NPI The source and destination TON and NPI values may change
values depending on the network the MO originated on. The ESME
should accept any value.
Source Address The source address will be an AT&T MDN with either a 10
digit or 1+ 10 digit format. ESME applications should accept
either format interchangeably.
Service Type The service_type value may be populated in the deliver_sm
message. The ESME is advised to ignore this value.
Optional Deliver_sm PDUs may include optional parameters. In some
Parameters cases these optional parameters are attached by the MA. If
these are objectionable, then please contact AT&T SMS
Engineering and they can arrange to block the optional
parameters (note: this will completely block all usage of the
optional parameters).
Deliver_sm_resp The ESME is expected to accept all deliver_sm PDU with no
error codes. However, if the ESME is having technical
difficulties such as congestion, they may respond with the
temporary error (x64).
Deliver_sm_resp The deliver_sm_resp sequence_number must correspond to
sequence_number the sequence_number used in the deliver_sm PDU.
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 11
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 12
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 13
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 14
Guide for ESME SMPP
Connections to the
AT&T SMS Network
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 15
Guide for ESME SMPP
Connections to the
AT&T SMS Network
3. Aggregator Requirements
An aggregator is any ESME that accepts messages from third parties for delivery
to the AT&T SMS network. It is the responsibility of the aggregator to ensure that
all messages sent to AT&T meet all the requirements listed in the document.
Store and forward The aggregator must provide a store and forward ability to
MO and MT queue and manage all the traffic to and from all of their
messages
clients.
The Aggregator must accept and store MO messages if their
client is not available. AT&T will discard all rejected MO
messages.
The aggregator will forward MT messages from its clients to
AT&T. If the message is rejected with a temporary error, it
must store the message and retry per AT&T requirements.
Transmission rate The aggregator must control the maximum rate for
and throttling transmitting MT messages to AT&T. If there is a throttle error,
the 15-second pause requirement still applies.
Submit_sm_resp The client should not receive any temporary error codes nor
with error codes control the retrying of temporary errors.
If AT&T rejects the MT with a permanent error, it is
acceptable for the Aggregator to return this error code to the
client. However, the Aggregator is responsible for ensuring
the client does not attempt to retry.
SMPP headers Ensure the SMPP message headers meet all AT&T
requirements and do not cause errors. Each submit_sm must
follow the requirements listed in this document.
Client trouble Provide trouble management to their clients. Under no
management circumstance should the Aggregator’s clients contact AT&T.
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 16
Guide for ESME SMPP
Connections to the
AT&T SMS Network
4. Binary Messages
Binary messages are prohibited from transmission across AT&T’s wireless
network, unless specifically authorized by AT&T in writing. Unauthorized binary
messages will be discarded by AT&T without notice to Customer or End User.
AT&T Proprietary
The information contained here is for use by authorized
person only and is not for general distribution
devCentral Document
14975 Rev. 5.0 17