hash stringlengths 32 32 | doc_id stringlengths 5 12 | section stringlengths 5 1.47k | content stringlengths 0 6.67M |
|---|---|---|---|
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 applicat... |
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 functiona... |
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 h... |
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 perso... |
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 Servi... |
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 re... |
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 reach... |
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... |
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 ca... |
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 foll... |
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 a... |
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 ... |
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
• parla... |
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... |
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 ... |
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 ... |
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. Optiona... |
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), spec... |
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 addres... |
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... |
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 re... |
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... |
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 ar... |
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.
MessageW... |
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 u... |
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
• p... |
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 def... |
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. ... |
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 Interf... |
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.... |
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 ... |
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 refe... |
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... |
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 us... |
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... |
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 pr... |
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.
MessageW... |
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 ... |
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,... |
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 u... |
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
• parlay... |
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... |
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
•... |
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 loca... |
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 download... |
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 provi... |
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 informati... |
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 ... |
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... |
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... |
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 ... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.4 Reserved 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:
• reserveAmount
• reserveAdditionalAmount
• chargeReservation
• releaseReservation |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.4.1 Reserve a Currency Amount from an Account | c) reserveAmount(EndUserIdentifier endUserIdentifier, Decimal amount, String billingText, out String reservationIdentifier)
b) Behaviour:
This message results in directly reserving an amount for an account indicated by the end user identifier. The reservation is specified as a currency amount. Note that reservations ... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.4.2 Adjust the Currency Amount of an Existing Reservation | a) reserveAdditionalAmount(String reservationIdentifier, Decimal amount, String billingText)
b) Behaviour:
This message results in the addition/reduction of a currency amount to/from an existing reservation indicated by the reservation id. The reservation is specified as a currency amount. Note that reservations do n... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.4.3 Charge a Currency Amount against an Existing Reservation | a) chargeReservation(String reservationIdentifier, Decimal amount, String billingText, String referenceCode)
b) Behaviour:
This message results in charging to a reservation indicated by the reservation id. Reservations, identified by reservation id, are established through invoking the reserveAmount message. The char... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.4.4 Release an Existing Reservation | a) releaseReservation(String reservationIdentifier)
b) Behaviour:
Returns funds left in a reservation indicated by reservation id to the account from which this reservation was made. Reservations, identified by reservation id, are established by invoking the reserveAmount message.
c) Parameters:
NAME
TYPE
DESCRIPTION
... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5 Reserved 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:
• getAmount
• reserveVolume
• reserveAdditionalVolume
• chargeReservation
• releaseReservation |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5.1 Convert a Volume to a Currency Amount | a) getAmount(EndUserIdentifier endUserIdentifier, Long volume, out Decimal amount)
b) Behaviour:
Returns the amount resulting from converting the given volume. The end user identifier is given to indicate the subscriber for whom this calculation must be made. The message returns a currency amount if successful.
c) Pa... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5.2 Reserve a Volume from an Account | a) reserveVolume(EndUserIdentifier endUserIdentifier, Long volume, String billingText, out String reservationIdentifier)
b) Behaviour:
Reserves an amount of an account indicated by the end user identifier. The reservation is specified as a volume. Note that reservations do not last forever; it is assumed the default ... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5.3 Adjust the Volume of an Existing Reservation | a) reserveAdditionalVolume(String reservationIdentifier, Long volume, String billingText)
b) Behaviour:
Adds/reduces a volume to an existing reservation indicated by the reservation id. The reservation is specified as a volume. Note that reservations do not last forever; it is assumed the default reservation enforcem... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5.4 Charge a Volume against an Existing Reservation | a) chargeReservation(String reservationIdentifier, Long volume, String billingText, String referenceCode)
b) Behaviour:
This message results in charging to a reservation indicated by the reservation id.. Reservations, identified by reservation id., are established through invoking the reserveVolume message. The charg... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.5.5 Release an Existing Reservation | a) releaseReservation(String reservationIdentifier)
b) Behaviour:
Returns funds left in a reservation indicated by reservation id. to the account from which this reservation was made. Reservations, identified by reservation id., are established through invoking the reserveVolume message.
c) Parameters:
NAME
TYPE
DESCR... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.6 Web Service Data Definitions | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.6.1 Data Types | All data types are defined in clause 5.1. |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.6.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 u... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 10.7 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_payment_service_port.wsdl
• parlayx_payment_amount_charging_service
• parlayx_payment_volume_charging_service
• parlayx_payment_reserve_amount_charging_service
•... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11 Account management | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11.1 Overview | |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11.1.1 Description | Pre-paid subscribers, whether they have subscribed to pre-paid telephony, SMS, or data service, have credits with their service providers; the consumption of services will lead to reduction of their credit, or the credit may expire. Therefore, from time to time, subscribers may have to recharge their accounts. This o... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11.1.2 Commercial & Technical Rationale | The recharging process is a critical component of telecom networks. At present, a number of prepaid services exist: e.g. Voice, SMS, and GPRS. The Account Management Web Service:
• further enlarges the market for third party software and outsourcing as it supports subscriber self service through re-charging, account q... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11.1.3 Relationship to Similar or Supplanted Specifications | Parlay/OSA have developed powerful, carrier-grade Content-Based Charging (CBC) and Account Management (AM) APIs. The CBC APIs can be used to do recharging, but they also enable many other functions (e.g. debiting from accounts) as well. The AM APIs support some subscriber self-service (i.e. query functions), but they... |
e3edf551830c62df14a4eaeee607bff5 | 29.199 | 11.1.4 Scenarios | This subclause discusses three scenarios; one where a subscriber uses a voucher, one where the subscriber directly recharges after the payment is cleared, and one where the subscriber checks the recent transactions. Note, associated Account Management API messages are shown in 'bold' format: e.g. (getBalance). |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.