hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
595
| content
stringlengths 0
6.67M
|
|---|---|---|---|
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6 Third Party Call | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.1.1 Description | Currently, in order to perform a third party call in telecommunication networks we have to write applications using specific protocols to access Call Control functions provided by network elements (specifically operations to initiate a call from applications). This approach requires a high degree of network expertise. We can also use the OSA gateway approach, invoking standard interfaces to gain access to call control capabilities, but these interfaces are usually perceived to be quite complex by application IT developers. Developers must have advanced telecommunication skills to use Call Control OSA interfaces.
In this subclause we describe a Parlay X Web Service, Third Party Call, for creating and managing a call initiated by an application (third party call). The overall scope of this Web Service is to provide functions to application developers to create a call in a simple way. Using the Third Party Call Web Service, application developers can invoke call handling functions without detailed telecommunication knowledge. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.1.2 Commercial & Technical Rationale | The basic commercial rationale for developing the Third Party Call Web Service is:
• to increase the use of Call Control capabilities in software applications
• to empower traditional IT developers to produce large numbers of such applications
• to lower the development cost and time for such applications. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.1.3 Relationship to Similar or Supplanted Specifications | In the PSTN/Internet Interworking (PINT) working group a "request to call" scenario has been defined (RFC 2848 [8]). A request is sent to an IP host that cause a phone call to be made, connecting party A to some remote party B.
The PINT approach is not API-based but instead it proposes an extension to SIP to implement the scenarios identified. The Third Party Call Web Service proposed here while addressing similar scenarios aims at providing a high-level Web Services interface to invoke the service. It does not aim at defining a concrete architecture implementing the functionality. Therefore the two specifications are at different levels of abstraction. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.1.4 Scenarios | shows an scenario using the Third Party Call Web Service to handle third party call functions. The application invokes a web service to retrieve stock quotes and a Parlay X Interface to initiate a third party call between a broker and his client.
In the scenario, whenever a particular stock quote reaches a threshold value (1) and (2), the client application invokes a third party call between one or more brokers and their corresponding customers to decide actions to be taken. After invocation (3) by the application, the Third Party Call Web Service invokes a Parlay API method (4) using the Parlay/OSA SCS-CC (Call control) interface. This SCS handles the invocation and sends a message (5) to an MSC to set-up a call between user A and user B.
In an alternative scenario, the Parlay API interaction involving steps (4) and (5) could be replaced with a direct interaction between the Third Party Call Web Service and the Mobile network.
Figure 2: Third Party Call Scenario |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.2 Call API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• makeACall
• getCallInformation
• endCall
• cancelCallRequest |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.2.1 Attempt Immediate Call Set-Up Between Two Addresses | a) makeACall(EndUserIdentifier callingParty, EndUserIdentifier calledParty, String charging, out String callIdentifier)
b) Behaviour:
The invocation of makeACall requests to set-up a voice call between two addresses, callingParty and calledParty, provided that the invoking application is allowed to connect them. Optionally the application can also indicate the charging arrangements (charging), i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
By invoking this operation the application requires to monitor the status of the requested call. The returned parameter, callIdentifier, can be used to identify the call. In order to receive the information on call status the application has to explicitly invoke getCallInformation.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the first user involved in the call
calledParty
EndUserIdentifier
It contains the address of the second user involved in the call
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the call and how much. If the named charge plan does not exist, the InvalidArgumentException is thrown. If no charge plan is specified, charging occurs in accordance with an operator-specific charging policy.
callIdentifier
String
OUTPUT. It identifies a specific call request
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.2.2 Get Current Status of a Call | a) getCallInformation(String callIdentifier, out CallInformationType callInformation)
b) Behaviour:
The invocation of getCallInformation retrieves the current status, callInformation, of the call identified by callIdentifier. This method can be invoked multiple times by the application even if the call has already ended. However, after the call has ended, status information will be available only for a limited period of time that should be specified in an off-line configuration step.
c) Parameters:
NAME
TYPE
DESCRIPTION
callIdentifier
String
It identifies a specific call request
callInformation
CallInformationType
OUTPUT. It identifies the status of the call
d) Exceptions:
UnknownCallIdentifierException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.2.3 End a Call | a) endCall(String callIdentifier)
b) Behaviour:
The invocation of endCall terminates the call identified by callIdentifier. If the call is still in the initial state this method has the same effect as the cancelCallRequest method.
c) Parameters:
NAME
TYPE
DESCRIPTION
callIdentifier
String
It identifies a specific call request
d) Exceptions:
CallTerminatedException
UnknownCallIdentifierException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.2.4 Cancel a Call Request | a) cancelCallRequest(String callIdentifier)
b) Behaviour:
The invocation of cancelCallRequest cancels the previously requested call identified by callIdentifier. Note that this method differs from the endCall method since it only attempts to prevent the call from starting but it does not have any effect if the call has already started.
c) Parameters:
NAME
TYPE
DESCRIPTION
callIdentifier
String
It identifies a specific call request
d) Exceptions:
CallConnectedException
UnknownCallIdentifierException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3 Web Service Data Definitions | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3.1 Data Types | In addition to the Common Data Types defined in clause 5, the following Data Types are specific to this Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3.1.1 CallInformationType | The CallInformationType data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
callStatus
CallStatus
It indicates the current status of the call (see possible values below)
startTime
DateTime
When applicable (callStatus <> CallInitial), it indicates the time of the beginning of the call
duration
Integer
When applicable (callStatus = CallTerminated), it indicates the duration of the call expressed in seconds
terminationCause
CallTerminationCause
When applicable (callStatus = CallTerminated), it indicates the cause of the termination of the call (see possible values below) |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3.1.2 CallStatus | The CallStatus data type is an enumeration with the following values:
VALUE
DESCRIPTION
CallInitial
The call is being established
CallConnected
The call is active
CallTerminated
The call was terminated |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3.1.3 CallTerminationCause | The CallTerminationCause data type is an enumeration with the following values:
VALUE
DESCRIPTION
CallingPartyNoAnswer
Calling Party did not answer
CalledPartyNoAnswer
Called Party did not answer
CallingPartyBusy
Calling Party was busy
CalledPartyBusy
Called Party was busy
CallingPartyNotReachable
Calling Party was not reachable
CalledPartyNotReachable
Called Party was not reachable
CallHangUp
The call was terminated by either party hanging up
CallAborted
The call was aborted (any other termination cause) |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.3.2 Exceptions | In addition to the Common Exceptions defined in clause 5.2, there are exceptions specific to this Web Service. Similar to the Common Exceptions, each Web Service-specific exception is assigned an eight-character identifier. This identifier is interpreted as described in clause 5.2, except that the first 3 characters uniquely identify this Web Service.
The following exceptions are specific to this Web Service:
UNIQUE ID
TEXT STRING
MEANING
3PC1000W
CallConnectedException
The call was already active
3PC1001W
CallTerminatedException
The call is already terminated
3PC1002E
UnknownCallIdentifierException
The callIdentifier supplied does not relate to any known call request or has expired. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 6.4 Web Service Syntax – WSDL | The W3C WSDL representation of this API is contained in a set of files which accompany the present document (see Annex A).
The rpc/literal files are
• parlayx_third_party_calling_types.xsd
• parlayx_third_party_calling_service_port.wsdl
• parlayx_third_party_calling_service.wsdl
The rpc/encoded file is
• parlayx_third_calling_party_service.wsdl. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7 Network-Initiated Third Party Call | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.1 Description | Currently, in order to determine the handling of a subscriber initiated call in telecommunication networks we have to write applications using specific protocols to access Call Control functions provided by network elements. This approach requires a high degree of network expertise. We can also use the OSA gateway approach, invoking standard interfaces to gain access to call control capabilities, but these interfaces are usually perceived to be quite complex by application IT developers. Developers must have advanced telecommunication skills to use Call Control OSA interfaces.
In this subclause we will describe a Parlay X Web Service, Network-Initiated Third Party Call, for handling calls initiated by a subscriber in the network. A (third party) application determines how the call should be treated. The overall scope of this Web Service is to provide simple functions to application developers to determine how a call should be treated. Using the Network-Initiated Third Party Call Web Service, application developers can perform simple handling of network-initiated calls without specific Telco knowledge. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.2 Commercial & Technical Rationale | The basic commercial rationale for developing the Network-Initiated Third Party Call Web Service is:
• to increase the use of Call Control capabilities in software applications
• to empower traditional IT developers to produce large numbers of such applications
• to lower the development cost and time for such applications. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.3 Relationship to Similar or Supplanted Specifications | All the capabilities of the Network-Initiated Third Party Call Web Service (and more) can also be achieved with the Parlay/OSA generic call control or multiparty call control services. The Network-Initiated Third Party Call Web Service can be seen as a very limited subset of the network initiated call control functionality present in Parlay/OSA. This has the advantage that the application needs less telecom knowledge. The disadvantage is that the control over the call is much reduced. Basically, a Parlay X application can only choose to release, continue or re-route the call. It does not have control over the specific parameters used in the call (e.g., on the presentation indicators of the addresses), nor can the application control the call over a longer period of time. Furthermore, it is not likely that the robustness and performance requirements of Parlay/OSA services will be matched by the Network-Initiated Third Party Call Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.4 Scenarios | This subclause gives some possible scenarios using the Network-Initiated Third Party Call Web Service to handle network-initiated calls. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.4.1 Incoming call handling | A subscriber receives a call while he is logged-on to the Internet. Since this occupies his telephone connection, he is regarded as busy by the network. The subscriber has an application that is invoked when somebody tries to call him while he is busy. The application provides the subscriber with a list of choices on how to handle the call (e.g., route the call to voicemail, redirect the call to a secretary, reject the call). Based on the response of the subscriber the call is handled in the network.
Alternatively, the call be re-routed or released depending on the preferences of the subscriber and some context information (e.g., based on the status or location of the subscriber). |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.1.4.2 Service numbers | An application is triggered whenever a certain service number is dialled. This number is used to connect the caller to one of the maintenance personnel. The application redirects the call to the appropriate maintenance person based on, e.g., calling party number, time, location and availability of the maintenance personnel. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2 Call API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• handleBusy
• handleNotReachable
• handleNoAnswer
• handleCalledNumber
• handleOffHook
These messages are initiated by the Network-Initiated Third Party Call Web Service (running in a Parlay X Gateway) and invoke an application web service(s), as a result of activity in the network. The result of the invocation is used as an indication on how the call should be handled in the network.
Note that because the results of the invocations of the application web service(s) determine call handling in the network, the names of the methods are prefixed with 'handle', rather than 'notify'. The prefix 'notify' would imply a more asynchronous behaviour, whereas 'handle' shows the synchronous nature of these invocations.
The type of events (busy, answer etc.) and related numbers, for which the application web service(s) should be invoked, should be determined by the operator in an off-line process. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2.1 Request Application Handling of a 'Busy' Condition | a) handleBusy(EndUserIdentifier callingParty, EndUserIdentifier calledParty, out Action action)
b) Behaviour:
The invocation of handleBusy requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is busy when the call is received. The application returns the action, which directs the gateway to perform one of the following actions:
• "Continue", resulting in normal handling of the busy event in the network, e.g. playing of a busy tone to the callingParty
• "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific
• "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging arrangements, i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the caller.
calledParty
EndUserIdentifier
It contains the address of the called party. This party is busy.
action
Action
OUTPUT. It indicates the action to be performed by the gateway.
d) Exceptions:
ApplicationException
UnknownEndUserException
InvalidArgumentException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2.2 Request Application Handling of a 'Not Reachable' Condition | a) handleNotReachable(EndUserIdentifier callingParty, EndUserIdentifier calledParty, out Action action)
b) Behaviour:
The invocation of handleNotReachable requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is not reachable when the call is received. The application returns the action, which directs the gateway to perform one of the following actions:
• "Continue", resulting in normal handling of the 'not reachable' event in the network, e.g. playing of a busy tone to the callingParty
• "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific
• "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging arrangements, i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the caller.
calledParty
EndUserIdentifier
It contains the address of the called party. This party is not reachable.
action
Action
OUTPUT. It indicates the action to be performed by the gateway.
d) Exceptions:
ApplicationException
UnknownEndUserException
InvalidArgumentException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2.3 Request Application Handling of a 'No Answer' Condition | a) handleNoAnswer(EndUserIdentifier callingParty, EndUserIdentifier calledParty, out Action action)
b) Behaviour:
The invocation of handleNoAnswer requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty does not answer the received call. The application returns the action, which directs the gateway to perform one of the following actions:
• "Continue", resulting in normal handling of the 'no answer' event in the network, e.g. playing of a busy tone to the callingParty
• "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific
• "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging arrangements, i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the caller.
calledParty
EndUserIdentifier
It contains the address of the called party. This party does not answer the call.
action
Action
OUTPUT. It indicates the action to be performed by the gateway.
d) Exceptions:
ApplicationException
UnknownEndUserException
InvalidArgumentException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2.4 Request Application Handling of a 'Called Number' Condition | a) handleCalledNumber(EndUserIdentifier callingParty, EndUserIdentifier calledParty, out Action action)
b) Behaviour:
The invocation of handleCalledNumber requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty. The method is invoked when the callingParty tries to call the calledParty, but before the network routes the call to the calledParty. For example, the calledParty does not have to refer to a real end user, i.e., it could be a service number. The application returns the action, which directs the gateway to perform one of the following actions:
• "Continue", resulting in normal handling in the network, i.e. the call will be routed to the calledParty number, as originally dialled
• "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific
• "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging arrangements, i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the caller.
calledParty
EndUserIdentifier
It contains the address of the called party.
action
Action
OUTPUT. It indicates the action to be performed by the gateway.
d) Exceptions:
ApplicationException
UnknownEndUserException
InvalidArgumentException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.2.5 Request Application Handling of an 'Off Hook' Condition | a) handleOffHook(EndUserIdentifier callingParty, out Action action)
b) Behaviour:
The invocation of handleOffHook requests the application to inform the gateway how to handle the fact that the callingParty tries to initiate a call. The application returns the action, which directs the gateway to perform one of the following actions:
• "Continue", resulting in normal handling in the network, i.e. the calling party can enter digits and, when enough digits are entered, the call is routed based on this information
• "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific
• "Route", resulting in the call being routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging arrangements, i.e. the name of an operator-specific charging plan that defines who to charge for the call and how much.
c) Parameters:
NAME
TYPE
DESCRIPTION
callingParty
EndUserIdentifier
It contains the address of the caller.
action
Action
OUTPUT. It indicates the action to be performed by the gateway.
d) Exceptions:
ApplicationException
UnknownEndUserException
InvalidArgumentException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.3 Web Service Data Definitions | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.3.1 Data Types | In addition to the Common Data Types defined in clause 5.1, the following Data Types are specific to this Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.3.1.1 Action | The Action data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
actionToPerform
ActionValues
Indicates the action as described below
routingAddress
EndUserIdentifier
The address to be used in case the action indicates 'Route'
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the call and how much. If no charge plan is specified, the charging will be based on an operator-specific charging policy. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.3.1.2 ActionValues | The ActionValues data type is an enumeration with the following values:
VALUE
DESCRIPTION
Route
Request to (re-)route the call to the address indicated with routingAddress.
Continue
Request to continue the call without any changes. This will result in normal handling of the event in the network
EndCall
Request to end the call. This will result in termination of the call. The callingParty will receive a tone or announcement. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.3.2 Exceptions | All exceptions thrown by this Web Service are Common Exceptions, as defined in clause 5.2. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 7.4 Web Service Syntax – WSDL | The W3C WSDL representation of this API is contained in a set of files which accompany the present document (see Annex A).
The rpc/literal files are
• parlayx_network_initiated_call_types.xsd
• parlayx_network_initiated_call_service_port.wsdl
• parlayx_network_initiated_call_service.wsdl
The rpc/encoded file is
• parlayx_network_initiated_call_service.wsdl. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8 SMS | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.1.1 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 (e.g., SMS-C). This approach requires a high degree of network expertise. Alternatively it is possible to use the Parlay/OSA approach, invoking standard interfaces (e.g., 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 chapter we describe a Parlay X Web Service, SMS for sending and receiving SMS. 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.
For sending a message to the network (see clause 8.2 of the present document, Send SMS API), the application invokes a message to send it and must subsequently become active again to poll for delivery status. There is an alternative to this polling mechanism, i.e. an asynchronous notification mechanism implemented with an application-side web service. However it was decided not to provide a notification mechanism in the first release, to make the API as simple as possible, even though the polling mechanism is not as network efficient as the notification mechanism.
For receiving a message from the network, the application may use either polling (see clause 8.4 of the present document, Receive SMS API) or notification (see clause 8.3 of the present document, SMS Notification API) mechanisms. The notification mechanism is more common: network-initiated messages are sent to autonomous application-side web services. Both mechanisms are supported, but the provisioning of the notification-related criteria is not specified. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.1.2 Commercial & Technical Rationale | The basic commercial rationale for developing the SMS Web Service is:
• to increase the use of SMS capabilities in software applications
• to empower traditional IT developers to produce large numbers of such applications
• to lower the development cost and time for such applications. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.1.3 Relationship to Similar or Supplanted Specifications | Published web services exist that allow transmission of SMS messages, ring-tones and operator logos. For example, the Xmethods site (http://www.xmethods.com/) hosts more than one web service to handle SMS. These web services provide basic SMS capabilities, each using a different interfaces. The SMS Web Service aims to be a standard way to perform SMS operations and to provide more advanced features.
To specify the format of logos and ringtones, the following alternatives exist:
• 3GPP EMS format (see Note).
• Smart Messaging format.
• Other proprietary formats
NOTE: EMS (Enhanced Messaging Service) is an enhancement to SMS that provides the ability to send a combination of simple melodies, pictures, sounds, animations, modified text and standard text as an integrated message for display on an EMS compliant handset. EMS is standardized in 3GPP TS 23.040 [3] where the coding mechanisms and formats are specified.
Both the standardized EMS format and de facto Smart Messaging formats are supported. As an enhancement to SMS for sending content, dedicated methods are proposed taking into account the different content formats applied on the market. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.1.4 Scenarios | Figure 3 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) & (2) and a Parlay X Interface (3) to use the SMS Web Service operations (i.e. to send an SMS). After invocation, the SMS Web Service invokes a Parlay API method (4) using the Parlay/OSA SCS-SMS (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 3: Send SMS Scenario
Figure 4 shows a scenario using the SMS Web Service to deliver a received SMS message to an application. The application receives a Parlay X web service invocation to retrieve an SMS sent by a subscriber (1) & (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 4: Receive SMS Scenario |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.2 Send SMS API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of the SMS Web Service by the application) are:
• sendSms
• sendSmsLogo
• sendSmsRingtone
• getSmsDeliveryStatus. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.2.1 Send an SMS Message | a) sendSms (EndUserIdentifier[] destinationAddressSet, String senderName, String charging, String message, out String requestIdentifier)
b) Behaviour:
The invocation of sendSms requests to send an SMS, specified by the String message to the specified address (or address set), specified by destinationAddressSet. Optionally the application can also indicate the sender name (senderName), i.e. the string that is displayed on the user's terminal as the originator of the message, and the charging arrangements (charging), i.e. the name of an operator-specific charging plan that defines who to charge for the SMS and how much. By invoking this operation the application requires to receive the notification of the status of the SMS delivery. In order to receive this information the application has to explicitly invoke the getSmsDeliveryStatus. The requestIdentifier, returned by the invocation, can be used to identify the SMS delivery request.
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 (e.g. for GSM, 160 GSM 7-bit characters or 70 Unicode characters), the message will be sent as several concatenated short messages.
c) Parameters:
NAME
TYPE
DESCRIPTION
destinationAddressSet
Array of EndUserIdentifier
Addresses to which the SMS will be sent
senderName
String
If present, it indicates the SMS sender name, i.e. the string that is displayed on the user's terminal as the originator of the message.
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the SMS and how much. If the named charge plan does not exist, the InvalidArgumentException is thrown. If no charge plan is specified, the sending service/application will be charged, based on an operator-specific charging policy.
message
String
Text to be sent in SMS
requestIdentifier
String
OUTPUT. It identifies a specific SMS delivery request
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ServiceException
MessageTooLongException
PolicyException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.2.2 Send an SMS Logo | a) sendSmsLogo(EndUserIdentifier[] destinationAddressSet, String senderName, String charging, Base64Binary image, SmsFormat smsFormat, out String requestIdentifier)
b) Behaviour:
The invocation of sendSmsLogo requests to send an SMS logo, specified by the byte array image to the specified address (or address set), specified by destinationAddressSet. Optionally the application can also indicate the sender name (senderName), i.e. the string that is displayed on the user's terminal as the originator of the message, and the charging arrangements (charging), i.e. the name of an operator-specific charging plan that defines who to charge for the SMS logo and how much. By invoking this operation the application requires to receive the notification of the status of the SMS delivery. In order to receive this information the application has to explicitly invoke the getSmsDeliveryStatus. The requestIdentifier, returned by the invocation, can be used to identify the SMS delivery request.
c) Parameters:
NAME
TYPE
DESCRIPTION
destinationAddressSet
Array of EndUserIdentifier
Addresses to which the SMS logo will be sent
senderName
String
If present, it indicates SMS sender name, i.e. the string that is displayed on the user's terminal as the originator of the message.
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the SMS logo and how much. If the named charge plan does not exist, the InvalidArgumentException is thrown. If no charge plan is specified, the sending service/application will be charged, based on an operator-specific charging policy.
image
Base64Binary
The image in jpeg, gif or png format. The image will be scaled to the proper format.
smsFormat
SmsFormat
Possible values are: 'Ems',
'SmartMessaging'.
requestIdentifier
String
OUTPUT. It identifies a specific SMS delivery request
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
MessageTooLongException
UnsupportedFormatException
ServiceException
PolicyException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.2.3 Send an SMS Ringtone | a) sendSmsRingtone(EndUserIdentifier[] destinationAddressSet, String senderName, String charging, String ringtone, SmsFormat smsFormat, out String requestIdentifier)
b) Behaviour:
The invocation of sendSmsRingtone requests to send an SMS ringtone, specified by the String ringtone (in RTX format) to the specified address (or address set), specified by destinationAddressSet. Optionally the application can also indicate the sender name (senderName) i.e. the string that is displayed on the user's terminal as the originator of the message, and the charging arrangements (charging), i.e. the name of an operator-specific charging plan that defines who to charge for the SMS ringtone and how much. By invoking this operation the application requires to receive the notification of the status of the SMS delivery. In order to receive this information the application has to explicitly invoke the getSmsDeliveryStatus. The requestIdentifier, returned by the invocation, can be used to identify the SMS delivery request.
Depending on the length of the ringtone, it may be sent as several concatenated short messages.
c) Parameters:
NAME
TYPE
DESCRIPTION
destinationAddressSet
Array of EndUserIdentifier
Addresses to which the SMS ringtone will be sent
senderName
String
If present, it indicates SMS sender name, i.e. the string that is displayed on the user's terminal as the originator of the message.
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the SMS ringtone and how much. If the named charge plan does not exist, the InvalidArgumentException is thrown. If no charge plan is specified, the sending service/application will be charged, based on an operator-specific charging policy.
ringtone
String
The ringtone in RTX format (see Note). (http://www.logomanager.co.uk/help/Edit/RTX.html)
smsFormat
SmsFormat
Possible values are: 'Ems',
'SmartMessaging'.
requestIdentifier
String
OUTPUT. It identifies a specific SMS delivery request
NOTE: 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.
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
UnsupportedFormatException
MessageTooLongException
ServiceException
PolicyException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.2.4 Get Current Status of an SMS Delivery | a) getSmsDeliveryStatus(String requestIdentifier, out DeliveryStatusType[] deliveryStatus)
b) Behaviour:
The invocation of 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. 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 four different SMS delivery status have been identified:
• 'Delivered': in case of concatenated messages, only when all the SMS-parts have been successfully delivered.
• 'DeliveryUncertain': e.g. 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.
c) Parameters:
NAME
TYPE
DESCRIPTION
requestIdentifier
String
It identifies a specific SMS delivery request
deliveryStatus
Array of DeliveryStatusType
OUTPUT. It lists the variations on the delivery status of the SMS
d) Exceptions:
UnknownRequestIdentifierException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.3 SMS Notification API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of a notification web service by the SMS Web Service) are:
• notifySmsReception |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.3.1 Notify Application of an SMS Message Sent to a Specific Address | a) notifySmsReception(String registrationIdentifier, String smsServiceActivationNumber, EndUserIdentifier senderAddress, String message)
b) Behaviour:
The notifySmsReception method must be implemented by a Web Service at the application side. It will be invoked by the Parlay X server to notify the application of the reception of an SMS. The notification will occur if and only if the SMS received fulfils the criteria specified in an off-line provisioning step, identified by the registrationIdentifier. The criteria must at least include an smsServiceActivationNumber, i.e. the SMS destination address that can be "monitored" by the application. The parameter senderAddress contains the address of the sender. The application can apply the appropriate service logic to process the SMS.
c) Parameters:
NAME
TYPE
DESCRIPTION
registrationIdentifier
String
Identifies the off-line provisioning step that enables the application to receive notification of SMS reception according to specified criteria.
smsServiceActivation
Number
String
Number associated with the invoked Message service, i.e. the destination address used by the terminal to send the message.
senderAddress
EndUserIdentifier
It indicates the address sending the SMS
message
String
Text received in the SMS
d) Exceptions:
ApplicationException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.4 Receive SMS API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of the SMS Web Service by the application) are:
• getReceivedSms. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.4.1 Retrieve All SMS Messages Sent to a Specific Address | a) getReceivedSms(String registrationIdentifier, out SmsType[] receivedSms)
b) Behaviour:
The invocation of getReceivedSms retrieves all the SMS messages received that fulfil the criteria identified by registrationIdentifier. The method returns only the list of SMS messages received since the previous invocation of the same method, i.e. each time the method is executed the messages returned are removed from the server. Moreover, each SMS message will be automatically removed from the server after a maximum time interval specified in an off-line configuration step.
The received SMS messages are returned in receivedSms. An SMS message is identified by a structure indicating the sender of the SMS message and the content.
c) Parameters:
NAME
TYPE
DESCRIPTION
registrationIdentifier
String
Identifies the off-line provisioning step that enables the application to receive notification of SMS reception according to specified criteria.
receivedSms
Array of SmsType
OUTPUT. It lists the received SMS since last invocation.
d) Exceptions:
UnknownRegistrationIdentifierException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5 Web Service Data Definitions | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.1 Data Types | In addition to the Common Data Types defined in clause 5.1, the following Data Types are specific to this Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.1.1 DeliveryStatusType | The DeliveryStatusType data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
destinationAddress
EndUserIdentifier
It indicates the destination address to which the notification is related
deliveryStatus
DeliveryStatus
Indicates the delivery result for destinationAddress. Possible values are: 'Delivered', 'DeliveryUncertain', 'DeliveryImpossible'. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.1.2 DeliveryStatus | The DeliveryStatus data type is an enumeration with the following values:
VALUE
DESCRIPTION
Delivered
Successful delivery
DeliveryUncertain
Delivery status unknown: e.g. 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. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.1.3 SmsType | The SmsType data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
message
String
Text received in SMS
senderAddress
EndUserIdentifier
It indicates address sending the SMS |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.1.4 SmsFormat | The SmsFormat data type is an enumeration with the following values:
VALUE
DESCRIPTION
Ems
Enhanced Messaging Service, standardized in 3GPP TS 23.040 [3], which defines a logo/ringtone format
SmartMessagingTM
Defines a logo/ringtone format |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.5.2 Exceptions | In addition to the Common Exceptions defined in clause 5.2, there are exceptions specific to this Web Service. Similar to the Common Exceptions, each Web Service-specific exception is assigned an eight-character identifier. This identifier is interpreted as described in clause 5.2, except that the first 3 characters uniquely identify this Web Service.
The following exceptions are specific to this Web Service:
UNIQUE ID
TEXT STRING
MEANING
SMS1000E
UnsupportedFormatException
The smsFormat supplied is not one of the permitted values of the SmsFormat data type.
SMS1001E
UnknownRegistration
IdentifierException
The registrationIdentifier supplied is not known by the server
SMS1002E
UnknownRequestIdentifier
Exception
The requestIdentifier supplied does not relate to any known SMS request or has expired. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 8.6 Web Service Syntax – WSDL | The W3C WSDL representation of this API is contained in a set of files which accompany the present document (see Annex A).
The rpc/literal files are
• parlayx_sms_types.xsd
• parlayx_sms_service_port.wsdl
• parlayx_sms_send_service.wsdl
• parlayx_sms_receive_service.wsdl
• parlayx_sms_notification_service_port.wsdl
• parlayx_sms_notification_service.wsdl
The rpc/encoded files are
• parlayx_sms_service.wsdl
• parlayx_sms_notification_service.wsdl |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9 Multimedia Message | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.1.1 Description | Currently, in order to programmatically receive and send Multimedia Messages, it is necessary to write applications using specific protocols to access MMS functions provided by network elements (e.g., MMS-C). This approach requires application developers to have a high degree of network expertise.
This contribution defines a Multimedia Message Web Service that can map to SMS, EMS, MMS, IM, E-mail etc.
The choice is between defining one set of APIs per messaging network or a single set common to all networks; e.g. we could define sendMMS, sendEMS, sendSMS, … or just use sendMessage. Although the more specific the API the easier it is to use, there are advantages to a single set of network-neutral APIs. These advantages include:
• improved service portability
• lower complexity, by providing support for generic user terminal capabilities only.
For this version of the Parlay X specification, we provide sets of APIs for two messaging web services: SMS-specific APIs (as described in clause 8) and Multimedia Message APIs (this clause), which provides generic messaging features (including SMS).
For sending a message to the network (see clause 9.2 of the present document, Send Message API), the application invokes a message to send it and must subsequently become active again to poll for delivery status. There is an alternative to this polling mechanism, i.e. an asynchronous notification mechanism implemented with an application-side web service. However it was decided not to provide a notification mechanism in the first release, to make the API as simple as possible, even though the polling mechanism is not as network efficient as the notification mechanism.
For receiving a message from the network, the application may use either polling (see clause 9.3 of the present document, Receive Message API) or notification (see clause 9.4 of the present document, Message Notification API) mechanisms. The notification mechanism is more common: network-initiated messages are sent to autonomous application-side web services. Both mechanisms are supported, but the provisioning of the notification-related criteria is not specified. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.1.2 Commercial & Technical Rationale | The scope of this Web Service is much more than an enhancement of the Parlay X SMS Web Service. The purpose is not to add more SMS features, but to form a generic multimedia adapted messaging API. The reason to incorporate SMS in the API is mainly to create one set of APIs for messaging instead of one set per network. We believe that the benefits of a single set of APIs, i.e. service portability and the ability to serve different handsets or even multiple sub-networks using common APIs, is highly beneficial for both the Network Operators and the Service Providers. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.1.3 Relationship to Similar or Supplanted Specifications | This Web Service includes functions implemented in the SMS Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.1.4 Scenarios | Figure 5 shows an example scenario using sendMessage and getMessageDeliveryStatus to send data to subscribers and to determine if the data has been received by the subscriber. The application invokes a web service to retrieve a stock quote (1) & (2) and sends the current quote - sendMessage - using the Parlay X Interface (3) of the Multimedia Message Web Service. After invocation, the Multimedia Message Web Service sends the message to an MMS-C using the MM7 interface (4) for onward transmission (5) to the subscriber over the Mobile network
Later, when the next quote is ready, the application checks to see - getMessageDeliveryStatus - if the previous quote has been successfully delivered to the subscriber. If not, it may for instance perform an action (not shown) to provide a credit for the previous message transmission. This way, the subscriber is only charged for a stock quote if it is delivered on time.
Figure 5: Multimedia Messaging Scenario |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.2 Send Message API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of the Multimedia Message Web Service by the application) are:
• sendMessage
• getMessageDeliveryStatus |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.2.1 Send a Multimedia Message | a) sendMessage(EndUserIdentifier [] destinationAddressSet, String senderAddress, String subject, MessagePriority priority, String charging, out String requestIdentifier) Attachment[content]
b) Behaviour:
Request to send a Message to a set of destination addresses, returning a requestIdentifier to identify the message. The requestIdentifier can subsequently be used by the application to poll for the message status, i.e. using getMessageDeliveryStatus to see if the message has been delivered or not. The content is sent as a SOAP-Attachment (see note) encoded using MIME or DIME.
NOTE: SOAP-Attachment is used because specification of the WS-Attachments standard is not yet complete. The decision to use SOAP-Attachment may be revisited in future releases. Please refer to your SOAP/WSDL toolkit documentation for information on populating or retrieving a SOAP-Attachment.
c) Parameters:
NAME
TYPE
DESCRIPTION
destinationAddressSet
Array of EndUserIdentifier
Destination addresses for the Message.
senderAddress
String
OPTIONAL. If present, indicates Message sender address. This parameter is not allowed for all 3rd party providers. Parlay X server needs to handle this according to a SLA for the specific application and its use can therefore result in a PolicyException.
subject
String
OPTIONAL. If present, it indicates the message subject. If mapped to SMS this parameter will be used as the senderAddress, even if a separate senderAddress is provided.
priority
MessagePriority
OPTIONAL. If present, represents the priority of the message. If not defined, the network will assign a priority based on an operator policy.
charging
String
OPTIONAL. If present, represents the name of an operator-specific charging plan that defines who to charge for the message and how much. If the named charge plan does not exist, the InvalidArgumentException is thrown. If no charge plan is specified, the sending service/application will be charged, based on operator-specific charging policy.
requestIdentifier
String
OUTPUT. It is a correlation identifier that is used in a getMessageDeliveryStatus message invocation, i.e. to poll for the delivery status of all of the sent Messages.
Input Attachments
content
MIME or DIME format
Data to be sent with Message, i.e. in MIME or DIME format and sent as a SOAP-Attachment
d) Exceptions
UnknownEndUserException
InvalidArgumentException
ServiceException
PolicyException
MessageTooLongException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.2.2 Get Current Status of a Multimedia Message Delivery | a) getMessageDeliveryStatus(String requestIdentifier, out DeliveryStatusType[] deliveryStatus)
b) Behaviour:
This is a poll method used by the application to retrieve delivery status for each message sent as a result of a previous sendMessage message invocation. The requestIdentifier parameter identifies this previous message invocation.
c) Parameters:
NAME
TYPE
DESCRIPTION
requestIdentifier
String
Identifier related to the delivery status request.
deliveryStatus
Array of DeliveryStatusType
OUTPUT. It is an array of status of the messages that were previously sent. Each array element represents a sent message: i.e. its destination address and its delivery status.
d) Exceptions
InvalidArgumentException
ServiceException
Policy Exception
UnknownRequestIdentifierException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.3 Receive Message API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of the Multimedia Message Web Service by the application) are:
• getReceivedMessages
• getMessageURIs
• getMessage |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.3.1 Provide Application with Multimedia Messages Sent to the Application | a) getReceivedMessages(String registrationIdentifier, MessagePriority priority, out MessageRef [] messageRef)
b) Behaviour:
This method enables the application to poll for new messages associated with a specific registrationIdentifier. If the registrationIdentifier is not specified, the Parlay X server will return references to all messages sent to the application. The process of binding different registrationIdentifier parameters to applications is an off-line process. The Parlay X gateway shall not allow an application to poll for messages using registrationIdentifier parameters that are not associated with the application. The priority parameter may be used by the application to retrieve references to higher priority messages, e.g. if Normal is chosen only references to high priority and normal priority messages are returned. If the priority parameter is omitted all message references are returned.
c) Parameters:
NAME
TYPE
DESCRIPTION
registrationIdentifier
String
Identifies the off-line provisioning step that enables the application to receive notification of Message reception according to specified criteria.
priority
MessagePriority
OPTIONAL. The priority of the messages to poll from the Parlay X gateway. All messages of the specified priority and higher will be retrieved. If not specified, all messages shall be returned, i.e. the same as specifying Low.
messageRef
Array of MessageRef
OUTPUT. It contains an array of messages received according to the specified filter of registrationIdentifier and priority.
d) Exceptions
InvalidArgumentException
ServiceException
PolicyException
UnknownRegistrationIdentifierException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.3.2 Retrieve URI References to the Parts of a Multimedia Message | getMessageURIs(String messageRefIdentifier, out MessageURI message)
b) Behaviour:
This method will read the different parts of the message, create local files in the Parlay Gateway and return URI references to them. The application can then simply read each file or just have them presented as links to the end-user. The URIs to the files will be active for an agreed time.
c) Parameters:
NAME
TYPE
DESCRIPTION
messageRefIdentifier
String
The identity of the message to retrieve.
message
MessageURI
OUTPUT. It contains the complete message, i.e. the textual part of the message, if such exists, and a list of file references for the message attachments, if any.
d) Exceptions
InvalidArgumentException
ServiceException
PolicyException
UnknownMessageException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.3.3 Provide Application with a Multimedia Message as an Attachment | getMessage(String messageRefIdentifier) Attachments[out content]
b) Behaviour:
This method will read the whole message. The data is returned as a SOAP-Attachment (see note) in the return message.
NOTE: SOAP-Attachment is used because specification of the WS-Attachments standard is not yet complete. The decision to use SOAP-Attachment may be revisited in future releases. Please refer to your SOAP/WSDL toolkit documentation for information on populating or retrieving a SOAP-Attachment.
c) Parameters:
NAME
TYPE
DESCRIPTION
messageRefIdentifier
String
The identity of the message
Output Attachments
content
MIME or DIME format
Data to be returned with Message, i.e. in MIME or DIME format and received as a SOAP-Attachment
d) Exceptions
InvalidArgumentException
ServiceException
PolicyException
UnknownMessageException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.4 Message Notification API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations (i.e. of a notification web service by the Multimedia Message Web Service) are:
• notifyMessageReception |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.4.1 Notify Application of a Multimedia Message Sent to a Specific Address | a) notifyMessageReception (String registrationIdentifier, MessageRef messageRef)
b) Behaviour:
This method will have to be implemented by a web service on the client application side. The registration of the URI for this application web service is done off-line. This means that there is a registration mechanism in the Parlay X Gateway that binds different registrationIdentifier parameters to applications and their web service URIs.
A client application is notified that a new Message, sent to a specific Service Activation Number, has been received. Using the registrationIdentifier, the client application can apply appropriate service logic with specific behaviour.
c) Parameters:
NAME
TYPE
DESCRIPTION
registrationIdentifier
String
A handle connected to the off-line registration of the notifications. This distinguishes registrations that point to the same application web service.
messageRef
MessageRef
This parameter contains all the information associated with the received message.
d) Exceptions
ApplicationException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5 Web Service Data Definitions | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1 Data Types | In addition to the Common Data Types defined in clause 5.1, the following Data Types are specific to this Web Service. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1.1 MessagePriority | The MessagePriority data type is an enumeration with the following values:
VALUE
DESCRIPTION
Default
This is the "NULL" value as described in subclause 4.3. This value is applicable if the parameter of type MessagePriority is tagged OPTIONAL.
Low
Low message priority
Normal
Normal message priority
High
High message priority |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1.2 DeliveryStatus | The DeliveryStatus data type is an enumeration with the following values:
VALUE
DESCRIPTION
Delivered
Successful delivery
DeliveryUncertain
Delivery status unknown: e.g. 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. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1.3 DeliveryStatusType | The DeliveryStatusType data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
destinationAddress
EndUserIdentifier
Address associated with the delivery status. The address field is coded as a URI.
deliveryStatus
DeliveryStatus
Parameter indicating the delivery status. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1.4 MessageRef | The MessageRef data type is a structure containing six parameters as described below.
This data type is used to return the basic message data when polled by the application.
• If a message is a pure text message, the content will be returned in the message parameter and the messageRefIdentifier parameter will then not be sent.
• If a message contains attachments or other non-text messages the message parameter will not be sent; instead the messageRefIdentifier will contain a reference to the message stored in the Parlay X gateway.
NAME
TYPE
DESCRIPTION
messageRefIdentifier
String
OPTIONAL: If present, contains a reference to a message stored in the Parlay X gateway. If the message is pure text, this parameter is not present.
messageService
ActivationNumber
String
Number associated with the invoked Message service, i.e. the destination address used by the terminal to send the message.
senderAddress
EndUserIdentifier
Indicates message sender address
subject
String
OPTIONAL: If present, indicates the subject of the received message. This parameter will not be used for SMS services.
priority
MessagePriority
The priority of the message: default is Normal
message
String
OPTIONAL: If present, then the messageRefIdentifier is not present and this parameter contains the whole message. The type of the message is always pure ASCII text in this case. The message will not be stored in the Parlay X gateway. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.1.5 MessageURI | The MessageURI data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
bodyText
String
Contains the message body if it is encoded as ASCII text.
fileReferences
Array of URI
This is an array of URI references to all the attachments in the Multimedia message. These are URIs to different files, e.g. GIF pictures or pure text files. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.5.2 Exceptions | In addition to the Common Exceptions defined in clause 5.2, there are exceptions specific to this Web Service. Similar to the Common Exceptions, each Web Service-specific exception is assigned an eight-character identifier. This identifier is interpreted as described in clause 5.2, except that the first 3 characters uniquely identify this Web Service.
The following exceptions are specific to this Web Service:
UNIQUE ID
TEXT STRING
MEANING
MMM1000E
UnknownRequestIdentifier
Exception
The Parlay X gateway did not recognize the requestIdentifier parameter. The message may have timed out or may have never been sent. This fault includes a string that provides additional information
MMM1001E
UnknownRegistration
IdentifierException
The provided registration identifier does not exist. This fault includes a string that provides additional information.
MMM1002E
UnknownMessageException
The provided messageRefIdentifier was not found in the Parlay X gateway. The message may have been timed out or it may never have been received by the gateway. This fault includes a string that provides additional information |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 9.6 Web Service Syntax – WSDL | The W3C WSDL representation of this API is contained in a set of files which accompany the present document (see Annex A).
The rpc/literal files are
• parlayx_mm_types.xsd
• parlayx_mm_service_port.wsdl
• parlayx_mm_send_service.wsdl
• parlayx_mm_receive_service.wsdl
• parlayx_mm_notification_service_port.wsdl
• parlayx_mm_notification_service.wsdl
The rpc/encoded file is
• parlayx_mm_service.wsdl
• parlayx_mm_notification_service.wsdl |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10 Payment | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.1 Description | A vast amount of content, both information and entertainment, will be made available to subscribers. To support a business model that enables operators to offer integrated billing, a payment API is crucial. Open and inter-operable "payment APIs" are the key to market growth and investment protection. The Payment Web Service supports payments for any content in an open, Web-like environment.
The Payment Web Service described in this document supports payment reservation, pre-paid payments, and post-paid payments. It supports charging of both volume and currency amounts, a conversion function and a settlement function in case of a financially resolved dispute.
Note that certain parameters are negotiated off line. For example the currency, volume type, default reservation enforcement time, as well as the taxation procedures and parameters. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.2 Commercial & Technical Rationale | The payment process is a complex and critical component of telecom networks. The Payment Web Service:
• further enlarges the market for third party software, services and content by providing essential primitives for integrated billing
• enables charging through trusted and authenticated service or content providers
• allows charging by subscriber address (e.g. MSISDN), against an existing reservation or directly against an account. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.3 Relationship to Similar or Supplanted Specifications | Payment APIs are the focus of a number of industry standardisation initiatives:
• Parlay/OSA have developed powerful, carrier-grade Content-Based Charging (CBC) APIs
• PayCircle intends to provide a full, hand-crafted XML version of the Parlay/OSA CBC APIs
• Within the JCP, the JPay expert group seeks to specify a local Java API that can be implemented on top of either Parlay/OSA CBC, Parlay X Payment Web Service, or PayCircle's Payment Web Service
• OMA is commencing an e-commerce initiative.
The Payment Web Service provides a simpler, higher-level, WSDL-defined interface consistent with the Parlay X philosophy. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.4 Scenarios | This subclause discusses two scenarios: one where the subscriber account is directly charged and one where a subscriber uses a service for which the provider needs a reservation. Note, associated Payment API messages are shown in 'bold' format: e.g. (chargeAmount). |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.4.1 Scenario Number 1 | Assume a subscriber is interested in downloading a ring tone to his mobile (MS). The subscriber selects a ring tone and establishes a trusted relation with the ring tone provider. Essentially, the ring tone provider obtains the address (MSISDN) and other information from the subscriber. The ring tone may be downloaded to the MS using SMS. As soon as the download succeeds, the provider of the ring tone will charge the subscriber (chargeAmount). |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.1.4.2 Scenario Number 2 | Assume a subscriber is interested in receiving a stream of, say, a soccer match. The subscriber selects a match and establishes a trusted relation with the provider. Again, the provider obtains the MSISDN and other information from the subscriber. The subscriber wants to know what the service will cost and the provider interacts with the operators rating engine (getAmount) taking into account the subscriber's subscription, time of day, etc. The value returned is a currency amount and is printed on the page that is displayed at the MS. The subscriber then decides to stream the match to his MS. Subsequently, the provider will reserve the appropriate amount with the operator (reserveAmount) to ensure that the subscriber can fulfil his payment obligations. The match starts and the provider periodically charges against the reservation (chargeReservation). The match ends in a draw and is extended with a 'sudden death' phase. The subscriber continues listening, so the existing reservation is enlarged (reserveAdditionalAmount). Suddenly, one of the teams scores a goal, so the match abruptly ends, leaving part of the reserved amount unused. The provider now releases the reservation (releaseReservation), and the remaining amount is available for future use by the subscriber.
Now we can extend the second scenario by having the subscriber participate in a game of chance in which the provider refunds a percentage of the usage costs (refundAmount) based on the ranking of a particular team in this tournament. For example, the subscriber gambling on the team that wins the tournament receives a full refund, while for gambling on the team that finishes in second place, the refund is 50%, etc. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.2 Amount Charging API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• chargeAmount
refundAmount |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.2.1 Charge Currency Amount to an Account | a) chargeAmount(EndUserIdentifier endUserIdentifier, Decimal amount, String billingText, String referenceCode)
b) Behaviour:
This message results in directly charging to the account indicated by the end user identifier. The charge is specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account to be charged
amount
Decimal
The currency amount of the charge
billingText
String
Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ChargeFailureException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.2.2 Refund Currency Amount to an Account | a) refundAmount(EndUserIdentifier endUserIdentifier, Decimal amount, String billingText, String referenceCode)
b) Behaviour:
This message results in directly applying a refund to the account indicated by the end user identifier. The refund is specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account to be refunded
amount
Decimal
The currency amount of the refund
billingText
String
Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ChargeFailureException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.3 Volume Charging API | This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• chargeVolume
• getAmount
• refundVolume |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.3.1 Charge Volume to an Account | a) chargeVolume(EndUserIdentifier endUserIdentifier, Long volume, String billingText, String referenceCode)
b) Behaviour:
This message results in directly charging to the account indicated by the end user identifier. The charge is specified as a volume. The billing text field is used for textual information to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account to be charged
volume
Long
The volume to be charged
billingText
String
Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ChargeFailureException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.3.2 Convert a Volume to a Currency Amount | a) getAmount(EndUserIdentifier endUserIdentifier, Long volume, out Decimal amount)
b) Behaviour:
This message results in converting the given volume to a currency amount. The end user identifier is given to indicate the subscriber for whom this conversion calculation must be made. The message returns a currency amount if successful.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account to be charged
volume
Long
The volume to be converted
amount
Decimal
OUTPUT. It is the currency amount resulting from the conversion process
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ServiceException |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.3.3 Refund Volume to an Account | a) refundVolume(EndUserIdentifier endUserIdentifier, Long volume, String billingText, String referenceCode)
b) Behaviour:
This message results in directly applying a refund to the account indicated by the end user identifier. The refund is specified as a volume. The billing text field is used for textual information to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account to be refunded
volume
Long
The volume to be refunded
billingText
String
Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ChargeFailureException |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.