Vous êtes sur la page 1sur 9

Enterprise-Grade SMS Infrastructure Platform

SMPP Help Document

EnterpriseSMSGupShup SMPP Guide


2012 Webaroo Technology India Pvt. Ltd.
All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic,
electronic, or mechanical, including photocopying, recording, taping, or information storage and
retrieval systems - without the written permission of the publisher. Products that are referred to in
this document may be either trademarks and/or registered trademarks of the respective owners.
The publisher and the author make no claim to these trademarks. While every precaution has been
taken in the preparation of this document, the publisher and the author assume no responsibility for
errors or omissions, or for damages resulting from the use of information contained in this
document or from the use of programs and source code that may accompany it. In no event shall the
publisher and the author be liable for any loss of profit or any other commercial damage caused or
alleged to have been caused directly or indirectly by this document.
Published: January 2012

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide

Table of Content
1

Introduction .................................................................................................................................... 4

Assumptions .................................................................................................................................... 4

Setting up SMPP Connection .......................................................................................................... 4

Trouble Shooting ............................................................................................................................. 5

Error Codes ..................................................................................................................................... 5

Abbreviations .................................................................................................................................. 8

Contact Us ....................................................................................................................................... 9

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide

1 Introduction
Short Message Peer to Peer (SMPP) protocol is an open, industry standard protocol designed to
provide a flexible data communications interface for transfer of short message data. It provides a
direct connection to our gateway (also known as a bind) to enable you to send a high-volume of SMS
messages in a short space of time.
With an SMPP connection, you are continuously connected to our gateway. The standard protocol
requires no programming if you have SMPP software installed.
This is a brief guide to help you set up SMPP Client connection with SMSGupShup Enterprise SMPP
server. It also provides description of various SMPP Vendor specific error codes.

2 Assumptions
We are assuming that you are using a standard SMPP Client for connection.

3 Setting up SMPP Connection


We require the following details to set up SMPP Connection.
Mandatory Parameters

Description

Host IP Address

IP address of your SMPP Server, which has to be whitelisted.


Important note: You also need to whitelist our IP address
124.153.65.146 on Port: 9099 at your end.

SMPP Client

SMPP Client to be used. For e.g. Kannel, NowSMS etc.

User name

User ID of your Enterprise account for authentication.

Password

Password of the respective Enterprise account.


Note: Password can have maximum of 8 characters only without any
special characters. Please reset your enterprise account password for
security reasons.

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide

Mandatory Parameters

Description

Bind Mode

Specify the connection type of your bind mode:


Receiver: will only receive messages.
Transmitter: will only transmit messages.
Transceiver: will transmit and receive messages.

Optional parameters:
Parameters

Description

Sessions

Number of sessions, which can be established.


Note: We can establish maximum of 5 sessions.

Transactions Per Second

Transactions, which can be processed per second.


Note: We can process messages at maximum of 10 TPS.

Important Note: You can refer to the standard SMPP Protocol Specification 3.4 for additional
information.

4 Trouble Shooting
If you are facing problems during a session binding and/or sending or receiving SMS through the
connection, then go through the logs of your SMPP client and see if you are receiving any SMPP
error codes/messages. These SMPP error codes/messages will provide you the information to
troubleshoot your connection.
Note:
For a complete list of error, codes go through Error Codes section.

5 Error Codes
The complete set of SMPP Error codes and their associated values are provided in the table below:
Error Codes

Values

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

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide


Error Codes

Values

Description

ESME_RINVPRTFLG

0x00000006

Invalid Priority Flag

ESME_RINVREGDLVFLG

0x00000007

Invalid Registered Delivery Flag

ESME_RSYSERR

0x00000008

System Error

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

ESME_RINVNUMDESTS

0x00000033

Invalid number of destinations

ESME_RINVDLNAME

0x00000034

Invalid Distribution List name

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

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide


Error Codes

Values

Description

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

ESME_RINVOPTPARSTREAM

0x000000C0

Error in the optional part of the PDUBody.

ESME_ROPTPARNOTALLWD

0x000000C1

Optional Parameter not allowed

ESME_RINVPARLEN

0x000000C2

Invalid Parameter Length

ESME_RMISSINGOPTPARAM

0x000000C3

Expected Optional Parameter missing

ESME_RINVOPTPARAMVAL

0x000000C4

Invalid Optional Parameter Value

ESME_RDELIVERYFAILURE

0x000000FE

Delivery Failure (used for data_sm_resp)

ESME_RUNKNOWNERR

0x000000FF

Unknown Error

SMPP_ESME_RROUTERR

0x00000400

Cannot route message.

SMPP_ESME_RNOCR

0x00000401

Credit Check Failed.

SMPP_ESME_RACCFROZ

0x00000403

User account is frozen.

SMPP_ESME_RRACCNOCON

0x00000433

Account not configured.

SMPP_ESME_RACCEXP

0x00000434

Account Expired.

SMPP_ESME_RSPAM

0X00000435

Spam Error.

SMPP_ESME_RDNC

0x00000436

DNC Error.

SMPP_ESME_NUM_EMPTY

0x00000437

Either Source or Destination number is empty.

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide


Error Codes

Values

Description

SMPP_ESME_INVALID_LEN

0x00000438

Invalid Number Length.

SMPP_ESME_RINTERR

0x000004ff

Internal Error.

Note: In case of any assistance, please mail us at enterprise-support@smsgupshup.com or call us on


022 42006799. (Mon-Fri 8 AM to 9 PM, Sat-Sun Holidays 10 AM to 6 PM)

6 Abbreviations
Term

Description

DNC

Do not call

SMPP

Simple message peer to peer

MT

Mobile terminated

MO

Mobile originated

SMS

Short Message Service

VMA

Voice Mail Activation

SM

Short Message

ESME

External Short Message Entity

TON

Type of number

NPI

Number Plan Indicator

PDU

Protocol Data Unit

SMS GupShup Technology India Private Limited Proprietary Information

EnterpriseSMSGupShup SMPP Guide

7 Contact Us
Email: enterprise-support@smsgupshup.com
Call: 022 42006799 (Monday to Friday, 8 AM to 9 PM; Saturday, Sunday & Holidays 10 AM to 6 PM).
Please keep your Enterprise ID and other account details handy for quick resolution of your problem.

SMS GupShup Technology India Private Limited Proprietary Information