|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SendSms
This interface defines operations to send various types of Short Messages and to subsequently poll for delivery status. The Short Message types are:
* SMS message, as described in 8.1.1
* SMS logo, as described in 8.1.2
* SMS ringtone, as described in 8.1.3.
The send operations for the Short Message types are similar. A description of the common message parts follows:
* addresses specifies the destination address or address set for the Short Message. It may include group URIs as defined in the Address List Management specification. If groups are not supported, a PolicyException (POL0006) will be returned to the application.
* senderName is optional and specifies the sender’s name: for example, the string that is displayed on the user's terminal as the originator of the message
* charging specifies the charging information
* receiptRequest is optional and is specified when the application requires to receive notification of the status of the SMS delivery. It is a SimpleReference structure that indicates the application endpoint, interface used for notification of delivery receipt and a correlator that uniquely identifies the sending request.
- If the notification mechanism is not supported by a network, a ServiceException (SVC0283) will be returned to the application and the message will not be sent to the addresses specified.
- The correlator provided in the receiptRequest must be unique for this Web Service and application at the time the notification is initiated, otherwise a ServiceException (SVC0005) will be returned to the application.
- Notification to the application is done by invoking the notifySmsDeliveryReceipt operation at the endpoint specified in receiptRequest.
* requestIdentifier is specified in the response message associated with each send operation. The application can use it to invoke the getSmsDeliveryStatus operation to poll for the delivery status.
Method Summary | |
---|---|
DeliveryInformation[] |
getSmsDeliveryStatus(java.lang.String requestIdentifier)
The application invokes the getSmsDeliveryStatus operation to request the status of a previous SMS delivery request identified by requestIdentifier. |
java.lang.String |
sendSms(java.net.URI[] addresses,
java.lang.String senderName,
ChargingInformation charging,
java.lang.String message,
SimpleReference receiptRequest)
The application invokes the sendSms operation to send an SMS message, specified by the String message. |
java.lang.String |
sendSmsLogo(java.net.URI[] addresses,
java.lang.String senderName,
ChargingInformation charging,
byte[] image,
SmsFormat smsFormat,
SimpleReference receiptRequest)
The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image. |
java.lang.String |
sendSmsRingtone(java.net.URI[] addresses,
java.lang.String senderName,
ChargingInformation charging,
java.lang.String ringtone,
SmsFormat smsFormat,
SimpleReference receiptRequest)
The application invokes the sendSmsRingtone operation to send an SMS ringtone, specified by the String ringtone (in RTX format). |
Method Detail |
---|
java.lang.String sendSms(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, java.lang.String message, SimpleReference receiptRequest) throws java.rmi.RemoteException, PolicyException, ServiceException
The application invokes the sendSms operation to send an SMS message, specified by the String message.
For GSM systems, if message contains characters not in the GSM 7-bit character set, the SMS is sent as a Unicode SMS.
If message is longer than the maximum supported length (for example, for GSM, 160 GSM 7-bit characters or 70 Unicode characters), the message content will be sent as several concatenated short messages.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0004 - No valid addresses.
* SVC0006 - Invalid group.
* SVC0280 - Message too long.
* SVC0283 - Delivery Receipt Notification not supported.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
* POL0006 - Groups not allowed.
* POL0007 - Nested groups not allowed.
* POL0008 - Charging not allowed.
addresses
- xsd:anyURI [1..unbounded]
Addresses to which the SMS will be sentsenderName
- xsd:string
If present, it indicates the SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the messagecharging
- common:ChargingInformation
Charge to apply to this messagemessage
- xsd:string
Text to be sent in SMSreceiptRequest
- common:SimpleReference
It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible .
java.rmi.RemoteException
PolicyException
ServiceException
java.lang.String sendSmsLogo(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, byte[] image, SmsFormat smsFormat, SimpleReference receiptRequest) throws java.rmi.RemoteException, PolicyException, ServiceException
The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0004 - No valid addresses.
* SVC0006 - Invalid group.
* SVC0281 - Unrecognized data format.
* SVC0283 - Delivery Receipt Notification not supported.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
* POL0006 - Groups not allowed.
* POL0007 - Nested groups not allowed.
* POL0008 - Charging not allowed.
addresses
- xsd:anyURI [1..unbounded]
Addresses to which the SMS logo will be sentsenderName
- xsd:string
SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the messagecharging
- common:ChargingInformation
Charge to apply to this messageimage
- xsd:base64Binary
The image in jpeg, gif or png format. The image will be scaled to the proper formatsmsFormat
- SmsFormat
Conversion to be applied to the message prior to delivery. Possible values are: 'Ems' or 'SmartMessaging'receiptRequest
- common:SimpleReference
It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible.
java.rmi.RemoteException
PolicyException
ServiceException
java.lang.String sendSmsRingtone(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, java.lang.String ringtone, SmsFormat smsFormat, SimpleReference receiptRequest) throws java.rmi.RemoteException, PolicyException, ServiceException
The application invokes the sendSmsRingtone operation to send an SMS ringtone, specified by the String ringtone (in RTX format).
Depending on the length of the ringtone, it may be sent as several concatenated short messages.
NOTE: In the RTX Ringtone Specification, an RTX file is a text file, containing the ringtone name, a control subclause and a subclause containing a comma separated sequence of ring tone commands.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0004 - No valid addresses.
* SVC0006 - Invalid group.
* SVC0281 - Unrecognized data format.
* SVC0283 - Delivery Receipt Notification not supported.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
* POL0006 - Groups not allowed.
* POL0007 - Nested groups not allowed.
* POL0008 - Charging not allowed.
addresses
- xsd:anyURI [1..unbounded]
Addresses to which the SMS logo will be sentsenderName
- xsd:string
SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the messagecharging
- common:ChargingInformation
Charge to apply to this messageringtone
- xsd:string
The ringtone in RTX format (see note above). (http://www.logomanager.co.uk/help/Edit/RTX.html)smsFormat
- SmsFormat
Conversion to be applied to the message prior to delivery. Possible values are: 'Ems' or 'SmartMessaging'receiptRequest
- common:SimpleReference
It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible.
java.rmi.RemoteException
PolicyException
ServiceException
DeliveryInformation[] getSmsDeliveryStatus(java.lang.String requestIdentifier) throws java.rmi.RemoteException, PolicyException, ServiceException
The application invokes the getSmsDeliveryStatus operation to request 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. This method can be invoked multiple times by the application even if the status has reached a final value. However, after the status has reached a final value, status information will be available only for a limited period of time that should be specified in an off-line configuration step. The following five different SMS delivery status values have been identified:
* DeliveredToNetwork: in case of concatenated messages, only when all the SMS-parts have been successfully delivered to the network.
* DeliveryUncertain: for example, because it was handed off to another network.
* DeliveryImpossible: unsuccessful delivery; the message could not be delivered before it expired.
* MessageWaiting: the message is still queued for delivery.
* DeliveredToTerminal: in case of concatenated messages, only when all the SMS-parts have been successfully delivered to the terminal.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
requestIdentifier
- xsd:string
It identifies a specific SMS delivery request
It lists the variations on the delivery status of the SMS. Possible values are:
* DeliveredToNetwork
* DeliveryUncertain
* DeliveryImpossible
* MessageWaiting
* DeliveredToTerminal
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |