Sprint SNPP Gateway Manual

Sprint SNPP
Gateway Manual
Confidential
Version: 1.13
Version Control Information:
Version

Date

Author

Changes

1.0

11- Feb - 2009

Mikhail Grinfeld

First draft

1.1

13- Mar 2009

Mikhail Grinfeld/
Liona Goldberg

Update Level 3 Commands

1.2

18- Jul 2009

Ofer Dangoor

General formatting

1.3

21-Jan-2010

Ofer Dangoor

Update messages per session

1.4

16-Feb-2010

Ofer Dangoor

PAGEr format

1.5

23-Feb-2010

Andy Klassman

Remove Test Server details

1.6

3-Mar-2010

Andy Klassman

Update Authentication details

1.7

9-Mar-2010

Andy Klassman

Update format of receiver address

1.8

31-Mar-2010

Ofer Dangoor

Handling of Multi Choice Response Commands

1.9

31-Mar-2010

Ofer Dangoor

Add IP only Authentication

1.10

24-May-2010

Ofer Dangoor

2-way PAGEr response

1.11

15-Jun-2010

Andy Klassman

Update SNPP server address

1.12

20-Aug-2010

Andy Klassman

Remove IP only Authentication

1.13

07-Sep-2010

Andy Klassman

Update MSTA responses

P AG E 0 O F 9

Sprint SNPP Gateway Manual

Table of Contents
1.

INTRODUCTION .................................................................................................................. 2
A.
B.
C.
D.

2.

PURPOSE ....................................................................................................................... 2
OBJECTIVE OF THIS DOCUMENT ........................................................................................ 2
GLOSSARY...................................................................................................................... 3
REFERENCES .................................................................................................................. 3
CONNECTING TO THE SERVICE ....................................................................................... 4

A.
1)
2)
B.
C.
3.

BASIC CONNECTIVITY PARAMETERS .................................................................................. 4

Accounts data ............................................................................................................ 4
Authentication details ................................................................................................. 4
SUPPORTED COMMANDS .................................................................................................. 5
CONNECTION TERMINATION .............................................................................................. 7

CONTACT INFORMATION .................................................................................................. 8

P AG E 1 O F 9

Sprint SNPP Gateway Manual

1. Introduction
A. Purpose
The attached document should help understand the needs and method to
deliver wireless messages through the Sprint SNPP interface. The SNPP
server allows clients to deliver both one-way and two-way messages to
appropriate receiving devices over the internet.
This document assumes a level of familiarity with SNPP functionality, and
follows the RFC1861 specification.
For further assistance please contact your sales/project manager.

B. Objective of this Document

This document is meant to outline the technical connectivity requirements for
sending wireless messages from the service provider/mobile operator to the
Sprint system. This connectivity is used for receiving wireless messages from
the network to the Sprint system.
The connection settings explained here are based on connectivity using the
SNPP protocol.
Please note that connectivity using other protocols is possible as well - for
further assistance please contact your sales/project manager.

P AG E 2 O F 9

Sprint SNPP Gateway Manual

C. Glossary
Name

Value

SNPP

Simple Network Paging Protocol

TCP

Transmission Control Protocol

D. References
Document Name

Version

Link

RFC1861 - Simple
Network Paging
Protocol

Version 3- TwoWay Enhanced

http://www.faqs.org/rfcs/rfc1861.html

P AG E 3 O F 9

Sprint SNPP Gateway Manual

2. Connecting to the Service

A. Basic Connectivity Parameters
1) Accounts data
Sprint will be the Server (Receiver) side. The client should post his messages
to the following addresses:
Item

Type

Address

Port

Production

Receiver 1
Receiver 2

snpp.messaging.sprint.com
64.28.80.123

444
444

2) Authentication details
The sender may choose to use the following methods for authentication:

Restriction based on User Name of the sender

Restriction based on User Name and IP range of the sender

Restriction based on User name, Password and IP range of the sender

The authentication method will be configured during the customer registration

to the system.
Data Required
Authentication based on User Name
User Name
Authentication based on User Name
and IP
User Name
Allowed IP Range
Authentication based on User Name,
Password and IP
User Name
Password
Allowed IP Range

Operator Information
YES/NO
To be provided by Sprint
YES/NO
To be provided by Sprint
To be provided by the client
YES/NO
To be provided by Sprint
To be provided by Sprint
To be provided by the client

P AG E 4 O F 9

Sprint SNPP Gateway Manual

B. Supported commands
The SNPP protocol includes a sequence of commands and replies available
on three levels:

Level 1 - Used to submit messages

Level 2 - Used to submit messages and receive acknowledgement

receipts,

Level 3 - Includes support for enhanced customization of message

submission and receipt acknowledgements.

The following commands are supported by the SNPP server:

Command

Functionality

Responses

Level 1
PAGEr <Pager ID>

MESSage <Alpha or
Numeric Message>
RESEt

Submits a pager ID (PID)

number. International
phone number format is
expected. i.e 17816089886
Specifies a single-line
message
Clears already entered
information

SEND

QUIT

Finalizes the current

message transaction
Terminates the current
session

250, "Pager ID Accepted"

550, "Error, Invalid Pager ID (International
phone number format is expected)"
250, "Successful Transaction"
503, "ERROR, Message Already Entered"
250, "RESEt successfully"
250, "Message sent successfully"
554, "Message failed. No recipients to send"
554, "Message failed"
550, "Delivery Failed!"
221, "OK"

Level 1 - Optional
HELP

Return a list of supported

commands

214, [Help Text] (repeated for each line)

250, "End of Help Information"

Allowing for multiple line

delivery (instead
MESSage)

354, "Begin Input; End with <CRLF>'.'<CRLF>"

503, "ERROR, Message Already Entered"

Level 2
DATA

Level 2 - Optional Extensions

LOGIn <loginid>
[password]
HOLDuntil
<YYMMDDHHMMSS>
[+/-GMTdifference]

Allows for a session login

ID to be specified

250, "Login Accepted"

250, "You are already logged in."
550, "Error login. Try again."

Allows for the delayed

delivery of a message

250, "Successful Transaction"

550, "Error, Invalid Delivery Date/Time"

Specification of the Caller

Identifier

250, "Successful Transaction"

550, " Error, Invalid Caller ID"
554, "Error, failed (technical reason)"

CALLerid <CallerID>

P AG E 5 O F 9

Sprint SNPP Gateway Manual

SUBJect
<MessageSubject>

Specify a subject for the

next message

250, "Successful Transaction"

Level 3 - Two-Way Extensions

2WAY

PAGEr

Places the server in the

mode to receive and
process a single 2-way
transaction
Changes the default expiry
time for a queued message
delivery
Used for 2-way mode.
International phone number
format is expected. i.e
17816089886

SEND

Used for 2-way mode

MSTAtus
<Message_Tag>
<Pass_Code>

Used by the client program

to periodically check the
status of delivery and
response of a given
message

EXPTag <hours>

250, "OK, Beginning 2-Way Transaction"

250, "Message Expiry Time Changed"
550, "Cannot Change Expiry Time"
850, "Pager ID Accepted"
550, "Error, Invalid Pager ID (International
phone number format is expected)"
960, <messageId> <messageKey> " OK,
Message QUEUED for Delivery"
554, "Message failed."
250, "End of status or reply"
550, "Unknown or Illegal Message_Tag or
Pass_Code"
550, "Message_Tag and Pass_Code required"
550, "Unknown or Illegal Message_Tag or
Pass_Code"
550, No active statuses or replies for this
message
554, Error, failed (technical reason)
780, No providers for destination (Message
delivery failed)
780, SMS delivery failed (Provider Response
Invalid to Number)
860, SMS successfully sent
881, SMS was delivered to handset
889, <Sequence> <Date&Time>
<Full_Text_Response>
960, Message re-scheduled by the system

General error responses

Timeout reached
Exceeded number of
allowed transactions
Server is busy
Service Unavailable
Unknown command
User not logged
Unexpected error

P AG E 6 O F 9

421, "Timeout reached (terminate connection)"

421, "Exceeded number of allowed transactions"
421, "Service is busy!"
421, "Gateway Service Unavailable (terminate
connection)"
500, "Command Not Implemented"
550, "You need to login first"
554, "Error, failed (technical reason)"

Sprint SNPP Gateway Manual

The response for the following Multi-Choice Response commands will be 250
although they are not supported. The commands are accepted and choice
text will be appended to the end of the message text.
Command
RTYPe
MCREsponse

Functionality
Changes the type of reply
expected from the field
message unit.
Issued prior to the SEND
command, and "seeds" the
transaction with an
acceptable multiple choice
response.

Responses
250, "OK"

250, "OK"

C. Connection termination
There are several possible events that will cause termination:

The client posts the QUIT command

I/O timeout no command was posted during 30 seconds

Overall session timeout maximum of 30 minutes per session

Exceeded number of sent messages - maximum of 300 messages

allowed per session

Exceeded number of login attempts

P AG E 7 O F 9

Sprint SNPP Gateway Manual

3. Contact information
Data Required
Enterprise Name

Operator Information
To be provided by the client

Business Contact
Data Required
Business Contact Name
Business Contact Phone Number
Business Contact E-mail Address

Operator Information
To be provided by the client
To be provided by the client
To be provided by the client

Technical Contact
Data Required
Technical Contact Name
Technical Contact Phone Number
Technical Contact E-mail Address

Operator Information
To be provided by the client
To be provided by the client
To be provided by the client

P AG E 8 O F 9