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

Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control; Sub-part 2: Generic Call Control SCF (Parlay 4)

Maintenance update of ES 202 915-4-2 V1.1.1 to produce ES 202 915-4-2 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 )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 4. del: Krmiljenje klica – 2. poddel: Generično krmiljenje klica SCF

General Information

• 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-2 V1.2.1 (2003-08) - Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control; Sub-part 2: Generic Call Control SCF (Parlay 4)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 202 915-4-2 V1.2.1:2005
01-januar-2005
2GSUWLGRVWRSGRVWRULWYH26$±9PHVQLN]DDSOLNDFLMVNRSURJUDPLUDQMH$3,±
GHO.UPLOMHQMHNOLFD±SRGGHO*HQHULþQRNUPLOMHQMHNOLFD6&)
Open Service Access (OSA); Application Programming Interface (API); Part 4: Call
Control; Sub-part 2: Generic Call Control SCF (Parlay 4)
Ta slovenski standard je istoveten z: ES 202 915-4-2 Version 1.2.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 202 915-4-2 V1.2.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

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

---------------------- Page: 2 ----------------------

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

ETSI ES 202 915-4-2 V1.2.1 (2003-08)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 4: Call Control;
Sub-part 2: Generic Call Control SCF
(Parlay 4)



�

---------------------- Page: 3 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 2 ETSI ES 202 915-4-2 V1.2.1 (2003-08)



Reference
RES/SPAN-120096-4-2
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

---------------------- Page: 4 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 3 ETSI ES 202 915-4-2 V1.2.1 (2003-08)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.8
2 References.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Generic Call Control Service Sequence Diagrams.9
4.1 Additional Callbacks.9
4.2 Alarm Call.10
4.3 Application Initiated Call .12
4.4 Call Barring 1 .13
4.5 Number Translation 1.15
4.6 Number Translation 1 (with callbacks) .17
4.7 Number Translation 2.19
4.8 Number Translation 3.20
4.9 Number Translation 4.22
4.10 Number Translation 5.24
4.11 Prepaid.25
4.12 Pre-Paid with Advice of Charge (AoC).26
5 Class Diagrams.29
6 Generic Call Control Service Interface Classes .30
6.1 Interface Class IpCallControlManager.31
6.1.1 Method createCall().31
6.1.2 Method enableCallNotification().32
6.1.3 Method disableCallNotification().33
6.1.4 Method setCallLoadControl().33
6.1.5 Method changeCallNotification().34
6.1.6 Method getCriteria().34
6.2 Interface Class IpAppCallControlManager .34
6.2.1 Method callAborted().35
6.2.2 Method callEventNotify().35
6.2.3 Method callNotificationInterrupted().36
6.2.4 Method callNotificationContinued().36
6.2.5 Method callOverloadEncountered().36
6.2.6 Method callOverloadCeased().36
6.3 Interface Class IpCall .37
6.3.1 Method routeReq().37
6.3.2 Method release().38
6.3.3 Method deassignCall().39
6.3.4 Method getCallInfoReq().39
6.3.5 Method setCallChargePlan().39
6.3.6 Method setAdviceOfCharge().40
6.3.7 Method getMoreDialledDigitsReq().40
6.3.8 Method superviseCallReq().41
6.4 Interface Class IpAppCall .41
6.4.1 Method routeRes().42
6.4.2 Method routeErr().42
6.4.3 Method getCallInfoRes().42
6.4.4 Method getCallInfoErr().43
6.4.5 Method superviseCallRes().43
6.4.6 Method superviseCallErr().43
6.4.7 Method callFaultDetected().44
ETSI

---------------------- Page: 5 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 4 ETSI ES 202 915-4-2 V1.2.1 (2003-08)
6.4.8 Method getMoreDialledDigitsRes().44
6.4.9 Method getMoreDialledDigitsErr().44
6.4.10 Method callEnded().44
7 Generic Call Control Service State Transition Diagrams.45
7.1 State Transition Diagrams for IpCallControlManager .45
7.1.1 Active State.45
7.1.2 Notification terminated State .45
7.2 State Transition Diagrams for IpCall.46
7.2.1 Network Released State .46
7.2.2 Finished State.46
7.2.3 Application Released State.46
7.2.4 No Parties State.47
7.2.5 Active State.47
7.2.6 1 Party in Call State .47
7.2.7 2 Parties in Call State.47
7.2.8 Routing to Destination(s) State.48
8 Generic Call Control Service Properties .48
8.1 List of Service Properties .48
8.2 Service Property values for the CAMEL Service Environment .49
9 Generic Call Control Data Definitions.50
9.1 Generic Call Control Event Notification Data Definitions.50
9.1.1 TpCallEventName.50
9.1.2 TpCallNotificationType.51
9.1.3 TpCallEventCriteria.51
9.1.4 TpCallEventInfo.52
9.2 Generic Call Control Data Definitions .52
9.2.1 IpCall.52
9.2.2 IpCallRef.52
9.2.3 IpAppCall.52
9.2.4 IpAppCallRef.52
9.2.5 TpCallIdentifier.52
9.2.6 IpAppCallControlManager.52
9.2.7 IpAppCallControlManagerRef.52
9.2.8 IpCallControlManager.52
9.2.9 IpCallControlManagerRef.53
9.2.10 TpCallAppInfo.53
9.2.11 TpCallAppInfoType.53
9.2.12 TpCallAppInfoSet.53
9.2.13 TpCallEndedReport.53
9.2.14 TpCallFault.54
9.2.15 TpCallInfoReport.54
9.2.16 TpCallReleaseCause.54
9.2.17 TpCallReport.55
9.2.18 TpCallAdditionalReportInfo.55
9.2.19 TpCallReportRequest.55
9.2.20 TpCallAdditionalReportCriteria.56
9.2.21 TpCallReportRequestSet.56
9.2.22 TpCallReportType.56
9.2.23 TpCallTreatment.57
9.2.24 TpCallEventCriteriaResultSet.57
9.2.25 TpCallEventCriteriaResult.57
Annex A (normative): OMG IDL Description of Generic Call Control SCF.58
Annex B (informative): W3C WSDL Description of Generic Call Control SCF .59
Annex C (informative): Java API Description of the Call Control SCFs.60
Annex D (informative): Contents of 3GPP OSA Rel-5 Call Control .61
ETSI

---------------------- Page: 6 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 5 ETSI ES 202 915-4-2 V1.2.1 (2003-08)
Annex E (informative): Record of changes .62
E1 Interfaces.62
E.1.1 New.62
E.1.2 Deprecated.62
E.1.3 Removed.62
E.2 Methods.62
E.2.1 New.62
E.2.2 Deprecated.63
E.2.3 Modified.63
E.2.4 Removed.63
E.3 Data Definitions.63
E.3.1 New.63
E.3.2 Modified.63
E.3.3 Removed.64
E.4 Service Properties.64
E.4.1 New.64
E.4.2 Deprecated.64
E.4.3 Modified.64
E.4.4 Removed.64
E.5 Exceptions.65
E.5.1 New.65
E.5.2 Modified.65
E.5.3 Removed.65
E.6 Others.65
History .66

ETSI

---------------------- Page: 7 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 6 ETSI ES 202 915-4-2 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 2 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

---------------------- Page: 8 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 7 ETSI ES 202 915-4-2 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-2 V5.2.0 (Release 5).
ETSI

---------------------- Page: 9 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 8 ETSI ES 202 915-4-2 V1.2.1 (2003-08)
1 Scope
The present document is part 4, sub-part 2 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 Generic Call Control Service Capability Feature (SCF) aspects of the interface. All
aspects of the Generic Call Control SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
• WSDL Description of the interfaces
• Reference to the Java API description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
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-4-1: "Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control;
Sub-part 1: Call Control Common Definitions (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 defined in ES 202 915-1 apply.
ETSI

---------------------- Page: 10 ----------------------

SIST ES 202 915-4-2 V1.2.1:2005
 9 ETSI ES 202 915-4-2 V1.2.1 (2003-08)
4 Generic Call Control Service Sequence Diagrams
4.1 Additional Callbacks
The following sequence diagram shows how an application can register two call back interfaces for the same set of
events. If one of the call backs can not be used, e.g. because the application crashed, the other call back interface is used
instead.
first instance : (Logical : IpAppCallControlManager second instance : : IpAppCal lControlMan ager : IpCallControlManag er
View::IpAppLogic) (Logic.
1: new()
2: enableCallNotification( )
3: new()
4: enableCallNotification( )
5: callEventNotify(  )
6: 'forward event'
7: "call Notify result: failure"
8: callEventNotify(  )
9: "forward event"

1: The first instance of the application is started on node 1. The application creates a new IpAppCallControlManager to
handle callbacks for this first instance of the logic.
2: The
...