Package com.ibm.soa.parlayx21.sms

Short Message Service.

See:
          Description

Interface Summary
ReceiveSms
ReceiveSms_RI  
ReceiveSmsHome  
ReceiveSmsService  
SendSms This interface defines operations to send various types of Short Messages and to subsequently poll for delivery status.
SendSms_RI  
SendSmsHome  
SendSmsService  
SmsNotification SmsNotification is the application side interface to which notifications about short messages are delivered.
SmsNotification_RI  
SmsNotificationHome  
SmsNotificationManager The short message notification manager enables applications to set up and tear down notifications for short messages online.
SmsNotificationManager_RI  
SmsNotificationManagerHome  
SmsNotificationManagerService  
SmsNotificationService  
 

Class Summary
DeliveryInformation Delivery status information.
DeliveryInformation_Deser  
DeliveryInformation_Helper  
DeliveryInformation_Ser  
DeliveryStatus List of delivery status values.
ReceiveSmsBindingStub  
ReceiveSmsProxy  
ReceiveSmsServiceInformation  
ReceiveSmsServiceLocator  
SendSmsBindingStub  
SendSmsProxy  
SendSmsServiceInformation  
SendSmsServiceLocator  
SmsFormat List of SMS format values.
SmsMessage SMS message information.
SmsMessage_Deser  
SmsMessage_Helper  
SmsMessage_Ser  
SmsNotificationBindingStub  
SmsNotificationManagerBindingStub  
SmsNotificationManagerProxy  
SmsNotificationManagerServiceInformation  
SmsNotificationManagerServiceLocator  
SmsNotificationProxy  
SmsNotificationServiceInformation  
SmsNotificationServiceLocator  
 

Package com.ibm.soa.parlayx21.sms Description

Short Message Service.

Common Data Types

For common data types associated with this package see Common Data Types.

Scope

The present document is part 4 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).

The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, for example, the OSA APIs.

The present document specifies the Short Messaging Web Service. The following are defined here:
  * Name spaces.
  * Sequence diagrams.
  * Data definitions.
  * Interface specification plus detailed method descriptions.
  * Fault definitions.
  * Service Policies.
  * WSDL Description of the interfaces.

References

The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
  * References are either specific (identified by date of publication and/or edition number or version number) or nonspecific.
  * For a specific reference, subsequent revisions do not apply.
  * For a non-specific reference, the latest version applies.

Referenced documents which are not found to be publicly available in the expected location might be found at http://docbox.etsi.org/Reference.

[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".

NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.

[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X 2 Web Services;

Part 1: Common".

[3] ETSI TS 123 040: "Digital cellular telecommunications system (Phase 2+); Universal Mobile Telecommunications System (UMTS); Technical realization of Short Message Service (SMS) (3GPP TS 23.040)".

[4] RFC2822: “Internet Message Format”

NOTE: Available at htpp://www.ietf.org/rfc/rfc2822.txt

Definitions and abbreviations

Definitions

For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.

Additionally the following definition is needed:

Whitespace: See definition for CFWS as defined in RFC2822 [4].

Abbreviations

For the purposes of the present document, the abbreviations defined in ES 202 391-1 [2] and the following apply:
SMS Short Message Service
SMS-C Short Message Service - Centre

Detailed service description

Currently, in order to programmatically receive and send SMS it is necessary to write applications using specific protocols to access SMS functions provided by network elements (for example, SMS-C). This approach requires a high degree of network expertise. Alternatively it is possible to use the Parlay/OSA approach, invoking standard interfaces (for example, User Interaction or Messaging Service Interfaces) to gain access to SMS capabilities, but these interfaces are usually perceived to be quite complex by IT application developers. Developers must have advanced telecommunication skills to use OSA interfaces.

In this clause is described a Parlay X 2 Web Service, for sending and receiving SMS messages. The overall scope of this Web Service is to provide to application developers primitives to handle SMS in a simple way. In fact, using the SMS Web Service, application developers can invoke SMS functions without specific Telco knowledge.

ShortMessaging provides operations (see clause 8.1, SendSms API) for sending an SMS message to the network and a polling mechanism for monitoring the delivery status of a sent SMS message. It also provide an asynchronous notification mechanism for delivery status (see clause 8.2.2, SmsNotification API: notifySmsDeliveryReceipt operation).

ShortMessaging also allows an application to receive SMS messages. Both a polling (see clause 8.3, ReceiveSms API) and an asynchronous notification mechanism (see clause 8.2.1, SmsNotification API: notifySmsReception operation and clause 8.4, SmsNotificationManager API) are available.

Figure 1 shows a scenario using the SMS Web Service to send an SMS message from an application. The application invokes a Web Service to retrieve a weather forecast for a subscriber (1) and (2) and a Parlay X 2 Interface (3) to use the SMS Web Service operations (for example, to send an SMS). After invocation, the SMS Web Service invokes a Parlay API method (4) using the Parlay/OSA SCS (Generic User Interaction) interface. This SCS handles the invocation and sends an UCP operation (5) to an SMS-C. Subsequently the weather forecast is delivered (6) to the subscriber.

In an alternative scenario, the Parlay API interaction involving steps (4) and (5) could be replaced with a direct interaction between the SMS Web Service and the Mobile network.

Figure 1: Send SMS Scenario

Figure 2 shows a scenario using the SMS Web Service to deliver a received SMS message to an application. The application receives a Parlay X 2 Web Service invocation for an SMS sent by a subscriber (1) and (2). The SMS message contains the e-mail address of the person the user wishes to call. The application invokes a Parlay X Interface (3) to the Third Party Call Web Service in order to initiate the call (4).

Figure 2: Receive SMS Scenario

Namespaces

The SendSms interface uses the namespace: http://www.csapi.org/wsdl/parlayx/sms/send/v2_12

The ReceiveSms interface uses the namespace: http://www.csapi.org/wsdl/parlayx/sms/receive/v2_12

The SmsNotification interface uses the namespace: http://www.csapi.org/wsdl/parlayx/sms/notification/v2_12

The SmsNotificationManager interface uses the namespace: http://www.csapi.org/wsdl/parlayx/sms/notification_manager/v2_23

The data types are defined in the namespace: http://www.csapi.org/schema/parlayx/sms/v2_12

The 'xsd' namespace is used in the present document to refer to the XML Schema data types defined in XML Schema [1]. The use of the name 'xsd' is not semantically significant.

Sequence diagrams

Send SMS and report status

Sending SMS message from Web portals is a common capability offered by Service Providers. This sequence diagram shows a portal providing this service.

Figure 3

XML Schema data type definition

DeliveryStatus enumeration

List of delivery status values.


DeliveredToNetwork

Successful delivery to network.
DeliveryUncertain

Delivery status unknown: 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. This is a temporary state, pending transition to one of the preceding states.
DeliveredToTerminalSuccessful delivered to Terminal


DeliveryNotificationNotSupported

Unable to provide delivery receipt notification. The notifySMSDeliveryReceipt operation will return “DeliveryNotificationNotSupported” to indicate that delivery receipt for the specified address in a sendSMS…Request message is not supported.

SmsFormat enumeration

List of SMS format values.


Ems Enhanced Messaging Service, standardized in TS 123 040 [3], which defines a logo/ringtone format
SmartMessagingTM Defines a logo/ringtone format

DeliveryInformation structure

Delivery status information.


address xsd:anyURI

It indicates the destination address to which the notification is related.
deliveryStatus DeliveryStatus

A * Indicates the delivery result for the destination address.

SmsMessage structure

SMS message information. The senderAddress is the address from which the message was actually sent, which may or may not match the senderName value provided in the sendSms operation.


message xsd:string

Text received in SMS
senderAddress xsd:anyURI

It indicates address sending the SMS
smsServiceActivation Number xsd:anyURI

Number associated with the invoked Message service, for example, the destination address used to send the message
dateTime xsd:dateTime

Time when message was received by operator

Web Service interface definition

Fault definitions

ServiceException

SVC0280: Message too long


messageId SVC0280
text Message too long. Maximum length is %1 characters
variables %1 Number of characters allowed in a message

SVC0281: Unrecognized data format


messageId SVC0281
text Data format not recognized for message part %1
variables %1 Message part with the unrecognized data

Void

The fault code SVC0282 is reserved and shall not be used.

SVC0283: Delivery Receipt Notification not supported


messageId SVC0283
text Delivery Receipt Notification not supported
variables

Service policies

Service policies for this service.


GroupSupport xsd:boolean Groups may be included with addresses
NestedGroupSupport xsd:boolean Are nested groups supported in group definitions
ChargingSupported xsd:boolean Is charging supported for send operations



Copyright © 2003 IBM Corp. All Rights Reserved.