Application Development Guide

Extended Web Services Binary SMS

The Extended Web Services Binary SMS Web Service allows for the sending and receiving of any generic binary content via SMS. Both application-initiated and network-triggered requests are supported. The binary content can be other than the Logos and Ringtones as specified by Parlay X Short Messaging. An example would be a vCard.

Endpoints

The endpoint for the BinarySMS interface is: http://<host:port>/ews/binary_sms/BinarySms

The endpoint for the BinarySmsNotificationManager interface is: http://<host:port>/ews/binary_sms_notification/BinarySmsNotificationManager

The values for host and port depend on the specific Oracle Communications Services Gatekeeper deployment.

Sequence Diagram

Send SMS

The following diagram shows the general message sequence for sending a binary SMS message from an Extended Web Services Binary SMS application to the network. In this message sequence the application also receives a notification from the network indicating the delivery status of the SMS, that is that the message has reached its destination. It also displays how an application can query the delivery status of the message.

The interaction between the network and Oracle Communications Services Gatekeeper is illustrated in a protocol-agnostic manner. The exact operations and sequences depend on which network protocol is being used.

Note:

The delivery notifications are sent from the Parlay X 2.1 Short Messaging implementation.

Receive SMS

The following diagram shows the general message sequence for receiving a binary SMS message from the Network using Oracle Communications Services Gatekeeper. In this message sequence the application also subscribes for a notifications on network triggered short messages.

The interaction between the network and Oracle Communications Services Gatekeeper is illustrated in a protocol-agnostic manner. The exact operations and sequences depend on which network protocol is being used.

Figure 5-2 Sequence diagram receive Extended Web Services Binary SMS

XML Schema data type definition

The following data structures are used in the Extended Web Services Binary SMS Web Service.

BinaryMessage structure

Defines the binary payload of the SMS for application-initiated messages.

Defines the TP-User Data (TP-UD). For a description of TP-User Data (TP-UD), TP-User-Data-Header-Indicator (TP UDHI), see 3GPP TS 23.040 V6.5.0, Technical realization of the Short Message Service (SMS) at http://www.3gpp.org/ftp/Specs/html-info/23040.htm.

The protocol identifier is the information element by which the short message transport layer either refers to the higher layer protocol being used, or indicates interworking with a certain type of telematic device.

Interface: BinarySmsNotificationManager

Operations to start and stop subscriptions for notifications for short messages with binary content.

Operation: StartBinarySmsNotification

Starts a subscription for notifications for short messages that have content in the form of binary data. A correlator is provided in the request. This correlator is used when stopping the subscription.

Input message: StartBinarySmsNotification

Part name

Part type

Optional

Description

reference

ews_common_xsd:SimpleReference

N

Defines the application endpoint, interfaceName and correlator that will be used to forward a binary short message from the network.

Operation: StopBinarySmsNotification

Stops a previously started subscription for notifications for short messages that have content in the form of binary data. A correlator is provided in the request. This correlator was provided when the subscription was started, see Operation: StartBinarySmsNotification.

Input message: StopBinarySmsNotification

Part name

Part type

Optional

Description

correlator

xsd:String

N

The identifier for the subscription.

Output message: StopBinarySmsNotificationResponse

Part name

Part type

Optional

Description

-

-

-

-

Referenced faults

Table 5-3 exceptions and error codes

Exception

Error code

Reason/Action

SVC0001

BSMS-000001

Unable to perform action. Network error

SVC0001

BSMS-000002

Unable to retrieve configuration, internal error.

SVC0001

BSMS-000003

The used address type is not supported

SVC0001

BSMS-000004

Unable to encode message segments.

make sure the number of message segments is not 0.

SVC0001

BSMS-000005

GSM message format error.

SVC0001

BSMS-000006

Binary Message has too many segments.

SVC0001

PLG-000004

General plug-in routing error.

SVC0002

n/a

SVC0003

n/a

SVC0004

n/a

SVC0005

n/a

EPOL0001

n/a

Interface: BinarySmsNotification

This interface shall be implemented by the application. It is used by Oracle Communications Services Gatekeeper to deliver short messages with binary content to an application. Only messages that match a previously started subscription for notifications are delivered.

Note:

Notifications on delivered short messages are delivered using the Parlay X 2.1 Short Messaging SmsNotification interface, using the method NotifySmsDeliveryReceipt.

Operation: NotifyBinarySmsReception

Oracle Communications Services Gatekeeper calls this methods on

The notification is used to send a short message with binary content to the application. The notification occurs if the short message matched the criteria specified when starting the notification. See Operation: StartBinarySmsNotification.

The method must be implemented by a Web Service at the application side. It is be invoked by Oracle Communications Services Gatekeeper when it receives a short message with binary content form the network and the criteria is fulfilled.