Upload
trantruc
View
221
Download
1
Embed Size (px)
Citation preview
GTXMobileMessagingSMSGatewayInterface
SMPPAPIManual
Revision:11RevisionDate:16.10.1316:34Author:EvgenijTovba,OliverZabel
2
TableofContents
TABLEOFCONTENTS................................................................................................................2
INTRODUCTION........................................................................................................................3
CONNECTIVITYSETTINGS.........................................................................................................3
Target..........................................................................................................................................................................................3
SystemType..............................................................................................................................................................................3
EnquireLinkInterval.............................................................................................................................................................3
BindMode..................................................................................................................................................................................3
UnbindCommand....................................................................................................................................................................3
Throughput...............................................................................................................................................................................3
TON/NPISETTINGS.................................................................................................................4
BindTON/NPI.........................................................................................................................................................................4
SourceAddressTON/NPI....................................................................................................................................................4
DestinationAddressTON/NPI..........................................................................................................................................4
DELIVERYREPORTS(DLR).........................................................................................................4
ReasonCodes............................................................................................................................................................................4
Note..............................................................................................................................................................................................7
DLRExample.............................................................................................................................................................................7
3
IntroductionTheMobileMessagingSMSGatewayprovidesaSMPPinterfaceforstandardizedconnectivity.Itisbasedontheprotocolversion3.4asdescribedintheofficialspecification:https://www.gtx-messaging.com/fileadmin/files/SMPP_v3_4_Issue1_2.pdfIfyouhavetroubledownloadingthisdocumentpleaseaskusforacopy.Thismanualwillanswersomecommonquestionsregardingtheconnectionandmessagesubmission.Ifyouhavefurtherquestionsregardingthisinterface,pleasecontactyouraccountmanagerorfileatroubletickettosupport@gtx-messaging.com.
ConnectivitySettings
TargetTheSMPPinterfaceisreachableunderthefollowingaddress:
smpp.gtx-messaging.net
Youraccountmanagerwillannouncethetargetportuponaccountcreation.
SystemTypePleaseusethesystemtype„WMA“.
EnquireLinkIntervalTokeeptheconnectionalive,pleasesendanenquire_linkcommandevery60seconds.IftheSMPPgatewaydoesn’treceiveanymessagewithin120secondsitwillclosetheconnectionbysendinganunbindcommand.
BindModeWerecommendbindingasatransceivertobeabletobothsendandreceivemessages.
UnbindCommandPleasebeawarethattheSMPPgatewaymaysendanunbindcommandtoyourclient.Youmayreconnectautomaticallyafterafewseconds.
ThroughputBydefaultyouraccountissetupwithamaximumthroughputof5SMSpersecond.Incaseyouwanttoincreasethislimitationpleasetalktoyouraccountmanager.
4
TON/NPISettingsThispartexplainstheTON(TypeOfNumber)andNPI(NumberingPlanIndicator)settingsthatshouldbeusedwiththeGateway.ForfurtherinformationpleaserefertotheSMPPspecification,sections5.2.5and5.2.6.
BindTON/NPIWhenbindingbothTONandNPIshouldbesettoNULL.
SourceAddressTON/NPIWhensubmittingmessagespleasesettheTONandNPIaccordingly:
TON NPI Description1 1 Internationalnumericoriginator2 1 Local/nationaloriginator,eithershortcodeornumeric5 0 Alphanumericoriginator
DestinationAddressTON/NPIThedestinationaddressshouldalwaysbesubmittedusingTON = 1andNPI = 1.TheSMPPgatewayalwaysexpectsaninternationalnumberformat.
DeliveryReports(DLR)DependingonthechosenproducttheunderlyingroutingmayormaynotsupportDLRs.PleaseaskyouraccountmanageraboutDLRsupportonyourproduct.
ReasonCodesThefollowingDLRreasoncodeswillbereturned:Errorcode(HEX) ReasonDescription
0000 Success,NoError0001 unknownSubscriber0002 unknownBaseStation0003 unknownMSC0005 unidentifiedSubscriber0006 absentsubscriberSM0007 unknownEquipment0008 roamingNotAllowed0009 illegalSubscriber000a bearerServiceNotProvisioned000b teleserviceNotProvisioned000c illegalEquipment000d callBarred000e forwardingViolation000f cug-Reject0010 illegalSS-Operation0011 ss-ErrorStatus0012 ss-NotAvailable0013 ss-SubscriptionViolation0014 ss-Incompatibility
5
Errorcode(HEX) ReasonDescription0015 facilityNotSupported0017 invalidTargetBaseStation0018 noRadioResourceAvailable0019 noHandoverNumberAvailable001a subsequentHandoverFailure001b absentSubscriber001c incompatibleTerminal001d shortTermDenial001e longTermDenial001f subscriberBusyForMT-SMS0020 sm-DeliveryFailure0021 messageWaitingListFull0022 systemFailure0023 dataMissing0024 unexpectedDataValue0025 pw-RegistrationFailure0026 negativePW-Check0027 noRoamingNumberAvailable0028 tracingBufferFull002b numberOfPW-AttemptsViolation002c numberChanged002d busySubscriber002e noSubscriberReply002f forwardingFailed0030 or-NotAllowed0031 ati-NotAllowed0032 noGroupCallNumberAvailable0033 resourceLimitation0034 unauthorizedRequestingNetwork0035 unauthorizedLCSClient0036 positionMethodFailure003a unknownOrUnreachableLCSClient0047 unknownAlphabet0048 ussd-Busy0056 subscriberLocationReport2100 Unrecognizedcomponent2101 Mistypedcomponent2102 Badlystructuredcomponent2200 DuplicateinvokeID2201 Unrecognizedoperation2202 Mistypedparameter2203 Resourcelimitation2204 Initiatingrelease2205 UnrecognizedlinkedID2206 Linkedresponseunexpected2207 Unexpectedlinkedoperation
6
Errorcode(HEX) ReasonDescription2300 UnrecognizedinvokeID2301 ReturnResultunexpected2302 Mistypedparameter2400 UnrecognizedinvokeID2401 ReturnErrorunexpected2402 Unrecognizederror2403 Unexpectederror2404 Mistypedparameter6000 memoryCapacityExceeded6001 equipmentProtocolError6002 equipmentNotSM-Equipped6003 unknownServiceCentre6004 sc-Congestion6005 invalidSME-Address6006 subscriberNotSC-Subscriber8000 Unrecognizedmessagetype8001 UnrecognizedtransactionID8002 Badlyformattedtransactionportion8003 Incorrecttransactionportion8004 Resourcelimitation800b Dialoguecollision8010 Nodenotreachable81xx Incorrectmessagelength82xx MissingmandatoryIE83xx IncorrectIElength84xx Badparametervalue85xx Nofreedialogues86xx InvaliddialogueID87xx Exceededmaximumlength88xx Invalidparameter89xx Inappropriatetransportmessage8axx Agentnotregistered8bxx Dialoguecollision8cxx TCUsernotboundc001 sc-AddressNotIncludedc002 mnrf-Setc004 mcef-Setc008 mnrg-Sete001 ThedialoguehasreceivedaMAP-DELIMITERunexpectedly.e002 ThedialoguehasreceivedaMAP-SERVICE-REQUESTunexpectedly.e010 CouldnotdecodeanASN.1encodedparameter.e011 CouldnotASN.1encodeaparameter.e020 Dialoguequeuesizeexceeded.e040 Dialoguetimedout,i.e.thefarsidedidnotrespondorthereisanetworkproblem.e080 Invaliddeliveryoutcome(<0or>2onanyMAPlevel,or1onMAP1)e081 Invaliddestinationaddress
7
Errorcode(HEX) ReasonDescriptione1xx CouldnotopenMAPdialoguethelowest8bitscontainthecodereturnedbyTDAPIff00 (GTX)Internalerrorff01 (GTX)Destinationtemporarelynotavailableff02 (GTX)Networklookuptemporarelyfailedff03 (GTX)RejectedbyMNOff04 (GTX)Unknown/UnmappableMNOerrorcodeff05 (GTX)Expiredff06 (GTX)BlacklistedMSISDNff07 (GTX)MNPnotsupportedff08 (GTX)InsufficientCreditff81 Incorrectmessagelengthff82 MissingmandatoryIEff83 IncorrectIElengthff84 Badparametervalueff85 Nofreedialoguesff86 InvaliddialogueIDff87 Exceededmaximumlengthff88 Invalidparameterff89 Inappropriatetransportmessageff8a Agentnotregisteredff8b Dialoguecollisionff8c TCUsernotboundffe1 CouldnotopenMAPdialogue
NoteSMSrejectedbyerrorcodes"ff00","ff01","ff02"and"ff08"willnotbecharged.
DLRExample
id:abcdef12-3456-7890-abcd-ef123456789 sub:001 dlvrd:001 submit date:1105011200 done date:1105011200 stat:DELIVRD err:0000 text: