hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
1.47k
| content
stringlengths 0
6.67M
|
|---|---|---|---|
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
|
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 do not last forever; it is assumed the default reservation enforcement time is negotiated off-line. If the reservation times out, the remaining funds will be returned to the account from which this reservation was made. However, the remaining funds shall preferably be returned explicitly to the account using the releaseReservation message. The billing text field is used for textual information to appear on the bill. Subsequent textual information provided during this charging session will be appended to this textual information; one charging session to a reservation will result in only one entry on the bill. In case of success, a reservation id is returned for future reference; e.g. subsequent charging against the existing reservation using the chargeReservation message.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account subject to the reservation
amount
Decimal
The currency amount of the reservation
billingText
String
Textual information to appear on the bill
reservationIdentifier
String
OUTPUT. It is an identifier for the newly created reservation
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ServiceException
|
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 not last forever; it is assumed the default reservation enforcement time is negotiated off-line. Invoking this message will extend the reservation enforcement time for another off-line-negotiated period. The billing text field is used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveAmount message; one charging session to a reservation will result in only one entry on the bill. Reserved credit can be returned to the account through the releaseReservation message.
c) Parameters:
NAME
TYPE
DESCRIPTION
reservationIdentifier
String
An identifier for the reservation to be amended
amount
Decimal
The currency amount to be added to (or subtracted from) the reservation
billingText
String
Textual information to appear on the bill
d) Exceptions:
UnknownReservationException
InvalidArgumentException
ServiceException
|
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 charge is specified as a currency amount. Optionally, the billing text field can be used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveAmount message; one charging session to a reservation will result in only one entry 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
reservationIdentifier
String
An identifier for the reservation to be charged
amount
Decimal
The currency amount of the charge
billingText
String
OPTIONAL. Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownReservationException
InvalidArgumentException
ChargeFailureException
|
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
reservationIdentifier
String
An identifier for the reservation to be released
d) Exceptions:
UnknownReservationException
ServiceException
|
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) 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.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 reservation enforcement time is negotiated off-line. If the reservation times out, the remaining volume will be returned to the account from which this reservation was made. However, the remaining volume should preferably be returned explicitly to the account using the releaseReservation message. The billing text field is used for textual information to appear on the bill. Subsequent textual information provided during this charging session will be appended to this textual information; one charging session to a reservation will result in only one entry on the bill. In case of success, a reservation identifier is returned for future reference; e.g. subsequent charging against the existing reservation using the chargeReservation message.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
The end user's account subject to the reservation
volume
Long
The volume of the reservation
billingText
String
Textual information to appear on the bill
reservationIdentifier
String
OUTPUT. It is an identifier for the newly created reservation
d) Exceptions:
UnknownEndUserException
InvalidArgumentException
ServiceException
|
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 enforcement time is negotiated off-line. Invoking this message will extend the reservation enforcement time for another off-line-negotiated period. The billing text field is used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveVolume message; one charging session to a reservation will result in only one entry on the bill. A reserved credit can be returned to the account through the releaseReservation message.
c) Parameters:
NAME
TYPE
DESCRIPTION
reservationIdentifier
String
An identifier for the reservation to be amended
volume
Long
The volume to be added to (or subtracted from) the reservation
billingText
String
Textual information to appear on the bill
d) Exceptions:
UnknownReservationException
InvalidArgumentException
ServiceException
|
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 charge is specified as a volume. Optionally, the billing text field can be used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveVolume message; one charging session to a reservation will result in only one entry 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
reservationIdentifier
String
An identifier for the reservation to be charged
volume
Long
The currency amount of the charge
billingText
String
OPTIONAL. Textual information to appear on the bill
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
d) Exceptions:
UnknownReservationException
InvalidArgumentException
ChargeFailureException
|
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
DESCRIPTION
reservationIdentifier
String
An identifier for the reservation to be released
d) Exceptions:
UnknownReservationException
ServiceException
|
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 uniquely identify this Web Service.
The following exceptions are specific to this Web Service:
UNIQUE ID
TEXT STRING
MEANING
PAY1000E
ChargeFailureException
Indicates that an error occurred when attempting to charge to the account. The charge did not occur.
PAY1001F
UnknownReservation
Exception
Indicates that the passed reservation identifier is unknown.
PAY1002E
UnknownReservation
Exception
Indicates that the passed reservation identifier is unavailable; it may have timed out according to the policy in place.
|
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
• parlayx_payment_reserve_volume_charging_service
The rpc/encoded file is
• parlayx_payment_service.wsdl
|
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 occurs through an application that interfaces with the subscriber either directly or indirectly. Examples of direct interaction are voice prompts and WAP/web pages, or even SMS. Typically, such multi-modal applications either request a currency amount and, e.g. credit card information, or a voucher number plus credentials. The voucher number and credentials are then validated and causes a pre-determined currency amount to be transferred.
The Parlay X Account Management API described in this document supports account querying, direct recharging and recharging through vouchers. As a side effect, it may prevent subscribers from having their account balance credits expire.
|
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 querying and prevents subscriber credits from expiring
• enables subscriber "self-service" through trusted and authenticated service or content providers
• allows recharging by subscriber address (e.g. MSISDN and PIN).
|
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 are not as comprehensive as the Account Management Web Service.
|
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).
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.1.4.1 Scenario Number 1
|
The prepaid subscriber wishes to recharge their account with a voucher and query their account balance. The subscriber uses their mobile phone or other wireline phone to interact with an IVR system. In order to recharge their account, the subscriber must enter the voucher number, the MSISDN to be recharged , and PIN(s). The IVR system accesses an external voucher database to validate the voucher number. The subscriber's account balance is then increased with the value of the voucher (voucherUpdate). The subscriber queries their account balance (getBalance), before and/or after the recharge.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.1.4.2 Scenario Number 2
|
Directly recharging (i.e. without a voucher) works much along the same way. In this case, we assume the prepaid subscriber interacts with a web page. After providing the MSISDN, along with the PIN, the user can query the account balance (getBalance). For recharging, the subscriber must enter payment details, for example credit card information, from which the payment will be made. After clearing the payment details, the currency amount will be transferred and the subscriber's prepaid account balance expiration date will be reset (balanceUpdate). The subscriber also queries their account balance expiration date (getCreditExpiryDate), after the recharge.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.1.4.3 Scenario Number 3
|
Every time a subscriber makes a telephone call the balance of their prepaid account is decremented with the cost of the call. When a recharge is done, the balance is increased either directly (balanceUpdate) or with an amount represented by a voucher (voucherUpdate). When a subscriber has doubts about the correctness of the account balance, the subscriber can request the last transactions on the account and verify them (getHistory). By offering automated access to this information, a call to the Operator's Help Desk is prevented which saves operational costs.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2 Account Management API
|
This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• getBalance
• getCreditExpiryDate
• balanceUpdate
• voucherUpdate
• getHistory
Note that certain parameters are negotiated off line. For example the reseller identifier, which identifies the reseller of calling cards.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2.1 Account Balance Query
|
getBalance(EndUserIdentifier endUserIdentifier, String endUserPin, out Decimal amount)
b) Behaviour:
This message results in getting account balance indicated by the end user identifier and associated end user PIN. The returned amount is specified as a currency amount.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
This parameter identifies the end user's account.
endUserPin
String
Contains the end user's credentials for authorizing access to the account
amount
Decimal
OUTPUT. It is the balance on the end user's account.
d) Exceptions:
InvalidArgumentException
ServiceException
PolicyException
EndUserAuthenticationException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2.2 Account Credit Expiration Date Query
|
a) getCreditExpiryDate(EndUserIdentifier endUserIdentifier, String endUserPin, out DateTime date)
b) Behaviour:
This message results in getting the expiration date of the credit indicated by the end user identifier and associated end user PIN. The returned date is the date the current balance will expire. Nil is returned if the balance does not expire.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
This parameter identifies the end user's account.
endUserPin
String
Contains the end user's credentials for authorizing access to the account.
date
DateTime
OUTPUT. It is the date the current balance will expire. Nil is returned if the balance does not expire.
d) Exceptions:
InvalidArgumentException
ServiceException
PolicyException
EndUserAuthenticationException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2.3 Account Balance Recharging
|
a) balanceUpdate(EndUserIdentifier endUserIdentifier, String endUserPin, String referenceCode, Decimal amount, Integer period)
b) Behaviour:
This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN. 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. The charge is specified as a currency amount. The balance is requested to expire in the number of days indicated by the period parameter. The operator's policies may overrule this parameter. If the optional period parameter is not present, the operator's policy on balance expiration is always in effect.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
This parameter identifies the end user's account.
endUserPin
String
OPTIONAL. Contains the end user's credentials for authorizing access to the account.
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
amount
Decimal
Currency amount that should be added to the end user's account.
period
Integer
OPTIONAL. The balance is requested to expire in the number of days indicated by this parameter. The operator's policies may overrule this parameter. If this optional parameter is not present, the operator's policy on balance expiration is always in effect.
d) Exceptions:
InvalidArgumentException
ServiceException
PolicyException
EndUserAuthenticationException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2.4 Account Balance Voucher Recharging
|
a) voucherUpdate(EndUserIdentifier endUserIdentifier, String endUserPin, String referenceCode, String voucherIdentifier, String voucherPin)
b) Behaviour:
This message results in directly recharging the account indicated by the end user identifier and optional associated end user PIN. 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. A voucher identifier indirectly specifies the charge. The optional voucher PIN code can be used to verify the voucher.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
This parameter identifies the end user's account.
endUserPin
String
OPTIONAL. Contains the end user's credentials for authorizing access to the account.
referenceCode
String
Textual information to uniquely identify the request, e.g. in case of disputes
voucherIdentifier
String
This parameter identifies the voucher.
voucherPin
String
OPTIONAL. Contains the voucher's credentials for authentication.
d) Exceptions:
InvalidArgumentException
UnknownVoucherException
ServiceException
PolicyException
EndUserAuthenticationException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.2.5 Account Transaction History Query
|
a) getHistory(EndUserIdentifier endUserIdentifier, String endUserPin, DateTime date, Integer maxEntries, out DatedTransaction[] history)
b) Behaviour:
This message results in returning the transaction history of the account indicated by the end user identifier and associated optional end user PIN. The maximum number of entries to return and the start date define the range of transactions that are of interest to the requester.
If the total number of entries in the transaction history, starting at the specified date, is larger than the specified maximum number of entries, only the most recent events are returned. Note that the operator might limit the maximum amount of entries to be returned or the period for which the entries are to be returned.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUserIdentifier
EndUserIdentifier
This parameter identifies the end user's account.
endUserPin
String
OPTIONAL. Contains the end user's credentials for authorizing access to the account.
date
DateTime
OPTIONAL. This parameter indicates the desired starting date for the entries to be returned. If this parameter is not present, it is up to the discretion of the service to decide this date.
maxEntries
Integer
OPTIONAL. This parameter indicates the maximum number of entries that shall be returned. If this parameter is not present, it is up to the discretion of the service to decide how many entries to return.
history
Array of DatedTransaction
OUTPUT. It is a DatedTransaction array that consists of types with a date field and a string field: i.e. the date of the occurrence and the transaction details, respectively.
d) Exceptions:
InvalidArgumentException
ServiceException
PolicyException
EndUserAuthenticationException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.3 Web Service Data Definitions
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.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
|
11.3.1.1 DatedTransaction
|
The DatedTransaction data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
transactionDate
DateTime
The date the transaction occurred.
transactionDetails
String
The transaction details.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.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
ACM1000E
UnknownVoucherException
This fault occurs if the voucher identification that is passed is unknown.
ACM1001E
EndUserAuthentication
Exception
This fault occurs if either the end user identification that is passed is unknown, the end user's credentials are required but are not passed, or the end user's credentials are passed but are invalid.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
11.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_account_management_types.xsd
• parlayx_account_management_service_port.wsdl
• parlayx_account_management_service.wsdl
The rpc/encoded file is
• parlayx_account_management_service.wsdl
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12 User status
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1 Overview
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.1 Description
|
The Parlay X User Status Web Service will be used for getting user status information. The use of the Web Service will not require any specific telecommunication skills.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.2 Commercial & Technical Rationale
|
The use of a Parlay X User Status Web Service will enable fast and easy development of user status aware applications.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.3 Relationship to Similar or Supplanted Specifications
|
The Parlay/OSA Mobility (User Status) Service API can also provide user status information, but the Parlay X API for this Web Service is easier to use.
The Parlay/OSA Presence and Availability Management Service specifies a set of interfaces for applications that provide broader presence and availability capabilities than those currently defined for this Web Service. These capabilities will be considered for inclusion in future Parlay X Web Services.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.4 Scenarios
|
In the following, two sample Scenarios are described.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.4.1 Buddy-list
|
This application is a mobile version of services like ICQ, MSN Messenger Service and Yahoo! Messenger, which offer text and voice chat and text conferencing. With a mobile terminal the user can be always on.
The user of the service can define one or more buddy-lists containing their friends (alternatively their family, colleagues or a combination). The status of buddies can be shown in the Buddy-list
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.1.4.2 Manual call routing
|
When a switchboard receives a call, the switchboard operator may obtain the status of a mobile terminal before trying to route the call to it.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.2 User Status API
|
This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• getUserStatus
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.2.1 Get User Status
|
a) getUserStatus(EndUserIdentifier endUser, EndUserIdentifier requester, out UserStatusData userStatus)
b) Behaviour:
Requests the user status information of a user. Before returning the user status indicator, end-user and operator policies must be satisfied.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUser
EndUserIdentifier
It identifies the end user for whom user status information is being requested.
requester
EndUserIdentifier
OPTIONAL. The address of the requester.
userStatus
UserStatusData
OUTPUT. It is the user status of the end user
d) Exceptions:
InvalidArgumentException
UnknownEndUserException
ServiceException
PolicyException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.3 Web Service Data Definitions
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.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
|
12.3.1.1 UserStatusData
|
The UserStatusData data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
userStatusIndicator
UserStatusIndicator
It indicates the status of the end user.
additionalUserStatus
Information
String
A string to hold additional information if the userStatusIndicator is 'Other'.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.3.1.2 UserStatusIndicator
|
The UserStatusIndicator data type is an enumeration with the following values:
VALUE
DESCRIPTION
Online
User is online.
Offline
User is offline (mobile terminal switched off/other terminal not connected to the service), or wants to appear to be offline.
Busy
User is busy.
Other
Custom user status information can be retrieved from additionalUserStatusInformation.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.3.2 Exceptions
|
All exceptions thrown by this Web Service are Common Exceptions, as defined in clause 5.2.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
12.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_user_status_types.xsd
• parlayx_user_status_service_port.wsdl
• parlayx_user_status_service.wsdl
The rpc/encoded file is
parlayx_user_status_service.wsdl
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13 Terminal Location
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1 Overview
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1.1 Description
|
The Parlay X Terminal Location Web Service will be used for getting location information. The use of the Web Service will not require any specific telecommunication skills, but knowledge of location co-ordinates will be required.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1.2 Commercial & Technical Rationale
|
The use of a Parlay X Terminal Location Web Service will enable fast and easy development of location aware Applications. The use of the Web Service will only require knowledge of longitude and latitude from the World Geodetic System 1984 (WGS 84), which is the reference system chosen for the coding of locations.
The market for location aware services is growing, and easy access to location information will stimulate the growth of this market.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1.3 Relationship to Similar or Supplanted Specifications
|
The Mobile Positioning System (MPS) offers much of the same functionality that the Parlay X Terminal Location Web Service will offer.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1.4 Scenarios
|
In the following, a sample Scenario is described.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.1.4.1 Location enabled Buddy-list:
|
This application is a mobile version of services like ICQ, MSN Messenger Service and Yahoo! Messenger, which offer text and voice chat and text conferencing. With a mobile terminal the user can be always on, and the service can also show where buddies are located.
The user of the service can define one or more buddy-lists containing their friends (alternatively their family, colleagues or a combination). The Buddy List application may access terminal location information, and the following two cases are considered: a user initiates the retrieval of i) its own location and ii) other users' location.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.2 Terminal Location API
|
This subclause describes an initial set of capabilities in terms of message invocations, parameters and data types. The message-based invocations are:
• getLocation
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.2.1 Get Location of Terminal
|
a) getLocation(EndUserIdentifier endUser, EndUserIdentifier requester, LocationAccuracy accuracy, out LocationInfo location)
b) Behaviour:
Requests the location of one terminal. The location is returned if the terminal is available. Before returning the location, end-user and operator policies must be satisfied.
c) Parameters:
NAME
TYPE
DESCRIPTION
endUser
EndUserIdentifier
The address of the terminal for which location information is being requested.
requester
EndUserIdentifier
OPTIONAL. The address of the terminal from which the request is initiated.
accuracy
LocationAccuracy
The desired accuracy. Possible values are: 'Low', 'Medium', 'High'. Each operator must assign a "radius of uncertainty" to each value (e.g. < 3 km, < 1 km, < 10 m, respectively)
location
LocationInfo
OUTPUT. It identifies the location of the terminal.
d) Exceptions:
InvalidArgumentException
UnknownEndUserException
ServiceException
PolicyException
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.3 Web Service Data Definitions
| |
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.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
|
13.3.1.1 LocationInfo
|
The LocationInfo data type is a structure containing the following parameters:
NAME
TYPE
DESCRIPTION
longitude
Float
Longitude
latitude
Float
Latitude
accuracy
LocationAccuracy
How accurate the Location information is. If the degree of accuracy wanted is available this should be given, if not the best possible accuracy should be returned. Possible values are: 'Low', 'Medium', 'High'.
dateTime
DateTime
Identifies when the location information was obtained.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.3.1.2 LocationAccuracy
|
The LocationAccuracy data type is an enumeration with the following values: (Each Parlay X Gateway operator must specify the uncertainty radiuses for Low, Medium and High)
VALUE
DESCRIPTION
Low
Low accuracy i.e. < 3 km radius of uncertainty.
Medium
Medium accuracy i.e. < 1 km radius of uncertainty.
High
High accuracy i.e. < 100 m radius of uncertainty.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.3.2 Exceptions
|
All exceptions thrown by this Web Service are Common Exceptions, as defined in clause 5.2.
|
e3edf551830c62df14a4eaeee607bff5
|
29.199
|
13.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_terminal_location_types.xsd
• parlayx_terminal_location_service_port.wsdl
• parlayx_terminal_location_service.wsdl
The rpc/encoded file is
parlayx_terminal_location_service.wsdl
Annex A (informative):
W3C WSDL Description of Web Service Syntax
The W3C WSDL representation of the APIs specified in the present document is contained in a set of files which accompany the present document:
px0326rpcenc.zip
px0326rpclit.zip
Annex B (informative):
Change history
Change history
Date
TSG #
TSG Doc.
CR
Rev
Subject/Comment
Old
New
Jul 03
--
--
--
--
1st Draft in 3GPP Spec. format, no number assigned
-
0.0.1
Oct 03
--
--
--
--
Change of Title and removal of PayCircle copyright from Clause 10. Addition of Parlay and PayCircle acknowledgement in Forward clause
0.0.1
0.0.2
Oct 03
--
--
--
--
• Change 3GPP reference to include 29.199;
• Removal of PayCircle from the acknowledgement in the Foreword clause. .
• Title changed to remove the word 'specification'.
• Addition of WSDL files to the zip file.
0.0.2
Nov 2003
--
--
--
--
• EditHelp document processing & MCC review.
• Created reference list (please review the IETF ones !!)
• Added a new
Annex A (informative):
W3C WSDL Description of Web Service Syntax
referred to from the various subclauses entitled
x.y Web Service Syntax – WSDL
• Field codes/automatic numbering/Bookmarking of Clauses/Figures etc. had been removed
• Hidden text still exist (to be removed by the authors ?)
0.0.2
0.0.3
Dec 2003
CN_21
NP-030552
--
--
Submitted to CN#22 for Information
1.0.0
Jan 2004
--
--
--
--
Added The W3C WSDL representation of the APIs specified in the present document is contained in a set of files which accompany the present document: px0326rpcenc.zip
px0326rpclit.zip
1.0.1
|
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
1 Scope
|
The present document provides an overview of the architecture and issues related to the provision of voice optimisation within the GERAN.
|
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
2 References
|
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
[1] 3G TS 26.090, "Adaptive Multi-Rate (AMR) speech transcoding".
[2] 3G TS 26.190, "AMR Wideband speech codec, Transcoding functions".
[3] IETF AVT internet-draft "RTP, A Transport Protocol for Real-Time Applications", http://www.ietf.org/internet-drafts/draft-ietf-avt-rtp-new-09.txt.
[4] IETF RFC768, "User Datagram Protocol".
[5] IETF RFC760, "Internet Protocol".
[6] IETF AVT internet-draft, "RTP payload format and file storage format for AMR and AMR-WB audio", http://www.ietf.org/internet-drafts/draft-ietf-avt-rtp-amr-10.txt.
[7] IETF RFC2543, "SIP: Session Initiation Protocol".
[8] IETF RFC2327, "SDP: Session Description Protocol".
[9] IETF AVT internet-draft "Low Delay RTCP Feedback Format", http://www.ietf.org/internet-drafts/draft-fukunaga-low-delay-rtcp-02.txt.
[10] IETF AVT internet-draft "RTCP-based Feedback: Concepts and Message Timing Rules", http://www.ietf.org/internet-drafts/draft-wenger-avt-rtcp-feedback-02.txt.
[11] 3GPP 26.101, "AMR Speech Codec Frame Structure".
[12] 3GPP 26.201, "AMR Wideband speech codec; Frame Structure".
[13] 3GPP 26.093, "AMR Speech Codec; Source Controlled Rate operation".
|
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
3 Definitions, symbols and abbreviations
| |
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
3.1 Definitions
| |
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
3.1.1 Terminal integrated application
|
In this document the term “Terminal integrated application” is used. An application is considered to be “integrated in the terminal” when the application is co-located with the PDCP and RRC protocol entities.
|
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
3.2 Symbols
|
Editors note: to be completed
|
1549644dc078ef9fd6712bc573d8101d
|
43.900
|
3.3 Abbreviations
|
SIP Session Initiation Protocol
DTM Dual Transfer Mode
CS Circuit Switched
GERAN GSM/EDGE Radio Access Network
FACCH Fast Associated Control Channel
RTP Real time Transport Protocol
UDP User Datagram Protocol
IP Internet Protocol
UL Uplink
DL Downlink
TS Time Slot
CN Core Network
SS Subsystem
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.