SIST ES 202 915-4-1 V1.2.1:2005

• Abstract:

  Maintenance update of ES 202 915-4-1 V1.1.1 to produce ES 202 915-4-1 V1.2.1 Updated document will also be known as PARLAY 4.1. Only those parts requiring modification will be updated ( most parts require maintenance fixes )

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 202 915-4-1 V1.2.1 (2003-08) - Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control; Sub-part 1: Call Control Common Definitions (Parlay 4)

SIST ES 202 915-4-1 V1.2.1:2005 is SIST’s publication of the Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control; Sub-part 1: Call Control Common Definitions standard. It defines the shared call-control model, interface conventions and common data types used by Call Control Service Capability Features (SCF) in the Parlay 4.1 API family, for application and service implementers.

What does SIST ES 202 915-4-1 V1.2.1:2005 specify?

SIST ES 202 915-4-1 V1.2.1:2005 is a maintenance update of ES 202 915-4-1 V1.1.1, and the updated document is also known as PARLAY 4.1. It belongs to the Stage 3 OSA API specification and focuses on the common definitions used by Call Control SCFs.

The document is organized around the call-control model, the service interface specifications, and the common call-control data types. The foreword also places this sub-part in the wider OSA API family and notes that the document is equivalent to 3GPP TS 29.198-4-1 V5.2.0 (Release 5).

Annex	What it covers
Annex A	Normative OMG IDL description of the common call-control data types
Annex B	Informative W3C WSDL description of the common call-control data types
Annex C	Informative Java API description of the Call Control SCFs
Annex D	Informative contents of 3GPP OSA Rel-5 Call Control
Annex E	Informative record of changes

What are the key requirements of SIST ES 202 915-4-1 V1.2.1:2005?

Call model and call control behavior

Clause 4 defines the call-control model around a call object, a call leg object, an address and a terminal. In practice, an implementation treats a call as a set of related legs, with each leg linked to a party address and, when routed, connected to the network address.

Clause 4 also distinguishes between attached and detached legs, and between controlling and passive legs. That matters because only attached legs can exchange media or bearer channels, and the call is released when the controlling leg is released.

Clause 4 explains two ways an application can gain control of a call - by being notified of calls that match criteria, or by creating a new call. That tells a platform designer how calls enter application control and when existing legs may already be present.

Method support and interface structure

Clause 4.3 sets the basic implementation rule for call-control methods: if an implementation supports a method, it supports the method’s functionality for at least one valid set of parameter values. For a buyer or integrator, that means partial support is allowed only within that rule, so supported methods still need predictable behavior.

Clause 4.3 also defines error handling when a method is not implemented. A service-side unsupported method returns P_METHOD_NOT_SUPPORTED, while an unsupported application-side method can still be called and must not raise an exception.

Clause 5 describes the interface style used throughout the API with Unified Modelling Language (UML). Service and framework interfaces use the Ip<name> naming pattern, application callback interfaces use IpApp<name>, and asynchronous methods use Req, Res and Err suffixes.

Clause 5.2 and 5.4 define the base and generic service interfaces. IpInterface is the shared base interface, IpService adds setCallback() and setCallbackWithSessionID(), and those methods control how the service reaches the application callback interface.

The callback rules matter in real systems because the API separates session-less and session-based interaction. setCallback() is for interfaces that do not use SessionIDs, while setCallbackWithSessionID() binds callbacks to a specific session such as a call or call leg.

Common data types for call handling, charging and reporting

Clause 6 collects the common data types used by call-control methods. The most practical groups are charging, event reporting, monitoring, supervision and media or service classification.

Charging data includes TpCallChargePlan, TpCallPartyToChargeType and TpCallChargeOrderCategory. These types tell a charging application how to identify the billed party and whether the call uses transparent charging or a predefined charge plan.

Reporting and supervision data include TpCallEndedReport, TpCallError, TpCallInfoReport, TpCallSuperviseReport and TpCallSuperviseTreatment. In practice, they define what the service reports back about call end causes, call timing, supervision timers, warning tones and user-interaction completion.

Clause 6 also defines load-control and monitoring types such as TpCallLoadControlMechanism, TpCallLoadControlIntervalRate and TpCallMonitorMode. These types let a network or application pace call admission, interrupt or only observe events, and decide how the service behaves when a call is supervised.

Media and network classification types include TpCallNetworkAccessType, TpCallPartyCategory, TpCallServiceCode, TpCallTeleService and TpMediaType. These values help an implementation interpret what kind of access, caller, service or media is involved in a call.

What terms does SIST ES 202 915-4-1 V1.2.1:2005 define?

• Open Service Access (OSA) - the architecture that lets application developers use network functionality through an open standardized interface.
• Application Programming Interface (API) - the interface family specified here for invoking network capabilities and receiving callbacks.
• Service Capability Feature (SCF) - a capability area such as Call Control, exposed through service interfaces and common data types.
• Unified Modelling Language (UML) - the notation used to describe interface classes, methods, parameters and state models.
• OMG IDL - the normative interface-language form of the common call-control data types, given in Annex A.
• W3C WSDL - the web-service form of the common call-control data types, given in Annex B.

Who uses SIST ES 202 915-4-1 V1.2.1:2005?

This standard is used by telecom application developers, service platform vendors, network API designers and systems integrators working with OSA/Parlay interfaces. It is also relevant to quality and test teams that need to validate callback handling, call supervision, charging data and call-event reporting. Network operators and charging-system engineers use it when implementing call-control behavior and the data exchanged with billing or supervision systems.

What changed in SIST ES 202 915-4-1 V1.2.1:2005 from the previous edition?

SIST ES 202 915-4-1 V1.2.1:2005 updates ES 202 915-4-1 V1.1.1 and is the PARLAY 4.1 version of the document. Annex E organizes the maintenance record by interfaces, methods, data definitions, service properties, exceptions and other items, and the record specifically names TpCallChargeOrder as not used under data definitions.

Which standards are used with SIST ES 202 915-4-1 V1.2.1:2005?

Clause 2 points to ES 202 915-1 for the provisions that apply to this document, and that part also supplies the definitions and abbreviations used here. ES 202 915-2 provides the common data definitions shared across the OSA API family. ES 202 915-5 supplies TpUIInfo, which is referenced by the call-treatment data types in this part.

What does the SIST ES 202 915-4-1 V1.2.1:2005 document contain?

The document contains the call-control SCF structure, interface specification rules, and a long set of common call-control data definitions. It also includes the base interface, generic service interface methods, and the naming and callback conventions used by the OSA API.

The annexes extend the main text with machine-readable and cross-platform views of the same definitions. Annex A gives the normative OMG IDL form, Annex B the W3C WSDL form, and Annex C a Java API reference point.

Annex D maps the content to 3GPP OSA Rel-5 Call Control, which is useful when comparing ETSI, Parlay and 3GPP usage. Annex E records the maintenance changes by category so readers can track which interfaces, methods, data definitions, service properties or exceptions were updated.

SLOVENSKI STANDARD
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 4.
del: Krmiljenje klica – 1. poddel: Skupne definicije krmiljenja klica
Open Service Access (OSA); Application Programming Interface (API); Part 4: Call
Control; Sub-part 1: Call Control Common Definitions (Parlay 4)
Ta slovenski standard je istoveten z: ES 202 915-4-1 Version 1.2.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 4: Call Control;
Sub-part 1: Call Control Common Definitions
(Parlay 4)
�
2 ETSI ES 202 915-4-1 V1.2.1 (2003-08)

Reference
RES/SPAN-120096-4-1
Keywords
API, IDL, OSA, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, send your comment to:
[e-mail]
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2003.
© The Parlay Group 2003.
All rights reserved.
TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
3 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Call Control SCF.7
4.1 Call Model Description .8
4.2 Structure of Call Control SCF Documentation.8
4.3 General requirements on support of methods.9
5 The Service Interface Specifications.9
5.1 Interface Specification Format .9
5.1.1 Interface Class.9
5.1.2 Method descriptions.9
5.1.3 Parameter descriptions.9
5.1.4 State Model.9
5.2 Base Interface.9
5.2.1 Interface Class IpInterface .9
5.3 Service Interfaces.10
5.3.1 Overview.10
5.4 Generic Service Interface .10
5.4.1 Interface Class IpService .10
5.4.1.1 Method setCallback().10
5.4.1.2 Method setCallbackWithSessionID().11
6 Common Call Control Data Types.11
6.1 TpCallAlertingMechanism.11
6.2 TpCallBearerService.11
6.3 TpCallChargePlan.12
6.4 TpCallPartyToChargeAdditionalInfo.12
6.5 TpCallPartyToChargeType.12
6.6 TpCallChargeOrderCategory.13
6.7 TpCallEndedReport.13
6.8 TpCallError.13
6.9 TpCallAdditionalErrorInfo.13
6.10 TpCallErrorType.14
6.11 TpCallInfoReport.14
6.12 TpCallInfoType.14
6.13 TpCallLoadControlMechanism.15
6.14 TpCallLoadControlIntervalRate.15
6.15 TpCallLoadControlMechanismType.15
6.16 TpCallMonitorMode.15
6.17 TpCallNetworkAccessType.16
6.18 TpCallPartyCategory.16
6.19 TpCallServiceCode.16
6.20 TpCallServiceCodeSet.16
6.21 TpCallServiceCodeType.17
6.22 TpCallSuperviseReport.17
6.23 TpCallSuperviseTreatment.17
6.24 TpCallTeleService.18
6.25 TpCallTreatment.18
6.26 TpCallTreatmentType.18
6.27 TpCallAdditionalTreatmentInfo.19
ETSI
4 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
6.28 TpMediaType.19
Annex A (normative): OMG IDL Description of Common Call Control Data Types.20
Annex B (informative): W3C WSDL Description of Common Call Control Data Types .21
Annex C (informative): Java API Description of the Call Control SCFs.22
Annex D (informative): Contents of 3GPP OSA Rel-5 Call Control .23
Annex E (informative): Record of changes .24
E.1 Interfaces.24
E.1.1 New.24
E.1.2 Deprecated.24
E.1.3 Removed.24
E.2 Methods.24
E.2.1 New.24
E.2.2 Deprecated.25
E.2.3 Modified.25
E.2.4 Removed.25
E.3 Data Definitions.25
E.3.1 New.25
E.3.2 Modified.25
E.3.3 Removed.26
E.4 Service Properties.26
E.4.1 New.26
E.4.2 Deprecated.26
E.4.3 Modified.26
E.4.4 Removed.26
E.5 Exceptions.27
E.5.1 New.27
E.5.2 Modified.27
E.5.3 Removed.27
E.6 Others.27
History .28

ETSI
5 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 4, sub-part 1 of a multi-part deliverable covering Open Service Access (OSA);
Application Programming Interface (API), as identified below. The API specification (ES 202 915) is structured in the
following parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Sub-part 1: "Call Control Common Definitions";
Sub-part 2: "Generic Call Control SCF";
Sub-part 3: "Multi-Party Call Control SCF";
Sub-part 4: "Multi-Media Call Control SCF";
Sub-part 5: "Conference Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy management SCF";
Part 14: "Presence and Availability Management SCF".
ETSI
6 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 4.1 set of specifications.
The present document is equivalent to 3GPP TS 29.198-4-1 V5.2.0 (Release 5).
ETSI
7 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
1 Scope
The present document is part 4, sub-part 1 of the Stage 3 specification for an Application Programming Interface (API)
for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the common definitions used by the Call Control Service Capability Features (SCF).
2 References
The references listed in clause 2 of ES 202 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 202 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 4)".
ETSI ES 202 915-2: "Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data
Definitions (Parlay 4)".
ETSI ES 202 915-5: "Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction
SCF (Parlay 4)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 915-1 apply.
4 Call Control SCF
Four flavours of call control APIs are specified in ES 202 915, Parlay 4. Three of these have been included in 3GPP
Release 5. These are the Generic Call Control (GCC), the Multi-Party Call Control (MPCC) and the Multi-Media Call
Control (MMCC). The generic call control is the same API as was already present in the previous specification for
3GPP Release 99 (TS 129 198 V3). Multi-Party Call Control was introduced in the Release 4 specifications, and
Multi-Media Call Control is introduced in Release 5. All four have been included in ETSI ES 201 915, Parlay 3.
The joint work between 3GPP CN5, ETSI SPAN and the Parlay Call Control Working group with collaboration from
JAIN has been focussed on the Multi-party and Multi-Media call control APIs. A number of improvements on call
control functionality have been made and are reflected in these APIs. For this it was necessary to break the inheritance
that previously existed between Generic and Multi-party call control.
The joint call control group has furthermore decided that the multi-party call control is to be considered as the future
base call control family and the technical work will not be continued on Generic Call control. Errors or technical flaws
will of course be corrected.
ETSI
8 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
4.1 Call Model Description
The call model used for the Call Control SCFs has the following objects.
• A call object. A call is a relation between a number of parties. The call object relates to the entire call view
from the application. E.g. the entire call will be released when a release is called on the call. Note that different
applications can have different views on the same physical call, e.g. one application for the originating side
and another application for the terminating side. The applications will not be aware of each other, all
'communication' between the applications will be by means of network signalling. The API currently does not
specify any feature interaction mechanisms.
• A call leg object. The leg object represents a logical association between a call and an address. The
relationship includes at least the signalling relation with the party. The relation with the address is only made
when the leg is routed. Before that the leg object is IDLE and not yet associated with the address.
• An address. The address logically represents a party in the call.
• A terminal. A terminal is the end-point of the signalling and/or media for a party. This object type is currently
not addressed.
The call object is used to establish a relation between a number of parties by creating a leg for each party within the
call.
Associated with the signalling relationship represented by the call leg, there may also be a bearer connection (e.g. in the
traditional voice only networks) or a number (zero or more) of media channels (in multi-media networks).
A leg can be attached to the call or detached from the call. When the leg is attached, this means that media or bearer
channels related to the legs are connected to the media or bearer channels of the other legs that are attached to the same
call. I.e. only legs that are attached can 'speak' to each other. A leg can have a number of states, depending on the
signalling received from or sent to the party associated with the leg. Usually there is a limit to the number of legs that
are in being routed (i.e. the connection is being established) or connected to the call (i.e. the connection is established).
Also, there usually is a limit to the number of legs that can be simultaneously attached to the same call.
Some networks distinguish between controlling and passive legs. By definition the call will be released when the
controlling leg is released. All other legs are called passive legs. There can be at most one controlling leg per call.
However, there is currently no way the application can influence whether a Leg is controlling or not.
There are two ways for an application to get the control of a call. The application can request to be notified of calls that
meet certain criteria. When a call occurs in the network that meets these criteria, the application is notified and can
control the call. Some legs will already be associated with the call in this case. Another way is to create a new call from
the application.
4.2 Structure of Call Control SCF Documentation
Each of the Call Control SCFs is specified under the following headings:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show transition between states in the SCF. The states and transitions are
well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data definitions clause show a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part ES 202 915-2.
ETSI
9 ETSI ES 202 915-4-1 V1.2.1 (2003-08)
4.3 General requirements on support of methods
An implementation of one of the call control APIs which supports or implements a method described in one of the
sub-parts of ES 202 915-4, shall support or implement the functionality described for that method, for at least one valid
set of values for the parameters of that method.
Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
Where a method is not supported by an implementation of an Application interface, a call to that method shall be
possible, and no exception shall be returned.
5 The Service Interface Specifications
5.1 Interface Specification Format
This clause defines the interfaces, methods and parameters that form a part of the API specification. The Unified
Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is
described below.
5.1.1 Interface Class
This shows a UML interface class description of the methods supported by that interface, and the relevant parameters
and types. The Service and Framework interfaces for enterprise-based client appli
...