txtNation SMPP

From txtNation Wiki
(Redirected from SMPP Bulk)
Jump to: navigation, search
txtNation Gateway logo

txtNation's SMPP Gateway API allows you to perform both Mobile Billing; Premium SMS, and Messaging; Bulk SMS.

SMPP Bulk refers to the method of sending your MT messages using our SMPP platform.

Contents

Important information

Please take note of the following:

  • Always connect via the domain name. Enter the domain name in your application, never our IP addresses.
  • Never cache the domain name lookup
  • Automatically reconnect when the connection drops, but try no more than once every 30 seconds
  • Message is accepted by us when you get a Submit_SM_Resp with state ESME_ROK and a message id
  • When we send messages and reports to you via Deliver_SM. You must positively acknowledge each and every one.
    • The same message/report is sent to you until it is acknowledged. No other messages/reports will be sent until the previous ones are confirmed.


Connecting

A bind_transmitter, or bind_transceiver primitive should be sent immediately after establishing a connection.

The system_id and password field need to be set; all other parameters are ignored. Upon successful bind, a bind_transmitter_resp, or bind_transceiver_resp' primitive will be returned with a command_status of zero (ESME_ROK). If the bind fails due to mismatching system_id/password, or other reasons, a generic_nack primitive will be returned.

Bound State

After binding you may choose to periodically send enquire_link primitives to ensure the link stays active. If you don't send enquire_link primitives, we will send them instead and you will be required to reply to them with enquire_link_resp.


Messaging; Bulk SMS - Sending Messages

To submit messages for delivery to handsets, you must use the submit_sm primitive. Please use the following values for the parameters:


Body Parameter Values
service_type Set to null
source_addr_ton For premium, set to TON=6; for non-premium set to TON=5 or TON=6

( TON=6 Source address may be a string of any length containing exclusively digits. E164 (normal cli sending)), ( TON=5 Source address may be alpha or numeric to a maximum length of 11 characters )

source_addr For premium set to shortcode, for non-premium, set to shortcode or alphanumeric, maximum 11 chars
destination_address Set to MSISDN of subscriber, international format, example: 447123456789
sm_length Set to length of short_message field
short_message Insert text of message, maximum 160 chars

All other body parameters must be valid according to SMPP SPEC, but will be ignored.

Mobile Billing; Premium SMS

This OPTIONAL parameter allows for the facilitation of Premium SMS

Name Tag ID Data Type Values
PREMIUM_NETWORK_NAME 0x1420 Octet String Subscriber network (O2UK, ORANGEFR...)

When a message is accepted for delivery, a submit_sm_resp primitive is sent with a message identifier in its message_id field. If the submit_sm primitive fails any of the validation checks, then a generic_nack primitive will be returned.


Disposition Notifications

Changes to the disposition of a message that has been accepted for onwards delivery, will be sent through deliver_sm primitives with the following properties:

Old style

Body Parameter Values
destination_addr MSISDN
short_message Disposition state; format: STATE@YYMMDDhhmmss

New default style

Standard SMPP v3.4 report format, see http://opensmpp.org/specs/SMPP_v3_4_Issue1_2.pdf , Appendix B on page 167

Message Id

TLV Parameter Values
receipted_message_id Same value as message_id in submit_sm_resp


Throttling

Every PDU sent to us counts towards a fixed limit of PDUs/minute If you go over the aggreed rate, then you will get generic_nacks to all your PDUs, and their command_status will be set to ESME_RTHROTTLED until the rate drops back to an acceptable level.


Disconnecting

It is desired that you send a UNBIND primitive and wait for the peer to reply with an UNBIND_RESP and connection reset. In case you don't do this, it is possible that new connection requests fail for up to 60 seconds.


Disposition States

STATE SMSC Reported state Final state
DELIVERED DELIVERED Yes
DELIVERED DELIVRD Yes
ACKNOWLEDGED ACK No
ACKNOWLEDGED ACKED No
ACKNOWLEDGED ACKNOWLEDGED No
REJECTED REJECT Yes
REJECTED REJECTED Yes
REJECTED REJECTD Yes
NON DELIVERED UNDELIV Yes
NON DELIVERED UNDELIVER Yes
NON DELIVERED UNDELIVERED Yes
EXPIRED EXPIRD Yes
EXPIRED EXPIRED Yes
DELETED DELETED Yes
DELETED DELETE Yes
DELETED OPSDELETED Yes
ABANDONED ABANDONED Yes
RETRYING RETRY No
RETRYING RETRYNG No
RETRYING RETRYING No
CREDIT ERROR CREDIT ERROR No
NETWORK ERROR STORE BUSY Yes
NETWORK ERROR INTERFACE BUSY Yes
NETWORK ERROR OTHER ERROR Yes
NETWORK ERROR FACILITY NOT SUPPORTED Yes
NETWORK ERROR DATABASE FULL Yes
NETWORK ERROR SME BUSY Yes
NETWORK ERROR NETWORK FAILURE Yes
INVALID NUMBER DESTINATION NOT KNOWN Yes
INVALID NUMBER UNIDENTIFIED SUBSCRIBER Yes
SMS BLOCKED CALL BARRED Yes
SMS BLOCKED USER CALL BARRED Yes
SIM FULL MEMORY CAPACITY EXCEEDED Yes
HANDSET UNAVAILABLE ABSENT IMSI DETACHED Yes
HANDSET UNAVAILABLE SMS NOT PROVISIONED Yes
HANDSET UNAVAILABLE ERROR IN MS Yes
HANDSET UNAVAILABLE ABSENT IMSI DETACHED GPRS Yes
HANDSET UNAVAILABLE ABSENT DEREGISTERED IN HLR Yes
HANDSET UNAVAILABLE ABSENT MS PURGED Yes
ROAMING ERROR ABSENT PAGE FAIL Yes
ROAMING ERROR ABSENT ROAMING RESTRICTION Yes
CREDIT ERROR CALL BARRED (NO CREDIT) Yes
CREDIT ERROR CALL BARRED (NO ACCESS TIME) Yes
SENDING ERROR SYSTEM FAILURE Yes
SENDING ERROR CUG REJECT Yes
SENDING ERROR UNEXPECTED DATA VALUE Yes
SENDING ERROR TRANSMISSION ERROR Yes
SENDING ERROR DEFERRED DELIVERY Yes
CREDIT ERROR NOCRED Yes
SENDING ERROR FAILED Yes
BUFFERED BUFFRED No
SENDING ERROR UNDELIVERABLE Yes
FAILED MNP Ported out MSISDN Yes

Message Retry Policies

When sending messages to our SMPP gateway, you may experience unsuccessful submissions with statuses according to the above. In certain cases you may be able to retry the message but this will often depend on your agreements with the operators in a given country. Contact txtNation for more details.

Personal tools