SIST ES 202 504-3 V1.1.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 3: Call Notification (Parlay X 3)
- Abstract
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Call Notification Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
- Status
- Published
- Publication Date
- 14-Jul-2008
- Technical Committee
- SPN - Services and Protocols for Networks
- Current Stage
- 6060 - National Implementation/Publication (Adopted Project)
- Start Date
- 18-Jun-2008
- Due Date
- 23-Aug-2008
- Completion Date
- 15-Jul-2008
Buy Documents
ETSI ES 202 504-3 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 3: Call Notification (Parlay X 3)
ETSI ES 202 504-3 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 3: Call Notification (Parlay X 3)
ETSI ES 202 504-3 V1.1.1 is an ETSI standard for Open Service Access (OSA) Parlay X Web Services, Part 3: Call Notification. It specifies a Call Notification Web Service for applications that need to receive call events or control how a network handles a call. The document is aimed at application developers, gateway implementers, and service providers working through OSA APIs.
What does SIST ES 202 504-3 V1.1.1:2008 specify?
SIST ES 202 504-3 V1.1.1:2008 specifies the Call Notification Web Service in the Parlay X 3 Web Services set for OSA. It defines the service’s XML namespaces, sequence diagrams, data definitions, interface operations, fault handling, service policy, and WSDL representation.
The document is organized into clauses for scope, references, definitions and abbreviations, detailed service description, namespaces, sequence diagrams, XML Schema data type definitions, web service interface definitions, fault definitions, and service policies. Annex A provides the normative WSDL for Call Notification, and Annex B gives a bibliography.
| Annex | What it covers |
|---|---|
| Annex A | Normative WSDL for Call Notification |
| Annex B | Bibliography |
What are the key requirements of SIST ES 202 504-3 V1.1.1:2008?
The standard defines two service styles: CallDirection for controlling call handling, and CallNotification for reporting call events to an application. In practice, this means a network can either ask an application how to treat a call, or simply notify the application while the call continues.
Call handling is driven by application responses
Clause 8.1 defines the CallDirection interface with handleBusy, handleNotReachable, handleNoAnswer, and handleCalledNumber operations. Each operation asks the application to return an Action that tells the gateway to Continue, EndCall, or Route the call.
This matters because the application is making a per-event decision for a specific call attempt. A buyer or integrator should expect the application to support policy logic such as rerouting to voicemail, a secretary, or a service number.
Route handling can include media information and charging information
Clause 7 defines the Action structure. If the action is Route, the application may provide a routingAddress, charging information, and mediaInfo.
This matters when the call is not just redirected but redirected to a specific destination with a media type choice. The standard also says that if multimedia is supported, the application can change the media types used in the call.
Call notification reports network events without controlling the call
Clause 8.2 defines the CallNotification interface with notifyBusy, notifyNotReachable, notifyNoAnswer, notifyCalledNumber, notifyAnswer, notifyPlayAndCollectEvent, and notifyPlayAndRecordEvent. These notifications inform the application about call progress or media interaction, but call processing continues in the network.
This is useful when an application needs awareness, not control, such as sending an SMS for a missed call or reacting to media interaction results.
Notification setup and teardown are managed explicitly
Clauses 8.3 and 8.4 define the manager interfaces. CallDirectionManager and CallNotificationManager start and stop notifications for selected addresses and event criteria, and media interaction notifications are tied to an existing call session.
This matters operationally because the application has to register where notifications should go and later stop them using the correlator or the call session identifier.
Correlator rules and faults are part of the interaction model
Clause 8.3 states that the correlator in the reference must be unique for the application Web Service when notification is initiated, otherwise SVC0005 is returned. The media interaction start operations also reference SVC0008 for overlapping criteria.
This matters because applications need stable correlation identifiers to match requests with later notifications and avoid duplicate registrations.
The service policy affects multimedia behavior
Clause 10 defines one service policy, MultimediaSupported, as a boolean indicating whether multimedia is supported and whether the application can change the media types used in a call.
In practice, this is the flag that tells an application whether advanced media routing and media-type selection are available in the deployment.
What terms does SIST ES 202 504-3 V1.1.1:2008 define?
ActionValues is an enumeration that captures the application’s call-handling choice: Route, Continue, or EndCall.
Action is the structure returned by call-handling operations, combining the selected action with optional routing, charging, and media information.
CallEvents is an enumeration of the event types used for notification registration, including Busy, NotReachable, NoAnswer, CalledNumber, and Answer.
CallDirection is the interface used when the network asks an application how to handle a call event before call treatment continues.
CallNotification is the interface used when the network informs an application about a call event without giving it control over call handling.
CallDirectionManager is the interface used to start and stop call-direction notifications for selected addresses and events.
CallNotificationManager is the interface used to start and stop call notifications, including media interaction notifications tied to an existing call session.
MultimediaSupported is the service policy that states whether multimedia is supported and whether media types can be changed in a call.
Who uses SIST ES 202 504-3 V1.1.1:2008?
ETSI ES 202 504-3 V1.1.1:2008 is used by application developers building telecom applications on top of OSA APIs. It is also used by gateway implementers who expose network capabilities through Parlay X Web Services.
Service providers and system integrators use it for call handling, missed-call messaging, service-number routing, and media-interaction scenarios such as play-and-collect or play-and-record. Quality and integration teams use it to verify that the web service interface, notifications, faults, and WSDL all match the Parlay X 3 model.
What changed in SIST ES 202 504-3 V1.1.1:2008 from the previous edition?
This ETSI standard is equivalent to 3GPP TS 29.199-03 V7.2.0 (Release 7). The foreword also places it in the Parlay X 3.0 set of specifications and identifies it as part 3 of the multi-part deliverable.
Which standards are used with SIST ES 202 504-3 V1.1.1:2008?
Clause 2 names W3C Recommendation: XML Schema Part 2: Datatypes as a normative reference. It provides the XML Schema data types used in the service definition, including xsd:string, xsd:anyURI, and related schema typing.
Clause 2 also names ETSI ES 202 504-1: Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 3). This part contributes the common definitions, address data items, and shared service framework used by Call Notification.
The foreword lists the related Parlay X parts, especially Part 4: Short Messaging and Part 11: Audio Call, because the document’s examples and media interaction functions connect with those services.
What does the SIST ES 202 504-3 V1.1.1:2008 document contain?
The document contains sequence diagrams for missed-call SMS notification, media interaction digit collection, and media interaction notification. It also contains XML Schema data type definitions for ActionValues, Action, and CallEvents, plus detailed operation descriptions with input and output messages.
Clause 8 provides the interface structure for CallDirection, CallNotification, CallDirectionManager, and CallNotificationManager, including request and response message names and referenced faults. Annex A contains the document/literal WSDL representation in accompanying text files, which is the part used for implementation and integration testing.
Buy Documents
ETSI ES 202 504-3 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 3: Call Notification (Parlay X 3)
ETSI ES 202 504-3 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 3: Call Notification (Parlay X 3)
Get Certified
Connect with accredited certification bodies for this standard
BSI Group
BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.
NYCE
Mexican standards and certification body.
Sponsored listings
Frequently Asked Questions
SIST ES 202 504-3 V1.1.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Parlay X Web Services - Part 3: Call Notification (Parlay X 3)". This standard covers: New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Call Notification Web Service. The following are defined here: • Name spaces. • Sequence diagrams. • Data definitions. • Interface specification plus detailed method descriptions. • Fault definitions. • Service Policies. • WSDL Description of the interfaces.
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Call Notification Web Service. The following are defined here: • Name spaces. • Sequence diagrams. • Data definitions. • Interface specification plus detailed method descriptions. • Fault definitions. • Service Policies. • WSDL Description of the interfaces.
SIST ES 202 504-3 V1.1.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.
SIST ES 202 504-3 V1.1.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.
Standards Content (Sample)
Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 3: Call Notification
(Parlay X 3)
�
2 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-3-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
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, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
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 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 SMS notification of a missed call.9
6.2 Media interaction – Collection of digits from end user.10
6.3 Notification of media interaction.10
7 XML Schema data type definition .11
7.1 ActionValues enumeration.11
7.2 Action structure.11
7.3 CallEvents enumeration.11
8 Web Service interface definition.12
8.1 Interface: CallDirection.12
8.1.1 Operation: handleBusy.12
8.1.1.1 Input message: handleBusyRequest .13
8.1.1.2 Output message: handleBusyResponse.13
8.1.1.3 Referenced faults.13
8.1.2 Operation: handleNotReachable.13
8.1.2.1 Input message: handleNotReachableRequest.13
8.1.2.2 Output message: handleNotReachableResponse.13
8.1.2.3 Referenced faults.14
8.1.3 Operation: handleNoAnswer.14
8.1.3.1 Input message: handleNoAnswerRequest .14
8.1.3.2 Output message: handleNoAnswerResponse.14
8.1.3.3 Referenced faults.14
8.1.4 Operation: handleCalledNumber.14
8.1.4.1 Input message: handleCalledNumberRequest.15
8.1.4.2 Output message: handleCalledNumberResponse.15
8.1.4.3 Referenced faults.15
8.2 Interface: CallNotification.15
8.2.1 Operation: notifyBusy.15
8.2.1.1 Input message: notifyBusyRequest .15
8.2.1.2 Output message: notifyBusyResponse.15
8.2.1.3 Referenced faults.16
8.2.2 Operation: notifyNotReachable.16
8.2.2.1 Input message: notifyNotReachableRequest.16
8.2.2.2 Output message: notifyNotReachableResponse.16
8.2.2.3 Referenced faults.16
8.2.3 Operation: notifyNoAnswer.16
8.2.3.1 Input message: notifyNoAnswerRequest .16
8.2.3.2 Output message: notifyNoAnswerResponse.16
8.2.3.3 Referenced faults.17
8.2.4 Operation: notifyCalledNumber.17
8.2.4.1 Input message: notifyCalledNumberRequest.17
ETSI
4 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
8.2.4.2 Output message: notifyCalledNumberResponse.17
8.2.4.3 Referenced faults.17
8.2.5 Operation: notifyAnswer.17
8.2.5.1 Input message: notifyAnswerRequest.17
8.2.5.2 Output message: notifyAnswerResponse.17
8.2.5.3 Referenced faults.17
8.2.6 Operation: notifyPlayAndCollectEvent.18
8.2.6.1 Input message: notifyPlayAndCollectEventRequest.18
8.2.6.2 Output message: notifyPlayAndCollectEventResponse.18
8.2.6.3 Referenced faults.18
8.2.7 Operation: notifyPlayAndRecordEvent.18
8.2.7.1 Input message: notifyPlayAndRecordEventRequest.18
8.2.7.2 Output message: notifyPlayAndRecordEventResponse.18
8.2.7.3 Referenced faults.18
8.3 Interface: CallDirectionManager.18
8.3.1 Operation: startCallDirectionNotification.19
8.3.1.1 Input message: startCallDirectionNotificationRequest .19
8.3.1.2 Output message: startCallDirectionNotificationResponse .19
8.3.1.3 Referenced Faults.19
8.3.2 Operation: stopCallDirectionNotification.19
8.3.2.1 Input message: stopCallDirectionNotificationRequest .19
8.3.2.2 Output message: stopCallDirectionNotificationResponse .19
8.3.2.3 Referenced Faults.20
8.3.3 Operation: startPlayAndCollectNotification.20
8.3.3.1 Input message: startPlayAndCollectNotificationRequest .20
8.3.3.2 Output message: startPlayAndCollectNotificationResponse.20
8.3.3.3 Referenced Faults.20
8.3.4 Operation: startPlayAndRecordNotification.20
8.3.4.1 Input message: startPlayAndRecordNotificationRequest .20
8.3.4.2 Output message: startPlayAndRecordNotificationResponse .21
8.3.4.3 Referenced Faults.21
8.3.5 Operation: stopMediaInteractionNotification.21
8.3.5.1 Input Message: stopMediaInteractionNotificationRequest .21
8.3.5.2 Output Message: stopMediaInteractionNotificationResponse .21
8.3.5.3 Referenced Faults.21
8.4 Interface: CallNotificationManager.21
8.4.1 Operation: StartCallNotification.21
8.4.1.1 Input message: startCallNotificationRequest .22
8.4.1.2 Output message: startCallNotificationResponse.22
8.4.1.3 Referenced Faults.22
8.4.2 Operation: stopCallNotification.22
8.4.2.1 Input message: stopCallNotificationRequest .22
8.4.2.2 Output message: stopCallNotificationResponse .22
8.4.2.3 Referenced Faults.22
9 Fault definitions.23
10 Service policies .23
Annex A (normative): WSDL for Call Notification .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 3 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-03 V7.2.0 (Release 7).
ETSI
7 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
1 Scope
The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Call Notification Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
8 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services;
Part 1: Common (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
Currently, in order to determine the handling of a subscriber initiated call in telecommunication networks we have to
write applications using specific protocols to access Call Control functions provided by network elements. This
approach requires a high degree of network expertise. We can also use the OSA gateway approach, invoking standard
interfaces to gain access to call control capabilities, but these interfaces are usually perceived to be quite complex by
application IT developers. Developers must have advanced telecommunication skills to use Call Control OSA
interfaces.
In this clause we will describe a Parlay X Web Service, Call Notification, for handling calls initiated by a subscriber in
the network. A (third party) application determines how the call should be treated. The overall scope of this Web
Service is to provide simple functions to application developers to determine how a call should be treated. It is possible
to request to end the call, continue the call or re-route the call. Optionally, it is also possible to request the media
type(s) when the action is to re-route the call. It provides, for example, the capability to route a call to an IVR in order
to play a video stream to the calling subscriber. A service policy determines if multimedia application control is
supported.
The media types used in the call can be retrieved using the getMediaForParticipant or getMediaForCall operations
of the Audio Call web service.
Using the Web Services, application developers can perform simple handling of network-initiated calls without specific
Telco knowledge.
Examples of usage include the following:
Incoming call handling: A subscriber receives a call while he is logged-on to the Internet. Since this occupies his
telephone connection, he is regarded as busy by the network. The subscriber has an application that is invoked when
somebody tries to call him while he is busy. The application provides the subscriber with a list of choices on how to
handle the call (e.g. route the call to voicemail or other media server, redirect the call to a secretary, reject the call).
Based on the response of the subscriber the call is handled in the network. Alternatively, the call is re-routed or released
depending on the preferences of the subscriber and some context information (e.g. based on the status or location of the
subscriber).
Service numbers: An application is triggered whenever a certain service number is dialled. This number is used to
connect the caller to one of the maintenance personnel. The application redirects the call to the appropriate maintenance
person based on, e.g. calling party number, time, location and availability of the maintenance personnel.
SMS notification of missed calls: An application offers the subscriber the possibility to be notified via SMS whenever
he misses a call. The application registers to be notified when calls to its subscribers encounter busy, no-answer or
not-reachable. The application does not influence the call treatment, but sends an SMS containing the calling party
number, the time and reason why the call was missed.
ETSI
9 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
MediaInteraction: An application is provided information regarding the start of a media stream to an end user, the
termination of a media stream that the end user is watching, and other media events, e.g. the end-user pausing playback
of a media stream. For example, starting to stream a video to an end user, the end user pausing the ongoing video
stream and the ending of the video stream.
5 Namespaces
The CallDirection interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/v3_2
The CallDirectionNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/notification_manager/v3_1
The CallNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/v3_2
The CallNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/call_notification/v3_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 SMS notification of a missed call
Showing the use of the CallNotification and Short Messaging Web Services, an SMS is sent to a person who misses a
call (no answer). This sequence assumes that the provisioning of the "no answer" call notification has occurred
independently.
ETSI
10 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
Application Call Notification
Web Service
“A does not answer”event report (call monitor mode)
notifyNoAnswerRequest
notifyNoAnswerResponse
Short Messaging
Web Service
(ref. Part 4)
sendSmsRequest
sendSmsResponse
Sends an SMS “missed call”
notification to A
Figure 1
6.2 Media interaction – Collection of digits from end user
The application requests the CallNotificationManager to start the process of receiving media notifications. In this
example the application requests to receive notifications for the playing of a file and the network collecting digits from
the end user.
ReRequequestinstingg CallNotificationManager DDigit Colleigit Collectctionion
AAppplicplicationation API ReResoursourcece
StartPlayAndCollectNotification
collcolleecctIntInfformormaationtion((
“d“diiggiitts”s”))
Figure 2
6.3 Notification of media interaction
In this example the application is being notified of the collection of a digit string that was collected by a digit collection
resource.
ETSI
11 Final draft ETSI ES 202 504-3 V1.1.1 (2008-02)
RRRReeeequestinquestinquestinquestingggg
CCCCaaaallNllNllNllNotificatotificatotificatotificationionionion DiDiDiDigigigigit Colt Colt Colt Collllleeeeccccttttiiiioooonnnn
AAAApplicationpplicationpplicationpplication
APAPAPAPIIII RRRResouresouresouresourc
...
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 3: Call Notification
(Parlay X 3)
�
2 ETSI ES 202 504-3 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-3-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
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, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
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 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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 504-3 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 SMS notification of a missed call.9
6.2 Media interaction – Collection of digits from end user.10
6.3 Notification of media interaction.11
7 XML Schema data type definition .11
7.1 ActionValues enumeration.11
7.2 Action structure.11
7.3 CallEvents enumeration.12
8 Web Service interface definition.12
8.1 Interface: CallDirection.12
8.1.1 Operation: handleBusy.12
8.1.1.1 Input message: handleBusyRequest .13
8.1.1.2 Output message: handleBusyResponse.13
8.1.1.3 Referenced faults.13
8.1.2 Operation: handleNotReachable.13
8.1.2.1 Input message: handleNotReachableRequest.13
8.1.2.2 Output message: handleNotReachableResponse.13
8.1.2.3 Referenced faults.14
8.1.3 Operation: handleNoAnswer.14
8.1.3.1 Input message: handleNoAnswerRequest .14
8.1.3.2 Output message: handleNoAnswerResponse.14
8.1.3.3 Referenced faults.14
8.1.4 Operation: handleCalledNumber.14
8.1.4.1 Input message: handleCalledNumberRequest.15
8.1.4.2 Output message: handleCalledNumberResponse.15
8.1.4.3 Referenced faults.15
8.2 Interface: CallNotification.15
8.2.1 Operation: notifyBusy.15
8.2.1.1 Input message: notifyBusyRequest .15
8.2.1.2 Output message: notifyBusyResponse.15
8.2.1.3 Referenced faults.16
8.2.2 Operation: notifyNotReachable.16
8.2.2.1 Input message: notifyNotReachableRequest.16
8.2.2.2 Output message: notifyNotReachableResponse.16
8.2.2.3 Referenced faults.16
8.2.3 Operation: notifyNoAnswer.16
8.2.3.1 Input message: notifyNoAnswerRequest .16
8.2.3.2 Output message: notifyNoAnswerResponse.16
8.2.3.3 Referenced faults.17
8.2.4 Operation: notifyCalledNumber.17
8.2.4.1 Input message: notifyCalledNumberRequest.17
ETSI
4 ETSI ES 202 504-3 V1.1.1 (2008-05)
8.2.4.2 Output message: notifyCalledNumberResponse.17
8.2.4.3 Referenced faults.17
8.2.5 Operation: notifyAnswer.17
8.2.5.1 Input message: notifyAnswerRequest.17
8.2.5.2 Output message: notifyAnswerResponse.17
8.2.5.3 Referenced faults.17
8.2.6 Operation: notifyPlayAndCollectEvent.18
8.2.6.1 Input message: notifyPlayAndCollectEventRequest.18
8.2.6.2 Output message: notifyPlayAndCollectEventResponse.18
8.2.6.3 Referenced faults.18
8.2.7 Operation: notifyPlayAndRecordEvent.18
8.2.7.1 Input message: notifyPlayAndRecordEventRequest.18
8.2.7.2 Output message: notifyPlayAndRecordEventResponse.18
8.2.7.3 Referenced faults.18
8.3 Interface: CallDirectionManager.18
8.3.1 Operation: startCallDirectionNotification.19
8.3.1.1 Input message: startCallDirectionNotificationRequest .19
8.3.1.2 Output message: startCallDirectionNotificationResponse .19
8.3.1.3 Referenced Faults.19
8.3.2 Operation: stopCallDirectionNotification.19
8.3.2.1 Input message: stopCallDirectionNotificationRequest .19
8.3.2.2 Output message: stopCallDirectionNotificationResponse .19
8.3.2.3 Referenced Faults.20
8.3.3 Operation: startPlayAndCollectNotification.20
8.3.3.1 Input message: startPlayAndCollectNotificationRequest .20
8.3.3.2 Output message: startPlayAndCollectNotificationResponse.20
8.3.3.3 Referenced Faults.20
8.3.4 Operation: startPlayAndRecordNotification.20
8.3.4.1 Input message: startPlayAndRecordNotificationRequest .20
8.3.4.2 Output message: startPlayAndRecordNotificationResponse .21
8.3.4.3 Referenced Faults.21
8.3.5 Operation: stopMediaInteractionNotification.21
8.3.5.1 Input Message: stopMediaInteractionNotificationRequest .21
8.3.5.2 Output Message: stopMediaInteractionNotificationResponse .21
8.3.5.3 Referenced Faults.21
8.4 Interface: CallNotificationManager.21
8.4.1 Operation: StartCallNotification.21
8.4.1.1 Input message: startCallNotificationRequest .22
8.4.1.2 Output message: startCallNotificationResponse.22
8.4.1.3 Referenced Faults.22
8.4.2 Operation: stopCallNotification.22
8.4.2.1 Input message: stopCallNotificationRequest .22
8.4.2.2 Output message: stopCallNotificationResponse .22
8.4.2.3 Referenced Faults.22
9 Fault definitions.23
10 Service policies .23
Annex A (normative): WSDL for Call Notification .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 504-3 V1.1.1 (2008-05)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 3 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
ETSI
6 ETSI ES 202 504-3 V1.1.1 (2008-05)
The present document is equivalent to 3GPP TS 29.199-03 V7.2.0 (Release 7).
ETSI
7 ETSI ES 202 504-3 V1.1.1 (2008-05)
1 Scope
The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Call Notification Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
8 ETSI ES 202 504-3 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services;
Part 1: Common (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
Currently, in order to determine the handling of a subscriber initiated call in telecommunication networks we have to
write applications using specific protocols to access Call Control functions provided by network elements. This
approach requires a high degree of network expertise. We can also use the OSA gateway approach, invoking standard
interfaces to gain access to call control capabilities, but these interfaces are usually perceived to be quite complex by
application IT developers. Developers must have advanced telecommunication skills to use Call Control OSA
interfaces.
In this clause we will describe a Parlay X Web Service, Call Notification, for handling calls initiated by a subscriber in
the network. A (third party) application determines how the call should be treated. The overall scope of this Web
Service is to provide simple functions to application developers to determine how a call should be treated. It is possible
to request to end the call, continue the call or re-route the call. Optionally, it is also possible to request the media
type(s) when the action is to re-route the call. It provides, for example, the capability to route a call to an IVR in order
to play a video stream to the calling subscriber. A service policy determines if multimedia application control is
supported.
The media types used in the call can be retrieved using the getMediaForParticipant or getMediaForCall operations
of the Audio Call web service.
Using the Web Services, application developers can perform simple handling of network-initiated calls without specific
Telco knowledge.
Examples of usage include the following:
Incoming call handling: A subscriber receives a call while he is logged-on to the Internet. Since this occupies his
telephone connection, he is regarded as busy by the network. The subscriber has an application that is invoked when
somebody tries to call him while he is busy. The application provides the subscriber with a list of choices on how to
handle the call (e.g. route the call to voicemail or other media server, redirect the call to a secretary, reject the call).
Based on the response of the subscriber the call is handled in the network. Alternatively, the call is re-routed or released
depending on the preferences of the subscriber and some context information (e.g. based on the status or location of the
subscriber).
Service numbers: An application is triggered whenever a certain service number is dialled. This number is used to
connect the caller to one of the maintenance personnel. The application redirects the call to the appropriate maintenance
person based on, e.g. calling party number, time, location and availability of the maintenance personnel.
SMS notification of missed calls: An application offers the subscriber the possibility to be notified via SMS whenever
he misses a call. The application registers to be notified when calls to its subscribers encounter busy, no-answer or
not-reachable. The application does not influence the call treatment, but sends an SMS containing the calling party
number, the time and reason why the call was missed.
ETSI
9 ETSI ES 202 504-3 V1.1.1 (2008-05)
MediaInteraction: An application is provided information regarding the start of a media stream to an end user, the
termination of a media stream that the end user is watching, and other media events, e.g. the end-user pausing playback
of a media stream. For example, starting to stream a video to an end user, the end user pausing the ongoing video
stream and the ending of the video stream.
5 Namespaces
The CallDirection interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/v3_2
The CallDirectionNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/notification_manager/v3_1
The CallNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/v3_2
The CallNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/call_notification/v3_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 SMS notification of a missed call
Showing the use of the CallNotification and Short Messaging Web Services, an SMS is sent to a person who misses a
call (no answer). This sequence assumes that the provisioning of the "no answer" call notification has occurred
independently.
ETSI
10 ETSI ES 202 504-3 V1.1.1 (2008-05)
Application Call Notification
Web Service
“A does not answer”event report (call monitor mode)
notifyNoAnswerRequest
notifyNoAnswerResponse
Short Messaging
Web Service
(ref. Part 4)
sendSmsRequest
sendSmsResponse
Sends an SMS “missed call”
notification to A
Figure 1
6.2 Media interaction – Collection of digits from end user
The application requests the CallNotificationManager to start the process of receiving media notifications. In this
example the application requests to receive notifications for the playing of a file and the network collecting digits from
the end user.
ReRequequestinstingg
CallNotificationManager DDiigit Collegit Collectctionion
AAppplicplicationation API ReResoursourcece
StartPlayAndCollectNotification
collcolleecctIntInfformormaationtion((
“d“diiggiitts”s”))
Figure 2
ETSI
11 ETSI ES 202 504-3 V1.1.1 (2008-05)
6.3 Notification of media interaction
In this example the application is being notified of the collection of a digit string that was collected by a digit collection
resource.
RRRReeeequestinquestinquestinquestingggg CCCCaaaallNllNllNllNotificatotificatotificatotificationionionion DiDiDiDigigigigit Colt Colt Colt Collllleeeeccccttttiiiioooonnnn
AAAApplicationpplicationpplicationpplication APAPAPAPIIII RRRResouresouresouresourcececece
‘017
...
SLOVENSKI STANDARD
01-september-2008
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 3. del: Priglasitev klica
(Parlay X 3)
Open Service Access (OSA) - Parlay X Web Services - Part 3: Call Notification (Parlay X
3)
Ta slovenski standard je istoveten z: ES 202 504-3 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 3: Call Notification
(Parlay X 3)
�
2 ETSI ES 202 504-3 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-3-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
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, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
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 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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 504-3 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 SMS notification of a missed call.9
6.2 Media interaction – Collection of digits from end user.10
6.3 Notification of media interaction.11
7 XML Schema data type definition .11
7.1 ActionValues enumeration.11
7.2 Action structure.11
7.3 CallEvents enumeration.12
8 Web Service interface definition.12
8.1 Interface: CallDirection.12
8.1.1 Operation: handleBusy.12
8.1.1.1 Input message: handleBusyRequest .13
8.1.1.2 Output message: handleBusyResponse.13
8.1.1.3 Referenced faults.13
8.1.2 Operation: handleNotReachable.13
8.1.2.1 Input message: handleNotReachableRequest.13
8.1.2.2 Output message: handleNotReachableResponse.13
8.1.2.3 Referenced faults.14
8.1.3 Operation: handleNoAnswer.14
8.1.3.1 Input message: handleNoAnswerRequest .14
8.1.3.2 Output message: handleNoAnswerResponse.14
8.1.3.3 Referenced faults.14
8.1.4 Operation: handleCalledNumber.14
8.1.4.1 Input message: handleCalledNumberRequest.15
8.1.4.2 Output message: handleCalledNumberResponse.15
8.1.4.3 Referenced faults.15
8.2 Interface: CallNotification.15
8.2.1 Operation: notifyBusy.15
8.2.1.1 Input message: notifyBusyRequest .15
8.2.1.2 Output message: notifyBusyResponse.15
8.2.1.3 Referenced faults.16
8.2.2 Operation: notifyNotReachable.16
8.2.2.1 Input message: notifyNotReachableRequest.16
8.2.2.2 Output message: notifyNotReachableResponse.16
8.2.2.3 Referenced faults.16
8.2.3 Operation: notifyNoAnswer.16
8.2.3.1 Input message: notifyNoAnswerRequest .16
8.2.3.2 Output message: notifyNoAnswerResponse.16
8.2.3.3 Referenced faults.17
8.2.4 Operation: notifyCalledNumber.17
8.2.4.1 Input message: notifyCalledNumberRequest.17
ETSI
4 ETSI ES 202 504-3 V1.1.1 (2008-05)
8.2.4.2 Output message: notifyCalledNumberResponse.17
8.2.4.3 Referenced faults.17
8.2.5 Operation: notifyAnswer.17
8.2.5.1 Input message: notifyAnswerRequest.17
8.2.5.2 Output message: notifyAnswerResponse.17
8.2.5.3 Referenced faults.17
8.2.6 Operation: notifyPlayAndCollectEvent.18
8.2.6.1 Input message: notifyPlayAndCollectEventRequest.18
8.2.6.2 Output message: notifyPlayAndCollectEventResponse.18
8.2.6.3 Referenced faults.18
8.2.7 Operation: notifyPlayAndRecordEvent.18
8.2.7.1 Input message: notifyPlayAndRecordEventRequest.18
8.2.7.2 Output message: notifyPlayAndRecordEventResponse.18
8.2.7.3 Referenced faults.18
8.3 Interface: CallDirectionManager.18
8.3.1 Operation: startCallDirectionNotification.19
8.3.1.1 Input message: startCallDirectionNotificationRequest .19
8.3.1.2 Output message: startCallDirectionNotificationResponse .19
8.3.1.3 Referenced Faults.19
8.3.2 Operation: stopCallDirectionNotification.19
8.3.2.1 Input message: stopCallDirectionNotificationRequest .19
8.3.2.2 Output message: stopCallDirectionNotificationResponse .19
8.3.2.3 Referenced Faults.20
8.3.3 Operation: startPlayAndCollectNotification.20
8.3.3.1 Input message: startPlayAndCollectNotificationRequest .20
8.3.3.2 Output message: startPlayAndCollectNotificationResponse.20
8.3.3.3 Referenced Faults.20
8.3.4 Operation: startPlayAndRecordNotification.20
8.3.4.1 Input message: startPlayAndRecordNotificationRequest .20
8.3.4.2 Output message: startPlayAndRecordNotificationResponse .21
8.3.4.3 Referenced Faults.21
8.3.5 Operation: stopMediaInteractionNotification.21
8.3.5.1 Input Message: stopMediaInteractionNotificationRequest .21
8.3.5.2 Output Message: stopMediaInteractionNotificationResponse .21
8.3.5.3 Referenced Faults.21
8.4 Interface: CallNotificationManager.21
8.4.1 Operation: StartCallNotification.21
8.4.1.1 Input message: startCallNotificationRequest .22
8.4.1.2 Output message: startCallNotificationResponse.22
8.4.1.3 Referenced Faults.22
8.4.2 Operation: stopCallNotification.22
8.4.2.1 Input message: stopCallNotificationRequest .22
8.4.2.2 Output message: stopCallNotificationResponse .22
8.4.2.3 Referenced Faults.22
9 Fault definitions.23
10 Service policies .23
Annex A (normative): WSDL for Call Notification .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 504-3 V1.1.1 (2008-05)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 3 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
ETSI
6 ETSI ES 202 504-3 V1.1.1 (2008-05)
The present document is equivalent to 3GPP TS 29.199-03 V7.2.0 (Release 7).
ETSI
7 ETSI ES 202 504-3 V1.1.1 (2008-05)
1 Scope
The present document is part 3 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Call Notification Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
ETSI
8 ETSI ES 202 504-3 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services;
Part 1: Common (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
Currently, in order to determine the handling of a subscriber initiated call in telecommunication networks we have to
write applications using specific protocols to access Call Control functions provided by network elements. This
approach requires a high degree of network expertise. We can also use the OSA gateway approach, invoking standard
interfaces to gain access to call control capabilities, but these interfaces are usually perceived to be quite complex by
application IT developers. Developers must have advanced telecommunication skills to use Call Control OSA
interfaces.
In this clause we will describe a Parlay X Web Service, Call Notification, for handling calls initiated by a subscriber in
the network. A (third party) application determines how the call should be treated. The overall scope of this Web
Service is to provide simple functions to application developers to determine how a call should be treated. It is possible
to request to end the call, continue the call or re-route the call. Optionally, it is also possible to request the media
type(s) when the action is to re-route the call. It provides, for example, the capability to route a call to an IVR in order
to play a video stream to the calling subscriber. A service policy determines if multimedia application control is
supported.
The media types used in the call can be retrieved using the getMediaForParticipant or getMediaForCall operations
of the Audio Call web service.
Using the Web Services, application developers can perform simple handling of network-initiated calls without specific
Telco knowledge.
Examples of usage include the following:
Incoming call handling: A subscriber receives a call while he is logged-on to the Internet. Since this occupies his
telephone connection, he is regarded as busy by the network. The subscriber has an application that is invoked when
somebody tries to call him while he is busy. The application provides the subscriber with a list of choices on how to
handle the call (e.g. route the call to voicemail or other media server, redirect the call to a secretary, reject the call).
Based on the response of the subscriber the call is handled in the network. Alternatively, the call is re-routed or released
depending on the preferences of the subscriber and some context information (e.g. based on the status or location of the
subscriber).
Service numbers: An application is triggered whenever a certain service number is dialled. This number is used to
connect the caller to one of the maintenance personnel. The application redirects the call to the appropriate maintenance
person based on, e.g. calling party number, time, location and availability of the maintenance personnel.
SMS notification of missed calls: An application offers the subscriber the possibility to be notified via SMS whenever
he misses a call. The application registers to be notified when calls to its subscribers encounter busy, no-answer or
not-reachable. The application does not influence the call treatment, but sends an SMS containing the calling party
number, the time and reason why the call was missed.
ETSI
9 ETSI ES 202 504-3 V1.1.1 (2008-05)
MediaInteraction: An application is provided information regarding the start of a media stream to an end user, the
termination of a media stream that the end user is watching, and other media events, e.g. the end-user pausing playback
of a media stream. For example, starting to stream a video to an end user, the end user pausing the ongoing video
stream and the ending of the video stream.
5 Namespaces
The CallDirection interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/v3_2
The CallDirectionNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_direction/notification_manager/v3_1
The CallNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/v3_2
The CallNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/call_notification/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/call_notification/v3_1
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in XML
Schema [1]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 SMS notification of a missed call
Showing the use of the CallNotification and Short Messaging Web Services, an SMS is sent to a person who misses a
call (no answer). This sequence assumes that the provisioning of the "no answer" call notification has occurred
independently.
ETSI
10 ETSI ES 202 504-3 V1.1.1 (2008-05)
Application Call Notification
Web Service
“A does not answer”event report (call monitor mode)
notifyNoAnswerRequest
notifyNoAnswerResponse
Short Messaging
Web Service
(ref. Part 4)
sendSmsRequest
sendSmsResponse
Sends an SMS “missed call”
notification to A
Figure 1
6.2 Media interaction – Collection of digits from end user
The application requests the CallNotificationManager to start the process of receiving media notifications. In this
example the application requests to receive notifications for the playing of a file and the network collecting digits from
the end user.
ReRequequestinstingg
CallNotificationManager DDiigit Collegit Collectctionion
AAppplicplicationation API ReResoursourcece
StartPlayAndCollectNotification
collcolleecctIntInfformormaationtion((
“d“diiggiitts”s”))
Figure 2
ETSI
11 ETSI ES 202 504-3 V1.1.1 (2008-05)
6.3 Notification of media interaction
In this example the application is being notified of the collection of a digit string that was collected by a digit
...