hash
stringlengths 32
32
| doc_id
stringlengths 5
12
| section
stringlengths 4
595
| content
stringlengths 0
6.67M
|
---|---|---|---|
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 |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 4 Overall description of voice over IP in the IMS domain when connected to GERAN | GERAN is considering the solution to provide an optimized voice bearer as well as generic bearers to support speech originating from the Iu-ps. The optimization is achieved by reusing the channel coding of CS speech channels in GSM, and by employing header removal to increase the spectrum efficiency. The consideration regarding header removal was made with the understanding that header removal is a non-transparent header adaptation scheme and that therefore optimized voice can’t be used together with synchronized medias.
Optimized voice will be used in conjunction with SIP. Agreed schemes in GERAN to transport SIP are DTM (Dual transfer mode: going over to 2 half rate or full rate slots during the transmission of SIP data) or FACCH, stealing speech frames during the SIP transmission periods. Both schemes are already provided by GSM R99 or earlier.
5 Definition of optimized voice schemes
5.1 Header Removal
Transport and network level headers (e.g. RTP/UDP/IP) are completely removed. Based on information submitted at call set-up and based on information derived from lower layer (link & physical), the receiving entity can regenerate the headers. The primary application of header removal is the optimized speech bearer, and the regenerated header may not always be semantically identical to the original header.
5.2 Header Compression
Transport and network level headers (e.g. RTP/UDP/IP) are compressed in such a way that the decompressed headers are semantically identical to the original uncompressed headers. The IETF ROHC WG is responsible for standardising header compression schemes. Header compression is suited for standard Internet applications that are not designed to work only with GERAN and especially for multimedia applications therefore the scheme will be used with generic real time multimedia bearers.
6 Requirements and working assumptions for support of voice optimisation for the IMS in the GERAN |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 6.1 Requirements | 1. It shall be possible to use a SIP based optimised voice service with a mobile terminal supporting multi slot class 1 (1 TS in DL, 1 TS in UL).
2. There shall be no performance degradation in coding and modulation compared to traditional circuit switched voice services.
3. GERAN shall not interpret SIP messages.
4. The GERAN solution shall utilise as far as possible already existing protocol means on the Iu interface for UTRAN.
4.1 Although UTRAN has no plans to deploy header removal in Rel 5, a solution shall take into consideration UTRAN developments and UTRAN architectural principles.
5. The change between header compression and header removal shall be possible during handover.
6. Interruptions in speech due to SIP signalling, mid call, shall be kept to a minimum. SIP compression is required.
7. The GERAN solution shall be future proof and shall not exclude the support of multiple codecs.
8.Whether header regeneration is carried out in the MS shall be an implementation issue
9. It shall be possible to identify whether the terminals has requested an optimized voice bearer or a generic radio bearer for carrying voice in the call data records (CDR). |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 6.2 Working assumptions | 1. It is unclear when/whether mid path transcoders for the IMS will be available between two SIP end users.
2. TSG GERAN is responsible to develop the header removal solution for an Optimized Voice bearer.
3. GERAN informs the MS which codecs are currently supported and the MS is in charge of identifying a single codec, which is supported by the GERAN and the other SIP endpoint (FFS). The mobile requests resources from the network.
4. The GERAN will make the final decision whether or not header removal is possible to apply, or if a generic radio bearer will have to be used.
5. It will not be possible to use header removal for bearers that are part of a multimedia session requiring synchronised media streams.
6. As RTP time stamps and sequence numbers are generated in the BSS, thus there might be an offset in the generated headers across a handover event. Positive or negative slips in sequence numbers may occur in such a situation.
7. In initial implementation it is assumed that the application that generates and receives the flow for which header removal is applied, is integrated in the terminal. Refer to 3.1.1 for the definition of an application that is integrated in the terminal.
8. Header removal cannot be used where end-to-end encryption or integrity protection is used as it does not guarantee bit-exact transfer of traffic.
7 Issues for the support of header removal within GERAN
The purpose with the following subchapters is to capture all issues related to the support of header removal within GERAN. Each subchapter is in turn divided into subchapters describing the characteristics of the problem, possible solutions and the working assumptions that have been agreed.
When a working assumption has been adopted, the solutions that have not been chosen are not removed. The reason for this approach is to avoid that discussions around matters that already have been concluded, shall pop up again at a later stage.
Figure 1. The figure illustrates the process when an Iu-PS voice call is set-up in GERAN. The overall principles are, where nothing else stated, basically the same in all solutions described in chapter 7. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.0.1 Summary of GERAN/MS States for IMS Calls with Header Removal | A number of events have been identified. These are:
1. At some point, MS is made aware of current local Codec/Channel Coding Support
Note: This information may no longer be accurate by the time that the GERAN needs to allocate a bearer, due to changes in resource availability
2. MS has PDP Context for SIP traffic
3. MS has engaged in SIP signalling; a Secondary PDP Context Activation has not yet been requested
4. MS sends the Secondary PDP Context Activation Request; SGSN sends an associated RAB Assignment Request; BSC has not selected RB and channel coding scheme yet
5. BSC selects the final RB and channel coding scheme, and initialises the PDCP entities as part of the RB (or extended RB) setup procedure. There are two variants here
5.1 Header Removal is used
Note: This event defines the “latest point” at which IP address/port and Payload Type information must be available at the BSC in order for Header Removal to be initialised, regardless of the technique used to deliver the information.
5.2 Header Compression (or no adaptation) is used.
6. RB Setup is complete, but media traffic has yet to begin
Note: It is assumed that SIP call setup is complete before media traffic transfer begins
7. Media traffic transfer is active; the access link is stable
8. Handover occurs whilst maintaining the current PDCP mode (and the same Codec/channel coding scheme). Again, there are two variants here;
8.1 Header Removal is used
8.2 Header Compression (or no adaptation) is used.
9. Handover occurs whilst maintaining Header Removal, but involving a change in Codec and channel coding scheme (including a change in ACS whilst maintaining AMR as the Codec)
10. Handover occurs, together with a PDCP mode change from Header Removal to Header Compression. There are two variants here: |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 10.1 PDCP Mode change from HR to HC is part of an Inter-RAT change from GERAN to UTRAN | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 10.2 PDCP HR to HC mode change occurs within GERAN | 11. Handover occurs, together with a PDCP mode change from Header Compression to Header Removal. This has two variants: |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 11.1 There is also an Inter-RAT change from UTRAN to GERAN | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 11.2 PDCP mode change without such an Inter-RAT change" | Note: Some of these events (notably those involving complex handover cases) are not covered within the Technical Report. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.0.2 PASNAS Information Structure | A group of data items can be used to assist the PDCP processor in selecting the appropriate scheme to be used when performing packet adaptation within the RAN. It can be viewed as a set of “suggestions” from the MS to the RAN. This information is doubly optional:
7 the MS need not send it (relying on default behaviour from the RAN),
8 the RAN need not act on it (either due to the information not being appropriate in the particular configuration, or because the requirements are not applicable to the processing it will perform).
This group of Packet Adaptation Specific Non-Access-Stratum (PASNAS) Information is intended to be valid for a given bearer and applicable over the lifetime of that bearer. Other information may also be needed to specify fully the operation of Packet Adaptation in the RAN; this need not be transferred in the same way, or even at the same time.
Data specifying the traffic type to be carried within a bearer used in a multimedia call is RAN-specific, and is needed only to improve the efficiency of RAN-based packet adaptation. It should not have an impact on the operation of the Core Network, and should not need to be modified or read by the Core Network, even if this is used to relay the information between the MS and the RAN. As a result, this information should be carried inside a Transparent Container whilst being relayed via the Core Network.
Such an (optional) PASNAS Information structure will contain a set of fields, with two initial field types being defined. If the PASNAS Information has not been provided by the MS, then the GERAN will have to assume a conservative approach to header adaptation (i.e. Header Removal will not be possible).
The possible field types that may be contained in such a structure are specified next.
7.0.2.1. Adaptation Type Requirements
It is proposed that a bit set be used to hold flags indicating the mobile application’s special requirements on the adaptation scheme to be used for the associated bearer.
There are currently two situations in which a mobile application may want special treatment of packets being carried through a RAN. These are reflected in the following flags. There may be other flags added in the future, but these two cover the initial needs for GERAN and may be useful for the UTRAN case as well. It is expected that additions to these flags will be restricted, and so the Adaptation Type Requirements field can be of a fixed size (e.g. the bit set will fit into a single octet, for a total field size of two octets, including the tag).
If all these flags are set to false, the GERAN should interpret this as an explicit statement by the mobile application that it is no specific adaptation type requirements. In this case, Header Removal is allowed.
7.0.2.1.1. Synchronisation Indicator
Header Removal is not possible within a GERAN if the speech media flow is part of a multimedia application requiring synchronisation between the different media flows (see Section 7.5.1 of the TR on Optimised Voice). Thus, one reason why Header Removal might mot be allowed by the mobile application is that the associated bearer is to carry such a “synchronised stream”. The RAN will be unaware of this fact, and so, if the mobile application requires special treatment for this flow, it will have to indicate this, using a “Synchronisation Indicator” flag.
More generally, it should still be possible to use Header Adaptation where a bearer is so indicated; however, the RAN should not use adaptation mechanisms that will make it difficult for such synchronisation to be maintained. The radical processing involved in Header Removal is only one such “unacceptable” technique.
7.0.2.1.2. Bit-Identical Encoding Required
There is another reason why some forms of adaptation may be unacceptable to a mobile application. It is possible to produce other “lossy compression” schemes that might be appropriate for some traffic types. For example, HTTP (web) messages use a text encoding and could be re-encoded into a canonical form with compression. The resulting message would not be bit-identical. For most purposes, this is acceptable, but there are situations in which it is not; for example, if application-level integrity protection had been applied to the HTTP message, then this would fail when checked against the message that had been re-encoded to a canonical form.
Introducing a “Bit-Identical Encoding Required” flag could allow the PDCP entities to restrict their processing to adaptation that preserved the identical bit pattern of the message. Of course, it follows that indication of such a requirement would, by definition, mean that Header Removal was not allowed as this technique does not guarantee bit-identical transfer.
7.0.2.2. Traffic Type
It is proposed that a “Traffic Type” structure be introduced. This will indicate the traffic to be used within the associated bearer, and will include a parameter set the interpretation of which is specific to the Traffic Type carried. This is the Traffic Type Parameters.
For each different Traffic Type, the parameters might have a different structure or be empty. If an implementation receives such a structure and does not recognise the Traffic Type Identity value, it can ignore the whole structure, as this implies that it does not support a specific adaptation mechanism to process this traffic.
Traffic Type Identity:
(Unknown | IP | TCP | UDP | UDP/RTP | UDP/SIP | TCP/HTTP |,…)
The interpretation would be that the associated bearer is expected to carry packets of this type. There are several values that can be considered at this point; of these, only the RTP value is required for Header Removal to function. However, the others are given as potential examples; at present, all other values should be reserved.
• “Unknown” means that the kind of data carried in this bearer is completely unknown.
• “IP” means that the bearer is known to carry IP datagrams, but these hold a mix of TCP and UDP packets.
• “TCP” means that this bearer will carry TCP packets, but the kind of application level protocols carried in the TCP packets is unknown, or is a mix of protocols.
• “UDP” means that this bearer will carry UDP packets, but the kind of application level protocols carried in the UDP packets is unknown, or is a mix of protocols.
• “UDP/RTP” means that it is known that this bearer will carry only RTP packets.
• “UDP/SIP” means that this bearer will carry only SIP messages.
• “TCP/HTTP” means that the bearer will be used to carry web requests and responses only.
Traffic Type Parameters:
– Parameters (if any) associated with this traffic type
For Header Removal, the Traffic Type Identity ‘UDP/RTP’ is required. In this case, the Traffic Type Parameters will be interpreted as carrying Codec Type information. The internal structure of this sub-field is covered next.
7.0.2.2.1. Codec Type
Where the Traffic Type Identity is ‘UDP/RTP’, the associated Traffic Type Parameters should be interpreted as a list of triple values, each consisting of the Codec Identity, ACS Modes used, and the Payload Type associated with this Codec/ACS combination. It is valid for the length of the parameter to be zero (i.e for there to be an empty list of Codecs).
Conversely, note that there might be, in the future, more than one codec used for traffic carried in a single bearer, so the parameters for this traffic type should form a list of entries. For example, data reflecting DTMF-coded signals (encoded according to RFC 2833) might be interspersed with data from speech. The situations in which such use of more than one Codec Type is valid are for further study, but using a list structure does not preclude this possibility for future systems whilst ensuring “backward compatibility”. Each list entry consists of the following tuple:
Codec Identity:
(Unknown/Unspecified | GSM-FR | GSM-EFR | GSM-HR | AMR-NB | …)
Note – other values should be reserved.
ACS Modes Used:
Bit Set, with one entry per mode, each of which is a Boolean flag indicating whether or not this mode is part of the ACS. If the associated Codec does not use Active Codec Sets, then only one mode would be expected to be set true. The default value {00000000} (i.e. no modes in this set) should be used where modes are not known or are not applicable.
Note that the mapping between particular modes and positions in the bit set is TBD.
Also note that, to ensure forward compatibility, this bit field will need to hold flags for nine modes, to allow for the future introduction of AMR-WB to the GERAN.
Payload Type:
This is a copy of the Payload Type identifier to be used in RTP packets carrying data encoded according to the associated Codec Identity. This value is an 7 bit unsigned integer.
7.0.2.3. Example PASNAS Information
Combining these two field types, the following structure might be expected for the example described above, in which a bearer was to be used exclusively to carry RTP packets with a Codec Identity of ‘GSM-FR’, a Payload Type of 96, and for which the Mobile Application decided to state explicitly that it had no special requirements on the adaptation technique applied.
‘PASNAS Info’
{
‘Traffic Type’
Traffic Type Identity – ‘UDP/RTP’
Traffic Type Parameters – {{‘GSM-FR’, {00001000}, 96}}
‘Adaptation Type Requirements’
{SI= ‘false’, BiER= ‘false’}
}
7.0.3. Summary of the issues addressed in chapter 7
• How shall the SIP negotiation between the endpoints be performed, and how to make sure that the endpoints have all necessary information in order to complete the negotiation.
• The principle of how GERAN figures out which speech codec that has been selected in order to apply the appropriate channel coding schemes.
• The principle of how to signal/negotiate a change in codec during an ongoing call.
• The principle of how to select active codec set (ACS) when AMR is used.
• How and when header regeneration shall be applied.
• The principle of how GERAN figures out whether or not header removal may be applied.
• How the IP and port numbers are communicated between the UE and the PDCP entity in the BSS.
• How GERAN-GERAN, UTRAN-GERAN, GERAN-UTRAN handovers shall be performed with regard to header removal.
• How mid call SIP communication shall be performed.
• |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.1 Optimized voice call set-up within the IMS | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.1.1 Description of | Call set-up in the CS domain is based on the following principle:
1. The terminal announces its capabilities
2. The network select speech codec to be used
Call set-up in the IMS domain is based on a fundamentally different principle:
1. The terminal endpoints negotiate speech codec (or more generally media codecs) to be used
2. The terminal request the resources required, to the network.
The IMS SIP negotiation currently does problem not take into account any access specific information concerning the codec negotiation. This is particularly the case when the access network modifies the codec packets in some way as in header removal. The BTS may lack support for some of the channel coding schemes that corresponds to the speech codecs supported by the MS.
The solutions as proposed below may be combined. For example one solution can be adopted for initial implementation and may be further improved in combination with another solution.
7.1.2 Proposed solutions |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.1.2.1 MS knowledge of GERAN channel coding capabilities at the start of or before SIP negotiation | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.1.2.1.1 Description of the solution | This solution is based on the principle of letting the peer involved in the SIP call set-up know about the capabilities of the GSM/EDGE Radio Access Network (e.g. supported channel codings in the cell). Such knowledge has to be provided prior to, or during, the SIP-based call set-up. Several solutions are possible:
◦ The knowledge is provided as a new Information Element appended to the RADIO BEARER SETUP message, setting up the Radio Bearer for SIP signalling.
◦ Other solutions are possible and may be added
This solution is also based on the principle of having a deterministic rule for the BSS to work out that the RAB being established carries SIP-signalling. Several solutions are possible:
-
- Define a new Source Descriptor choice for SIP signalling - Make an on-demand request during the SIP negotiation (FFS).
- Other solutions are possible and may be added
When the user moves to another cell after SIP negotiation has started but before it is completed, the capabilities supported by GERAN may change. Several solutions are possible to handle this:
:
• The BSS handovers the resources used for the SIP Radio Bearer and the HANDOVER COMMAND or RB RE-CONFIGURATION message, whichever is used, can include such information for the new cell (see 44.018);
• The MS re-selects the new cell and sends a CELL UPDATE to the BSS. The response from the network can include such information for the new cell (CELL UPDATE CONFIRM or RB RE-CONFIGURATION).
• Other solutions are possible and may be added
If the channel coding capabilities supported by the old cell are not the same as those supported in the new cell, this may trigger codec re-negotiation at SIP level.
The impact on SIP level codec negotiation is then the following:
• In case of Mobile Originated call the selection of QoS attributes, codec, etc for each media flow described in the SDP contained in the SIP INVITE shall then take into account not only the SIP client own capabilities but also the capabilities of the GERAN. Each media flow will be associated to a list of all the codecs that are supported by both the originating SIP client and the controlling GERAN (as far as the necessary channel codings are concerned) and which fulfil the QoS required for the media flow. The SIP negotiation then takes place according to 3GPP TS 23.228.
• In case of Mobile Terminated call, when the addressed SIP client receives the SDP contained in the SIP INVITE, it shall then take into account the codecs that it accepts itself and that are supported by its controlling GERAN (as far as the necessary channel codings are concerned) before accepting the SDP and send the reply to the originating SIP client.
Such a solution will not require any SIP level codec renegotiation in cells where the same set of channel codings is supported by all transceivers. In case transceivers of a cell do not all support the same channel codings (e.g. some support TCH/FS and TCH/AFS codings, others support only TCH/FS), it may happen that a codec is negotiated at SIP level for which there is no transceiver availability at the time the Radio Bearer is set-up (e.g. AMR NB is chosen). This would imply SIP level codec renegotiation. This solution is therefore particularly suited for network deployments where a consistent set of channel codings is supported by all transceivers of a given cell. However, this does not require all cells of the network to support the same set of channel codings. This is further described in Annex A.
This solution may, if necessary, be further improved in combination with solution 7.1.2.3.
7.1.2.1.2 Pros and Cons- The SIP radio bearer is set up when the MS makes itself available to the IP Multimedia Subsystem. However, the SIP negotiation only takes place when a call is being received or initiated by the MS. Between these two events, a substantial amount of time may expire. During this time, the set of supported codecs may change due to high network load in the current cell, or because the user is moving into a new cell. This will lead to extra signalling between the MS and network.
7.1.2.2 SDP message delayed
7.1.2.2.1 Description of the solution
In this solution the proposal as described in 7.1.2.1 is enhanced. By delaying the final SDP message sent by the calling party until the resources have been allocated within the GERAN, there is no risk that a codec is selected that requires a channel coding scheme that is not supported in the BSS.
7.1.2.2.2 Pros and cons
• This solution will not work in the case where no mid path transcoding is carried out, such as in the case of IMS MS to IMS MS call where both mobiles are accessing the network via GERAN. The reason for this is that two different GERAN entities are involved in the SIP negotiation phase, and it has to be assumed that those GERANs may come up with different codec selections.
• This proposal changes the current working model for the IMS as defined in 23.228v5.0.0. This would cause substantial changes to the currently agreed information flows and would have to be agreed both in S2 and CN1. S2 has made a clear indication (LS Tdoc S2-011577) that:
“this solution should be removed from consideration”.
7.1.2.3
non-3GPP
7.1.3 Working assumption
Solution 7.1.2.1 is the current working assumption. Several sub-alternatives exist in 7.1.2.1, Nno agreement has been reached so far on working assumption on that level,
Solution 7.1.2.2 is removed from consideration.
Solution 7.1.2.3 requires quite some changes and additions in [6]. This make this solution non feasible in short term. However this solution add a value by outlining a future proof evolution of 7.1.2.1. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.2 Handling of ACS for AMR | In case of optimized speech with AMR codec there are additional issues that are related to managing the ACS as listed
7.2.1 Max four AMR modes can be part of an ACS I GERAN, at a time
7.2.1.1 Description of problemIn case of a session between GERAN MS and some other IP terminal, the IP terminal (somewhere in the IP cloud or in UTRAN) assumes that any of 8 modes are possible if the SIP level negotiation would result with AMR. However this is not true over the GERAN air interface as seen in R98 GSM AMR specifications. There could be maximum 4 modes
7.2.1.2 Description of solutions
7.2.1.2.1 AMR Format Parameters
This could be solved using MIME negotiation during the SIP/SDP where the ACS could be negotiated too. For example A party indicates (in SDP) ACS {12.2,7.95,7.4} and B party indicates ACS {10.2, 7.95,7.4}. So, the resulting common ACS would be {7.95,7.4}. It is clear that A party must only use modes included in the ACS that B party has indicated. Furthermore, although in general case the ACS means only the modes that a terminal is willing to receive, it seems quite clear that in GERAN case A party knows that it is only allowed to transmit modes included in its own ACS.
7.2.1.3 Working assumption
The MiME approach 7.2.1.2.1. is currently the GERAN working assumption
7.2.2 How to change the ACS at any given time
7.2.2.1 Description of problem
If we assume that only one codec and one ACS is agreed at the SIP negotiation, dynamic behavior of GERAN system (possibility to change ACS any time) would require SIP level re-negotiation of ACS. This re-negotiation is seen as incall modification of the session (SIP signaling during the speech call) and in order to transmit SIP signaling during the call, we have to use DTM like solution, so go to HR+HR constellation and this in turn requires changing ACS, since ACSs are different for FR and HR.
7.2.2.2.1.1 Description of solutions
7.2.2.2.1 use of a consistent Active Codec Set in geographic regions
In order to avoid SIP level negotiation a similar solution as described in 7.1.2.1, could be adopted. This would mean that a consistent set of ACS should be supported in the network.
7.2.2.3 working assumption
No working assumption has been reached so far
7.2.3 The encoder may have to use a more robust rate than the requested
Header removal functionality in PDCP will act as a proxy and receive AMR speech samples encapsulated in the RTP packet according to [6]. For downlink the speech samples are passed through channel encoder and the Mode Indication is set according to the information obtained from the AMR payload format for RTP. According to [6] the other end could ask using CMR (Codec Mode Request) field to receive a codec mode that would not be possible over the air interface in uplink at a certain time (or to be more precise it could be possible but the link quality could be so bad that the speech quality would be severely impacted). An example: The B party asks for 12.2, but the link conditions dictate the usage of more robust mode, for example 7.4. According to [6] GERAN PDPC header removal entity is mandated to send 12.2 in uplink, so it needs to set the Mode Command to 12.2 in the 2 AMR signalling bits. This issue is not unique and appears also in TFO cases. One simple solution would be to relax the requirement in [6].
Editors note: According to [6] this seems to already be possible. This section may be removed, or reformulated. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.2.4 How to force a change to an AMR rate able to be carried on a HR physical channel | 7.2.4.1 Description of problem
There may bea need to change from Full Rate to Half Rate channels. This may be the case in high traffic load situations. It may also be necessary if DTM is used for SIP signalling and only one TS in UL and DL can be used (also refer to chapter 7.9).
7.2.4.2 Description of solutions
,
7.2.4.2.1 Choose a HR compliant ACS
One way to avoid SIP level re-negotiation is to choose an ACS that would be compliant with half Rate channels..In case of GMSK NB AMR this would mean to restrict the highest mode in ACS to 7.95. The implications of such restrictions should be evaluated.
Editors note: An example of signalling flow for MS initiated optimized speech is provided in appendix B.
7.2.4.3 Working assumptions
No working assumptions reached so far.
7.3 Radio Bearer Identification for GERAN
7.3.1 Description of problem
When GERAN is about to apply header removal, it is necessary for GERAN to identify which codec is used, as the corresponding channel coding algorithm has to be applied. Furthermore, in the case where AMR is used, GERAN must also be informed of which active codec set is used. GERAN can only handle up to four rates in its active codec set.
Editors note: The relation of operation of AMR over IP and GERAN’s limited active codec set needs to be clarified in cooperation with SA2.
7.3.2 Solutions
7.3.2.1 Direct communication between the UE and the BSC
7.3.2.1.1 Description of the solution
It is proposed to keep the exchange of information related to header removal completely within RRC. All required information is then transferred within extended RADIO BEARER SETUP messages as outlined in Figure 2.
Figure 2: Extended RB set-up procedure
1. The SGSN starts the setup of the RAB with RAB ASSIGNMENT REQUEST containing a generic QoS request as received from the UE via Session Management.
2. The BSC has no knowledge so far whether header removal could be applied to this RAB. Therefore the BSC will initiate the setup of a generic radio bearer according to the received QoS received in RAB ASSIGNMENT REQUEST. Within the RADIO BEARER SETUP message the BSC may include an indication to the MS, that header removal is supported in the RAN (e.g.: by sending a flag "Header Removal Supported"). Note that it is FFS whether the BSC shall indicate the support of HR at that point in time.
3. The MS has to check whether or not header removal is possible for that media stream. If this is the case, the MS sends all information needed to be able to apply header removal within a container inside the RADIO BEARER SETUP COMPLETE message to the BSC, i.e. a flag indicating "Header Removal Allowed", negotiated codec information and the RTP context.
4. The BSC detects that header removal, i.e. optimised voice can be applied. If the BSC decides to modify the (generic, not optimised) RB according to the information received from the MS in the RB setup complete message received, it starts a RB modification procedure by sending the RADIO BEARER RECONFIGURATION message to the MS.
If the BSC decides not to modify the RB it successfully terminates the RAB Assignment procedure instead of sending RB RECONFIGURATION to the MS.
5. MS sends back a RADIO BEARER RECONFIGURATION COMPLETE message.
6. BSC responds to SGSN with RAB ASSIGNMENT RESPONSE.
Now the establishment of the radio link is finished and a codec-specific channel coding will be applied. After this modified setup of the radio bearer, the signalling will be continued as described in Figure 2.
For MSs only supporting 1 TS in UL and 1 TS in DL the extended RB setup procedure might look different: the MS will not support the generic RB, because the amount of data for a generic RB will not fit into one timeslot. Therefore the MS has to reject the first radio bearer setup. But it could transfer all required information within the RADIO BEARER SETUP FAILURE message to the BSC and might also include the flag “Header Removal Allowed”, which indicates to the BSC that the setup of a RB with applied header removal will be successful. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.1.2 Pros and cons | + no impact to CN
+ if header removal is not to be applied to the media stream, the RB setup procedure remains unchanged (except for the transfer of the “Header Removal Supported” flag from the BSC to the MS and the “Header Removal Allowed” flag set to false from the MS back to the BSC).
• Two more messages will be required to setup the RB for optimised speech. However the significance of the added delay within the whole setup procedure has to be verified.
• It is unclear how a CDR shall be generated in order to be able to charge differently for optimized voice and voice carried over a generic radio bearer |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.2 SDU format information approach | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.2.1 Description of the solution | Detailed QoS information is provided in the ‘Activate PDP context request’ message by using the ‘SDU format information’ attribute. This information uniquely identifies the appropriate channel coding in the GERAN. However, ‘SDU format information’ would have to be introduced in R5.
For multi rate codecs such as AMR, it is important that the SDU format is provided for all rates even though only a subset has been negotiated on SIP-level, in order for GERAN to be able to identify the codec unambiguously. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.2.2 Pros and cons | - The solution proposed does not specify how a potential future codec is uniquely identified if that codec has exactly the same bit mapping and protection for each class of bits in the payload format of an existing codec. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.3 Activate PDP context request message approach | |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.3.1 Description of the solution | Following the SIP negotiation, which needs to result in one desired codec, the UE expresses this request explicitly by stating the desired codec in the subsequent resource request to the network. A field containing the specific speech codec desired is introduced in the ‘Activate PDP context request message’ to the SGSN, by extending the QoS information element. More specifically, the codec information can be an extension of the ‘Source Statistics Descriptor’ field that will be part of the QoS IE in R5. (The R99 QoS information element included in the Activate PDP context request message is shown in section 7.5.2.).
This information is then passed to the GERAN at the ‘Radio Access Bearer Request’, by also extending the ‘Source statistics descriptor’ in the RAB QoS parameter set.
For AMR, it is assumed that the preceding SIP negotiation not only results in ‘AMR’, but rather AMR plus a preferred active codec set consisting of four or less rates. This active codec set information is then conveyed from the UE to GERAN. Thus, in case of AMR, the new field in the QoS information element, sent from the UE via SGSN to GERAN, comprises both AMR and the preferred active codec set.
Editors note: This section may be updated to reflect concerns expressed on service specificity. It is intended to place the codec information within a transparent container to be relayed via the SGSN. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.3.2.3.2 Pros and cons | + This solution is straightforward and imposes limited changes to existing standards. It is architecturally clean in that it uses existing messages for resource requests from the UE to GERAN. The codec information can potentially be used by other purposes as well, for example charging.
- Its potential drawback is that the PDP context message, which is a request for a bearer service, includes application-related information. To avoid this, one could consider the ‘SDU format information’ approach (section 7.3.2.2), which however introduces a bigger impact on the PDP context message size.
7.3.3 Working assumption
Currently option 7.3.2.3 seems to be the most promising solution.
7.4 Limitations due to RTP handling
Editors note: This section is to be restructured.
The Sequence Number (SEQ) and Timestamp (TS) in the RTP header determine the time instant when the contents of a packet is played out at the receiver. The SEQ is expected to increment by one at the receiver, otherwise it will be interpreted as a gap in the sequence. Also, the first TS value received is used as a reference at the receiver. This reference together with a timestamp determines the presentation time of subsequent RTP packets. During handover events (and possibly during normal operation), positive or negative slips in sequence numbers may occur. Depending on the size of the slip this may cause degradation of speech quality. A positive drift in a subsequent timestamps will cause the RTP receiver to generate a silence period. The length of this silence period will be equal to the drift in seconds. A negative drift in the timestamp will cause the RTP receiver to drop the packet, since from its perspective, the presentation time for the contents of the current packet has passed.
7.5 Identification of header removal allowed
7.5.1 Description of problem
As described in chapter 7.3, GERAN will be made aware if a supported speech codec is used, and if so, which one. However, it is also necessary for GERAN to identify whether or not it is allowed to use header removal. If the speech media flow is part of a multimedia application requiring synchronisation of the different media flows, header removal is not allowed.
7.5.2 Solutions |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.5.2.1 Activate PDP context request message approach | 7.5.2.1.1 Description of the solution
This solution is based on the principle of providing the information whether or not header removal is allowed in the Activate PDP context request message. Several solutions have been presented how to name these bits:
1. ‘Header removal allowed’ bit.
2. ‘This flow may be synchronized with other flows’ bit. (Synchronization Indicator from PASNAS)
3. The bit may be part of a transparent container delivered to the GERAN via the SGSN.
7.5.2.1.1.1 Header removal allowed bit Since header adaptation mechanism is dependent on the application (e.g. in case of VoIP only application header removal is possible) one solution is that the MS indicates the header adaptation mechanism to be applied for a particular PDP context. The indication could be part of the Quality of Service IE, and thus the solution can be combined with the solution presented in section 7.3.2, solving also the radio bearer identification problem.
The signalling flow for the solution is given in the figure below:
The application will use the SIP signalling for setting up the session, and UE is the entity that knows the type of application used for the session.
After the initial phase of SIP signalling is completed (i.e. the session description has been agreed), the UE will activate the PDP context. Specifically in case of optimized speech (VoIP with header removal) the UE will send the Activate Secondary PDP Context Request message to the network. This message contains the Quality of Service Information Element. New field is needed in QoS IE to indicate the preference of the header adaptation mechanism for the particular PDP context. An example of the field could be as shown in the following table. Table shows the QoS IE as specified in 24.008 v4.1.1.
8
7
6
5
4
3
2
1
Quality of service IEI
octet 1
Length of quality of service IE
Octet 2
0 0
spare
Delay
class
Reliability
class
octet 3
Peak
throughput
0
spare
Precedence
class
octet 4
0 0 0
spare
Mean
throughput
octet 5
Traffic Class
Delivery order
Delivery of erroneous SDU
Octet 6
Maximum SDU size
Octet 7
Maximum bit rate for uplink
Octet 8
Maximum bit rate for downlink
Octet 9
Residual BER
SDU error ratio
Octet 10
Transfer delay
Traffic Handling priority
Octet 11
Guaranteed bit rate for uplink
Octet 12
Guaranteed bit rate for downlink
Octet 13
Spare
Header Adaptation
Octet 14
Figure 10.5.138/TS 24.008: Quality of service information element
Table 10.5.156/TS 24.008: Quality of service information element
Header Adaptation (Octet 14)
Bits
2 1
In MS to network direction:
0 0 No header Adaptation preferred
0 1 Header Removal preferred
1 0 Header Removal not possible
1 1 Spare
The SGSN send the RAB assignment request as specified in 25.413 and include the proposed "Header Adaptation" field in RAB Parameters IE. SGSN could as well use predefined QoS parameter combination in the RAB assignment message which would give unambiguous information to GERAN that header removal can be used.
When receiving the RAB assignment request, radio access network would choose the header adaptation mechanism according to its algorithm and inform the UE using Radio Bearer Set-up message.
The example shown above is only one possibility on how to convey the necessary information to the radio access network. If this solution is combined with the solution described in section 7.3.2.3 (dealing with the problem of radio bearer identification), there is potential room for parameter optimisation. One possible scheme is that an explicit codec indication (according to 7.3.2.3) by default implies that header removal is allowed and preferred, making a specific ‘header adaptation’ field superfluous. Such syntax details are FFS.
7.5.2.1.1.2 ‘This flow may be synchronized with other flows’ bit
Editors note: This is an alternative way of providing the necessary information (as described in chapter 7.5.1) from the terminal to the GERAN. This section is to be completed.
7.5.2.1.1.3 Information provided in a transparent container
Editors note: This is an alternative way of providing the necessary information (as described in chapter 7.5.1) from the terminal to the GERAN. This section is to be completed. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.5.2.1.2 Pros and cons | + This solution has the advantage that it implies very limited changes to existing specifications.
- A possible drawback is that that higher protocol messages such as the PDP context messages have to convey header adaptation information, which can be considered as being radio access related. Given the nature of optimized speech and its relation to the application setup, this drawback would seem inevitable. |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.5.2.2 Direct communication between the UE and the BSC | A different method is used to indicate that HR is possible when using the direct communications approach (see section 7.3.2.1.1). |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.5.3 Working assumption | No agreement reached so far.
7.6 IP and port number information transfer from MS to GERAN
7.6.1 Description of problem
In order to carry out header regeneration in the uplink the relevant information must be communicated with the PDCP entity in the GERAN. A number of possibilities have been identified, so far, in order to transfer IP and port numbers from the MS to PDCP in BSS.
7.6.2 Solutions |
1549644dc078ef9fd6712bc573d8101d | 43.900 | 7.6.2.1 RRC signalling approach |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.