The Parlay X SMS over SMPP Web service implementation provides operations for sending an SMS message to the network, monitoring the delivery status of a sent SMS message, and asynchronously receiving notification of message delivery status.
Call flows
The following steps show an example of the call flow for
Parlay X SMS over SMPP:
- The application invokes a sendSMS.
- Parlay X SMS over SMPP sends the sendSMS through the JCA adapter to the SMSC.
- The SMSC sends the request to the appropriate server.
- The SMSC returns an SmsNotification response through the JCA adapter to Parlay X SMS over SMPP.
- Parlay X SMS over SMPP sends the SmsNotification response to the application.
Interfaces
Note: These interfaces are provided as Web services–except for SmsNotification, which is used as a client only.
- SendSms
- sendSms
- Allows you to send an SMS request and monitor the status of that request.
- sendSmsLogo
- Allows you to request the sending of an SMS logo to a specified address or address set, specified as destinationAddressSet. Optionally, the application can also specify the sender name that is displayed on the user's terminal (senderName) and the name of an operator-specific charging plan (charging).
- sendSmsRingtone
- Allows you to request the sending of an SMS ring tone, specified by the string ringtone (in RTX format), to a specified address or address set, specified as destinationAddressSet. Optionally, the application can also specify the sender name that is displayed on the user's terminal (senderName) and the name of an operator-specific charging plan (charging).
- getSmsDeliveryStatus
- Requests the status of a previous SMS delivery request identified by requestIdentifier. The information on the status is returned in deliveryStatus, which is an array of status related to the request identified by requestIdentifier. The status is identified by a couplet indicating a user address and the associated delivery status.
- SmsNotification
- notifySmsReception
- Requests the status of a previous SMS delivery request identified by requestIdentifier. The information on the status is returned in deliveryStatus, which is an array of status related to the request identified by requestIdentifier.
- notifySmsDeliveryReceipt
- When an SMS message is sent to multiple terminals, requests a notification from each terminal. The notification indicates one of three outcomes: delivery was successful, time expired before the message could be delivered, and notification is not supported for the terminal.
- ReceiveSms
- getReceivedSms
- Retrieves all of the SMS messages received that fulfill the criteria identified by registrationIdentifier. The method returns only the list of SMS messages received since the last time the method was invoked. (Older messages are removed from the server.)
- SmsNotificationManager
- startSmsNotification
- Enables an application to request notifications for short messages online.
- stopSmsNotification
- Enables an application to stop receiving notifications for short messages online.
Usage records
The interfaces for
Parlay X SMS over SMPP generate usage records as follows.
Interface |
Usage records written |
SendSms: sendSms |
1 usage record per target per operation, without delivery confirmation |
SendSms: sendSmsLogo |
1 usage record per target per operation, without delivery confirmation |
SendSms: sendSmsRingtone |
1 usage record per target per operation, without delivery confirmation |
SendSms: getSmsDeliveryStatus |
1 usage record per operation |
SmsNotification: notifySmsReception |
None |
SmsNotification: notifySmsDeliveryReceipt |
1 usage record per target per SendSms operation, written after delivery confirmation is received |
ReceiveSms: getReceivedSms |
1 usage record per operation |
SmsNotificationManager: startSmsNotification |
1 usage record per operation |
SmsNotificationManager: stopSmsNotification |
1 usage record per operation |
For more details, refer to the topic Usage records for Parlay X SMS over SMPP.
SMPP operations
The SMPP JCA adapter supports the following SMPP operations:
- bind_transceiver: The SMPP supports the bind_transceiver operation, with which an ESME can bind to an SMSC as a transceiver (called an ESME transceiver).
- bind_transmitter: The SMPP supports the bind_transmitter operation, with which an ESME can bind to an SMSC as a transmitter (called an ESME transmitter).
- bind_receiver: The SMPP supports the bind_receiver operation, with which an ESME can bind to an SMSC as a receiver (called an ESME receiver).
- unbind: Registers an ESME instance of SMSC, which informs the SMSC of the discontinued use of the network connection for the submission of delivery messages.
- generic_nack: A generic negative acknowledgement to an SMPP PDU submitted with an incorrect message header.
- submit_sm: Uses the ESME to submit short messages to the SMSC for onward transmissions of a specified SME. This operation does not support the transaction message mode.
- submit_multi: Can be used to submit an SMPP message for the delivery of one or multiple recipients to a distribution list. This operation does not support the transaction message mode.
- deliver_sm: Issued by the SMSC to send a message to an ESME. Using this command, the SMSC can route a short message to the ESME for delivery confirmation.
- enquire_link: A message that can be sent by either an ESME or an SMSC to provide a confidence check of the communication path between the ESME and the SMSC. On receipt of this request, the receiving party should respond with an enquire_link_resp. This verifies that the application-level connection between the ESME and the SMSC is functioning.
Note: Enquire_link requests sent to the servers in a cluster are handled by only one server in that cluster.