The Parlay X SMS over Parlay 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. Parlay X SMS over Parlay interacts with a Parlay gateway using the Parlay Connector.
Call flows
The following steps show an example of the
call flow for
Parlay X SMS over Parlay:
- The application invokes a sendSMS.
- Parlay X SMS over Parlay sends
the sendSMS through the Parlay Connector to the Parlay
gateway.
- The Parlay gateway returns a sendMessageRes response
through the Parlay Connector to Parlay X SMS over Parlay.
In case of any error occuring during the processing of sendSMS,
the gateway sends a sendMessageErr indicating that an error
has occurred. If the confirm delivery option is opted, a messageStatusReport will
be sent by the gateway.
- Parlay X SMS over Parlay sends
the Transaction ID as a response to the application.
- Parlay X SMS over Parlay 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.
- 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.
- sendSmsLogo
- A request to send a Logo.
- sendSmsRingTone
- A request to send a Ringtone.
- 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.