2 Understanding the Supported Application Interfaces

This chapter introduces the interfaces that Oracle Communications Services Gatekeeper-hosted client applications can use. If you use HTTP-to-HTTP communication you can skip this chapter.

Overview of Services Gatekeeper Supported Interfaces

Services Gatekeeper enables you to provide client application developers with a choice of interface types, based on the needs of their applications. Services Gatekeeper provides these by default:

You can also createcustom interfaces, using the Network Service Supplier Portal.

SOAP-Based Interfaces

The SOAP-based Web services interfaces are based on the Parlay X standards and also include additional Extended Web services to cover functionality that is not supported by Parlay X. The SOAP-based interfaces include:

  • Third Party Call (Parlay X 2.1 and 3.0; Part 2)

    Using the communication service based on this interface, an application can set up a call between a caller and a callee, poll for the status of the call, and end the call. Using the 3.0 communication, an application can set up a call among multiple participants and add, delete, or transfer those participants. The application can use the Audio Call communication service to play audio messages to one or multiple of the call participants set up using Third Party Call and, using notifications set up with Call Notification PX 3.0, can also collect digits in response to playing the audio message.

  • Application-driven Quality of Service (QoS) (Parlay X 4.0; Part 17)

    Using the communication service based on this interface, an application can, in conjunction with a policy and charging rules function (PCRF) and policy and charging enforcement function (PCEF), apply, remove, modify, query, and receive notifications for QoS feature profiles which can optimize various communication performance aspects.

  • Audio Call (Parlay X 2.1 and 3.0; Part 11)

    Using the communication service based on this interface, an application can play audio to one or more call participants in an existing call session set up by the Parlay X 3.0 Third Party, find out if the audio is currently being played, and explicitly end playing the audio. It can also collect digits from a participant in response to an audio message, and with a notification set up using the Parlay X 3.0 Call communication service, can return that information to the application. It can also interrupt an ongoing interaction such as on-hold music.

  • Call Notification (Parlay X 2.1 and 3.0)

    Using the communication service based on this interface, an application can set up and end notifications on call events. For example, an application can notify a caller that the callee's line is busy. The application can then reroute the call to another party. In addition, using the Parlay X 3.0 communication service, an application can interact with Parlay X 3.0 Audio Call to return digits collected from a call participant back to the application and to end calls. The Parlay X 3.0 version is deprecated.

  • Device Capabilities (Parlay X 3.0; Part 18)

    Using the communication service based on this interface, an application can send a device's address (usually the telephone number) to an LDAP server and receive device capability information in return. The returned information can be either the device's equipment identifier (for example, an IMEI number), or the device capability information (the device's unique ID, device or model name, and a link to the User Agent Profile XML file).

  • Short Messaging (Parlay X 2.1)

    Using the communication service based on this interface, an application can send SMS text messages, ringtones, or logos to one or multiple addresses, set up and receive notifications for final delivery receipts of those sent items, and arrange to receive SMS messages from the network that meet particular criteria.

  • Multimedia Messaging (Parlay X 2.1; Part 5)

    Using this communication service based on this interface, an application can send multimedia messages to one or multiple addresses, set up and receive notifications for final delivery receipts of those sent items, and arrange to receive MMS messages from the network that meet particular criteria.

  • Terminal Location (Parlay X 2.1; Part 9)

    Using the communication service based on this interface, an application can request the position of one or more terminals or the distance between a given position and a terminal. The application can also set up and receive notifications based on geographic location or time intervals.

  • Terminal Status (Parlay X 2.1)

    Using the Terminal Status communication service, an application can:

    • Obtain the status (reachable, unreachable, or busy) of a single terminal or group of terminals as often as you specify, within a time period you specify.

    • Return the status of a terminal or group of terminals if the status changes. The terminal statuses are checked as frequently as you specify, for a time period you specify, and the status is returned if it changes.

  • Presence (Parlay X 2.1) (Part 14)

    Using the communication service based on this interface, an application can act as either a presentity or as a watcher in a presence interaction. A presentity agrees to ensure data (called attributes) such as current activity, available. The data can be current activity, available means of communication, contact addresses, or other information. A watcher is a consumer of such data. As a watcher, an application can request to subscribe to all or a subset of a presentity's data, poll for that data, and start and end presence notifications. As a presentity, an application can publish presence data about itself, check whether any new watchers wish to subscribe to its presence data, authorize watchers to access presence data, block watchers from accessing presence data, and get a list of currently subscribed watchers.

  • Payment (Parlay X 3.0; Part 6)

    Using the communication service based on this interface, an application can charge a user's account a specific amount, refund an amount, and split costs among multiple users. An application can also reserve an amount in an account, extend the amount associated with that reservation, make a charge against that reservation, or release the reservation.

  • Application-driven Quality of Service (Extended Web Service)

    Using the communication service based on this interface, an application can, in conjunction with a PCRF and PCEF, apply, remove, modify and query QoS templates which can optimize various communication performance aspects.

  • Binary Short Messaging (Extended Web Services)

    Using the communication service based on this interface, an application can send and receive generic binary objects (for example, a vCard) using SMS mechanisms, and set up and receive notifications. This interface is not based on the Parlay X standards, but instead belongs to the Services Gatekeeper Extended Web Services (EWS) set.

  • WAP Push (Extended Web Services)

    Using the communication service based on this interface, an application can send a WAP Push message, send a replacement WAP Push message, or set up status notifications about previously sent messages. The application-facing interface of this communication service is not based on the Parlay X 2.1 specification. Many elements within it, however, are based on widely distributed standards.

  • Subscriber Profile (Extended Web Services)

    Using the communication service based on this interface, an application can retrieve particular information or an entire profile (subject to internal filtering) for a subscriber from an LDAP server attached to the network. The application-facing interface of this communication service is based on a subset of that in a proposed Parlay X version.

  • Session Manager (Extended Web Services)

    Using the communication service based on this interface, an application can establish a Services Gatekeeper session. Whether sessions are used is up to the operator.

For details, see "Creating Applications Using the SOAP Interfaces."

RESTful Interfaces

The RESTful interfaces provide access to functionality similar to the SOAP Facade. The RESTful interfaces include:

  • Audio Call

    Using the communication service based on this interface, an application can play an audio file to one or more call participants in a call session. It is also possible to collect digits from a participant in response to the audio, and return that participant to the application.

  • Call Notification

    Using the communication service based on this interface, an application can set up and remove call notifications. Call notifications notify the application about the particular state of the call, such as busy, unreachable, and so on. Call direction notifications query the application for information about how to handle a call that is in a particular state.

  • Device Capabilities and Configuration

    Using the communication service based on this interface, an application can send a device's address (usually the telephone number) to an LDAP server and receive device capability information in return. The returned information can be either the device's equipment identifier (for example, an IMEI number), or device capability information (the device's unique ID, device or model name, and a link to the User Agent Profile XML file).

  • Email

    Using the communication service based on this interface, an application can send and receive emails. This communication service uses MMS in the northbound interface and a plug-in that enables the sending of email through SMTP and receiving email through POP3 and IMAP protocols. See the discussion about "Parlay X 2.1 Multimedia Messaging/SMTP, POP3, and IMAP" in Services Gatekeeper Communication Service Reference Guide.

  • Multimedia Messaging

    Using the communication service based on this interface, an application can send MMS messages, fetch MMS messages, and fetch information on MMS messages that have been received and stored on Services Gatekeeper. The application can also get delivery status on sent messages, and start and stop a notification.

  • Payment

    Using the communication service based on this interface, an application can charge an amount to a user's account using Diameter, refund amounts to that account, and split charge amounts among multiple users. An application can also reserve amounts, reserve additional amounts, charge against the reservation, or release the reservation.

  • Presence

    Using the communication service based on this interface, an application can act as either a presentity or a watcher in a presence interaction.

    A presentity agrees to ensure that data (called attributes) is available to others. The data can be current activity, available means of communication, contact addresses, or other information. As a presentity, an application can publish presence data about itself, check whether any new watchers wish to subscribe to its presence data, authorize watchers it chooses to access the data, block watchers from accessing the data, and get a list of currently subscribed watchers.

    A watcher is a consumer of such data. As a watcher, an application can request to subscribe to all or a subset of a presentity's data, poll for that data, and start and end presence notifications.

  • Short Messaging

    Using the communication service based on this interface, an application can send an SMS message, a ringtone, or a logo, and fetch SMS messages and delivery status reports that have been received and stored on Services Gatekeeper, start and stop a notification.

  • Terminal Location

    Using the communication service based on this interface, an application can get a location for an individual terminal or a group of terminals; get the distance of the terminal from a specific location, and start and stop notifications based on geographic location or on a periodic interval.

  • Terminal Status (Parlay X 2.1)

    Using the communication service based on this interface, an application can request the status (such as reachable, unreachable, or busy) of a single terminal; request the status of a group of terminals; or request to be notified if a terminal status changes within a specified time period.

  • Third Party Call

    Using the communication service based on this interface, an application can set up a call, get information on that call, cancel the call request before it is successfully completed, or end a call that has been successfully set up.

  • WAP Push

    Using the communication service based on this interface, an application can send a WAP Push message and receive status notifications about that message.

  • Session Manager

    Using the communication service based on this interface, an application can establish a session with the Services Gatekeeper operator. Operators can choose whether to use Services Gatekeeper in session-based mode.

  • Subscriber Profile

    Using the communication service based on this interface, an application can query an operator's database for the attributes of an individual subscriber profile (for example, the terminal type), or for entire subscriber profiles.

For details, see "Creating Applications Using the RESTful Interfaces."

RESTful OneAPI Interfaces

The OneAPI interfaces provide access to RESTful OneAPI operation. The interfaces include:

  • Short Messaging

    Using the communication service based on this interface, an application can send SMS messages, fetch SMS messages, deliver status reports, and to start and stop notifications.

  • Multimedia Messaging

    Using the communication service based on this interface, an application can send MMS messages, fetch MMS messages and delivery status reports, and to start and stop notifications.

  • Terminal Location

    Using the communication service based on this interface, an application can get a location for an individual terminal or a group of terminals.

  • Payment

    Using the communication service based on this interface, an application can charge an amount to a user's account using Diameter and to refund amounts to that account. Applications can also reserve amounts, reserve additional amounts, charge against the reservation or release the reservation.

For details, see "Creating Applications Using the OneAPI RESTful Interfaces."

Native Interfaces

The Native interfaces provide access to native telecom-specific protocols. The interfaces include:

  • Native MM7

    Using the communication service based on this interface, an application can send and receive MMS messages and receive status notifications about previously sent messages. This application-facing interface is based on the 3GPP MM7 standard.

  • Native SMPP

    Using the communication service based on this interface, an application can send and receive SMS messages and receive status notifications about previously sent messages. This application-facing interface is based on the SMS Forum standard.

  • Native UCP

    Using the communication service based on this interface, an application can establish a session with application clients and the network, submit and receive SMS messages, and receive status notifications about previously sent messages. This application-facing interface is based on the Short Message Service Center EMI-UCP Interface 5.1 specification. It exposes Universal Computer Protocol (UCP) protocol to applications and uses UCP to connect to a Short Message Service Center (SMSC).

For details, see "About the Supported SOAP Native Facade."