hash
stringlengths
32
32
doc_id
stringlengths
5
12
section
stringlengths
4
1.47k
content
stringlengths
0
6.67M
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.1 Preparation
In this phase the UTRAN reserves resources for the relocation. Then the source SGSN and source RNC are informed when the target RNC is ready. The GGSN is also instructed to start bi-casting downlink N-PDUs as part of the Relocation preparation process. As an implementation choice in the SGSN, this can happen in parallel with the signalling over the Iu interface, as shown in the picture below. This is because there is no need to get any information from the Relocation Request Acknowledge before initiating the Update PDP context. This means that at the SGSN2, the Update PDP context response and the Relocation Request Ack can be received in any order, but have to be received by SGSN2 so that it can send a Forward Relocation Response to SGSN1. The Update PDP context request/response is applicable to one PDP context only, therefore one will be done for each RAB. Each request can include the instruction to start bi-casting (seamless RAB), or not (lossless or other RAB). Should the GGSN reject the bi-casting request, the entire relocation procedure shall be aborted. The original RAB/PDP Context continues unaffected by this abort. Likewise, any PDP Contexts which have begun bi-casting must be updated to revert back to the original configuration. This behaviour is described in more depth in the error handling procedure definition below. Figure 11 : Control Plane – Preparation involving 2 SGSNs In the Forward Relocation Response, the RAB setup information is conditional because it is only applicable to lossless RABs. For seamless RABs, this RAB setup information is not included. For lossless RABs, this RAB setup information is included and it instructs SGSN1 of the RNC TEID and RNC IP address for data forwarding from source RNC to target RNC. Figure 12: User Plane – Bi-casting of DL flow with 2 SGSNs involved (SRNS Relocation) Figure 13: User Plane – Bi-casting of DL flow with 2 SGSNs involved (Hard Handover) Handling of error cases in the Preparation phase: If the SGSN1 decides to not accept the relocation from the source RNC after reception of message RELOCATION REQUIRED, the SGSN1 shall send a RELOCATION PREPARATION FAILURE message to the source RNC. If the SGSN2 decides to not accept the relocation, it shall deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with a cause value other than β€˜Request accepted’. The SGSN1 can then send a RELOCATION PREPARATION FAILURE message to the source RNC. In case the GGSN is not able to accept the request for the bi-casting, the Update PDP context response message shall be sent from the GGSN to the SGSN2 as a response of the Update PDP Context Request, with a new cause value β€˜Bi-casting not supported’, or β€˜Bi-casting not possible’. In this case the SGSN2 shall deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with the cause value from the GGSN (β€˜Bi-casting not supported’, or β€˜Bi-casting not possible’). The SGSN1 can then decide to: 1. send a RELOCATION PREPARATION FAILURE message to the source RNC. This cancels the relocation for all RABs 2. In the case that there are other RABs that do not need seamless treatment, the SGSN1 can send a RAB assignment request modifying the (new parameter) in the RAB parameters to be β€œother” In case one of the GGSNs involved decide not to accept the request for relocation, the GGSN that can not accept the relocation will trigger the same process. The source RNC, when it receives RELOCATION PREPARATION FAILURE from the CN, shall initiate the Relocation Cancel procedure on the other Iu signalling connection for the UE if the other Iu signalling connection exists and if the Relocation Preparation procedure is still ongoing or the procedure has terminated successfully in that Iu signalling connection. In case any of the SGSNs or GGSNs involved decide not to accept the relocation, and if the Iu signalling connection has been established or later becomes established, the SGSN2 shall also initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". If the target RNC can not accept the relocation of SRNS or a failure occurs during the Relocation Resource Allocation procedure in the target RNC, the target RNC shall send RELOCATION FAILURE message to the SGSN2. The SGSN2 shall then deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with a cause value other than β€˜Request accepted’. The SGSN1 shall then send RELOCATION PREPARATION FAILURE message to the source RNC. If the source RNC decides to cancel the relocation, it shall send RELOCATION CANCEL to SGSN1. The SGSN1 shall then terminate the possibly ongoing Relocation Preparation procedure towards the target RNC by sending Relocation Cancel Request to the SGSN2 which then initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". Also if the GGSN had already been instructed to start bi-casting then the SGSN1 sends an Update PDP context request to the GGSN. This instructs the GGSN to stop bi-casting, and releases the newly created GTP tunnel between target SGSN and GGSN.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.2 Bi-casting of DL flow and switching of UL flow
In this phase, DL traffic is bi-casted from the GGSN to the target RNC (as well as to the source RNC). Also at this point in both the hard handover and SRNS relocation cases, the UE sends UL traffic to the target RNC and UL traffic needs to be switched to the target SGSN and GGSN, using the new route. Figure 14: Control Plane - Bi-casting of DL flow and switching of UL flow phase with 2 SGSNs involved Handling of abnormal conditions in the Bi-casting phase: If the RELOCATION DETECT message is not received by the SGSN before reception of RELOCATION COMPLETE message, the SGSN shall handle the RELOCATION COMPLETE message normally. Figure 15: Moving the serving RNC role to target RNC with 2 SGSNs involved (SRNS Relocation) Figure 16: Moving the serving RNC role to target RNC with 2 SGSNs involved (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.3 Completion
This is the completion of the signalling. Also, the GGSN is instructed to stop bi-casting downlink N-PDUs. At this stage, the relocation has effectively already been completed. Note that SGSN2 informs SGSN1 that the relocation is complete once all of the GGSNs involved have stopped the bi-casting. Then it informs SGSN1 to release the Iu connection towards the Source RNC. Figure 17: Control Plane – Completion with 2 SGSNs involved Figure 18: User Plane – Completion with 2 SGSNs involved
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3 Relocation involving only one SGSN
In the case that the relocation involves only one SGSN, the flow of N-PDUs across the Gn interface does not need to be changed. Indeed, the tunnel switching point in the SGSN can serve as the anchor for the tunnel instead of the GGSN as proposed above. Figure 19: Packet flows during relocation with only one SGSN involved, solution 2 As illustrated in the above figure, the SGSN forwards N-PDUs from either the source RNC or the target RNC allowing the N-PDUs to start flowing from the DRNC as soon as possible after the switchover. The procedure is explained below with the change in operation when the GGSN is not involved.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.1 Preparation
In this phase the UTRAN reserves resources for the relocation. Then the source SGSN and source RNC are informed when the target RNC is ready. The SGSN starts bi-casting downlink N-PDUs as part of the Relocation preparation process. Figure 20: Control Plane – Preparation phase with only one SGSN Handling of abnormal conditions in the Preparation phase: If the SGSN decides to not accept the relocation from the source RNC after reception of message RELOCATION REQUIRED, the SGSN shall stop timer TRELOCalloc and send a RELOCATION PREPARATION FAILURE message to the source RNC. If the Iu signalling connection has been established or later becomes established, the SGSN shall also initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". If the target RNC can not accept the relocation of SRNS or a failure occurs during the Relocation Resource Allocation procedure in the target RNC, the target RNC shall send RELOCATION FAILURE message to the SGSN. The SGSN shall then send RELOCATION PREPARATION FAILURE message to the source RNC. If the source RNC decides to cancel the relocation, it shall send RELOCATION CANCEL to SGSN. The SGSN shall then terminate the possibly ongoing Relocation Preparation procedure towards the target RNC by initiating the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". EMBED Word.Picture.8 Figure 21: User Plane - Bi-casting of DL flow with only one SGSN (SRNS Relocation) Figure 22: User Plane - Bi-casting of DL flow with only one SGSN (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.2 Bi-casting of DL flow and switching of UL flow
In this phase, DL traffic is bi-casted from the SGSN to the target RNC (as well as to the source RNC). Also at this point in both the hard handover and SRNS relocation cases, the UE sends UL traffic to the target RNC and UL traffic needs to be switched to the SGSN and using the new route. Figure 23: Control Plane - Bi-casting of DL flow and switching of UL flow phase with only one SGSN Figure 24: Moving the serving RNC to target RNC with only one SGSN (SRNS Relocation) Figure 25: Moving the serving RNC to target RNC with only one SGSN (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.3 Completion
This is the completion of the signalling. Also, the SGSN is instructed to stop bi-casting downlink N-PDUs. At this stage, the relocation has effectively already been completed. Figure 26: Control Plane – Completion phase with only one SGSN Handling of abnormal conditions in the Completion phase: If the RELOCATION DETECT message is not received by the SGSN before reception of RELOCATION COMPLETE message, the SGSN shall handle the RELOCATION COMPLETE message normally. Figure 27: User Plane – Completion phase with only one SGSN
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4 Specifications Impact
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4.1 Impacts on RAN3 specifications
Solution 2 does not require any new procedures or messages to be introduced to any RAN 3 specification. In R99, there is a clear indication in the RAB parameters used at RAB assignment that a RAB is to be treated in a β€œlossless” or β€œother” way. Therefore a new value for that Information Element is needed to indicate β€œseamless” to the source RNC.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4.2 Impacts on other groups’ specifications
The impacts to other groups' specifications relate to inclusion of bi-casting from GGSN to the Gn interface specification and corresponding stage 2 specifications. Procedures to initialise and terminate the GGSN bicasting from SGSN including error cases needs to be defined by TSG CN WG4. 29.060 example changes: The Bi-cast request indicates to the GGSN the requirement for real-time relocation. Information Elements in an SGSN-Initiated Update PDP Context Request Information element Presence requirement Reference Recovery Optional 7.7.11 Tunnel Endpoint Identifier for Data (I) Mandatory 7.7.13 Tunnel Endpoint Identifier Control Plane Conditional 7.7.14 NSAPI Mandatory 7.7.17 Trace Reference Optional 7.7.24 Trace Type Optional 7.7.25 SGSN Address for Control Plane Mandatory GSN Address 7.7.32 SGSN Address for User Traffic Mandatory GSN Address 7.7.32 Quality of Service Profile Mandatory 7.7.34 TFT Optional 7.7.36 Trigger Id Optional 7.7.41 OMC Identity Optional 7.7.42 Bi-cast request Conditional New reference Private Extension Optional 7.7.44 Bi-casting Request Information Element Bits Octets 8 7 6 5 4 3 2 1 1 Type=? (Decimal) 2 1 1 1 1 Spare 1 1 1 Bi-cast Req Bi-casting Request Values Bi-casting request Value (Decimal) Stop 0 Start 1 New cause value response rej Bi-casting not supported New Bi-casting not possible New When creating a new PDP context, an indication is needed to indicate that the RAB is to be treated in a seamless way. GTP-U changes to flag packets as bi-casted are needed. The spare bit (bit 4) of octet 1 in the GTP header (defined in Figure 2 of section 6 of 29.060) could be utilized to indicate if a packet was bi-casted. Stage 2 specification TS 23.060 has to be aligned with the selected solution for RT PS domain Relocation of SRNS.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.5 Interaction with other systems
The Core Network bi-casting solution will work with a GERAN connected via the Iu-PS in exactly the same way as with a UTRAN connected via the Iu-PS. Therefore all the description above is applicable to GERAN, with the RNC being replaced by a BSS (can contain BSCs or not). There is no other functionality required at the BSS other than supporting the messaging for the Iu-PS (release 4). If a release 4 Core Network is connected to a GPRS BSS, since there is no Iu-PS, no relocation can be provided. If a release 4 Core Network is connected to a R99 UTRAN, then for lossless RABs, the Core Network can request data forwarding. For seamless RABs, the Core Network can not request data forwarding, and won’t do bi-casting either since R99 UTRAN does not support real-time services. The SGSN will request handover treatment from the RNC as follows: Rel 99 CN Rel 4 CN Rel 99 UTRAN Will only request lossless or other Will request lossless, other or seamless (which will fail) Rel 4 UTRAN Will only request lossless or other Will request lossless, seamless or other – can all be supported by UTRAN If the handover is between UMTS Rel 4 and UMTS R99, we will have the following: To From Rel 99 UTRAN + Rel 99 CN Rel 99 UTRAN + Rel 4 CN Rel 4 UTRAN + Rel 99 CN Rel 4 UTRAN + Rel 4 CN Rel 99 UTRAN + Rel 99 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 99 UTRAN + Rel 4 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 4 UTRAN + Rel 99 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 4 UTRAN + Rel 4 CN Lossless or other Lossless or other Lossless or other Lossless, seamless or other If the handover is inter-system from UMTS Rel 4 to GPRS, then the same principle of Core Network bi-casting can be applied. This means real-time support could be provided for that type of handover, assuming that the SGSN in the GPRS network can use the latest version of GTP-C. There is no requirement for the GPRS SGSN to support an Iu interface for real-time support. If the handover is inter-system from GPRS to UMTS Rel 4, then no relocation is triggered.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.6 Summary: solution 2
In the Core Network bi-casting solution, handling of the real time data is done at the GGSN. Real time support requires that the GGSN is able to bi-cast the DL traffic to the target RNC. In the case of relocation involving only one SGSN, the SGSN may perform the bi-casting without involving the GGSN. In any relocation case (all scenarios described in 5.9), for DL data of seamless RABs there is one possible situation when frame gap or overlapping may happen. The frame overlap/gap may be introduced when target RNC takes the Serving RNC role and starts to produce the DL data from the bi-casted GTP-PDUs. In this case the estimated gap/overlap is equal to: - For SRNS relocation: the delay difference between the transport bearer used for Iur DCH data stream and the transport bearer used for the new GTP tunnels - For hard handover: the delay difference between the transport bearer used for the original GTP tunnels and the transport bearer used for the new GTP tunnels. This frame overlap/gap coincides with radio hard handover. The gap will exist only if the delay via the new route is larger than the delay via the original route. To support handovers for real time services from the PS domain with the Core Network bi-casting solution, procedural changes are required at the SGSN, GGSN, and RNC.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.7 Open issues
7d3783c93dcb97023753560f1c6e0f1f
25.936
7 Open items for all solutions
Real time PDCP numbers are a RAN2 issue that has not been resolved yet. The questions to be solved with R2 include whether the RAB contexts (i.e. the sequence numbers) need to be between RNCs or not, and whether the header compression/stripping solution to be selected allows that transmission to UE continues via the Iur (i.e. effectively making the context in RELOCATION COMMIT message outdated). According to the UMTS release 99 specifications, PDCP sequence numbers are exchanged with the UE as follows: - UL: The target RNC can determine the UL sequence number which according to the header decompression information should be the next PDCP to be received from the UE. To do this, the RNC uses the PDU causing the RLC to re-establish.. This UL sequence number given by the RNC might be a few sequence numbers lower than the assumption of UE, since it has still maybe sent a few PDUs via source RNC after commit. UE should roll back the PDCP header compression and thus base the next compressed header of the next real-time PDU to the header information of the UL PDU considered as the last received by the target RNC (the indicated one - 1). - DL: Similarly UE indicates in the PDU acknowledging the RLC re-establishment the DL Sequence number which PDU according to the DL header decompression information in the UE should next be received by UE. This is not generally the first forwarded but one of the first ones. Target RNC selects appropriate forwarded PDU and bases its header compression to the header of the 'indicated DL PDCP PDU-1'.
7d3783c93dcb97023753560f1c6e0f1f
25.936
8 Comparison of the solutions
Both solutions meet the requirements defined in this TR. In addition, the following differences are pointed out: Solution 1 (SRNC duplication) Solution 2 (Core Network Bi-casting) For a rel4 UTRAN, user data path between RNCs is same as in lossless relocation for R99 User data path for real-time is different from user data path for lossless data in R99 Utilises a N-PDU duplication mechanism in the RNC/BSS Utilises a duplication mechanism in the GGSN and optionally in the SGSN, during an intermediate state of the relocation For DL, two instances of frame gap/overlapping may occur For DL, one instance of frame gap/overlapping may occur Execution of relocation is performed after relocation resource allocation Execution of relocation is performed after relocation resource allocation and PDP context update procedures that are initiated in parallel
7d3783c93dcb97023753560f1c6e0f1f
25.936
9 Agreements
Solution 1 has been agreed for handling relocation for real time services from PS domain Rel 4. Annex A (informative): Change History Change history Date TSGΒ # TSG Doc. CR Rev Subject/Comment Old New 03/2001 11 RP-010132 - - Approved at TSG RAN #11 and placed under Change Control 2.0.0 4.0.0 12/2001 14 - - - Formatting corrections 4.0.0 4.0.1
dc7f93eeb005e644aa8f154545a30461
29.198-04
1 Scope
The present document is Part 4 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 concepts and the functional architecture for the OSA are contained in 3GPP TS 23.127 [3]. The requirements for OSA are contained in 3GPP TS 22.127 [2]. The present document specifies the Call Control Service Capability Feature (SCF) aspects of the interface. All aspects of the 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 The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML). This specification has been defined jointly between 3GPP TSG CN WG5, ETSI TISPAN and The Parlay Group, in co-operation with a number of JAINβ„’ Community member companies.
dc7f93eeb005e644aa8f154545a30461
29.198-04
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. β€’ References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. β€’ For a specific reference, subsequent revisions do not apply. β€’ For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. [1] 3GPP TS 29.198-1 "Open Service Access; Application Programming Interface; Part 1: Overview". [2] 3GPP TS 22.127: "Service Requirement for the Open Services Access (OSA); Stage 1". [3] 3GPP TS 23.127: "Virtual Home Environment (VHE) / Open Service Access (OSA)". [4] 3GPP TS 22.002: "Circuit Bearer Services Supported by a PLMN". [5] ISO 4217 (1995): "Codes for the representation of currencies and funds". [6] 3GPP TS 24.002: "GSM-UMTS Public Land Mobile Network (PLMN) Access Reference Configuration". [7] 3GPP TS 22.003: "Circuit Teleservices supported by a Public Land Mobile Network (PLMN)".
dc7f93eeb005e644aa8f154545a30461
29.198-04
3 Definitions and abbreviations
dc7f93eeb005e644aa8f154545a30461
29.198-04
3.1 Definitions
For the purposes of the present document, the terms and definitions given in TS 29.198-1 [1] apply.
dc7f93eeb005e644aa8f154545a30461
29.198-04
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in TS 29.198-1 [1] apply. 4 Call Control SCF Two flavours of Call Control (CC) APIs have been included in 3GPP Release 4. These are the Generic Call Control (GCC) and the Multi-Party Call Control (MPCC). The GCC is the same API as was already present in the Release 99 specification (TSΒ 29.198 v3.3.0) and is in principle able to satisfy the requirements on CC APIs for Release 4. However, the joint work between 3GPP CN5, ETSI SPAN12 and the Parlay CC Working group with collaboration from JAIN has been focussed on the MPCC API. A number of improvements on CC functionality have been made and are reflected in this API. For this it was necessary to break the inheritance that previously existed between GCC and MPCC. The joint CC group has furthermore decided that the MPCC is to be considered as the future base CC family and the technical work will not be continued on GCC. Errors or technical flaws will of course be corrected. The following clauses describe each aspect of the CC Service Capability Feature (SCF). The order is as follows: β€’ 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 of this specification (29.198-2).
dc7f93eeb005e644aa8f154545a30461
29.198-04
4.1 Call Model Description
The adopted call model 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.
dc7f93eeb005e644aa8f154545a30461
29.198-04
4.2 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, 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 applications are denoted by classes with name Ip<name>. The callback interfaces to the applications are denoted by classes with name IpApp<name>. For the interfaces between a Service and the Framework, the Service interfaces are typically denoted by classes with name IpSvc<name>, while the Framework interfaces are denoted by classes with name IpFw<name> 5.1.2 Method descriptions Each method (API method β€œcall”) is described. Both synchronous and asynchronous methods are used in the API. Asynchronous methods are identified by a 'Req' suffix for a method request, and, if applicable, are served by asynchronous methods identified by either a 'Res' or 'Err' suffix for method results and errors, respectively. To handle responses and reports, the application or service developer must implement the relevant IpApp<name> or IpSvc<name> interfaces to provide the callback mechanism. 5.1.3 Parameter descriptions Each method parameter and its possible values are described. Parameters described as 'in' represent those that must have a value when the method is called. Those described as 'out' are those that contain the return result of the method when the method returns. 5.1.4 State Model If relevant, a state model is shown to illustrate the states of the objects that implement the described interface. 5.2 Base Interface 5.2.1 Interface Class IpInterface All application, framework and service interfaces inherit from the following interface. This API Base Interface does not provide any additional methods. <<Interface>> IpInterface 5.3 Service Interfaces 5.3.1 Overview The Service Interfaces provide the interfaces into the capabilities of the underlying network - such as call control, user interaction, messaging, mobility and connectivity management. The interfaces that are implemented by the services are denoted as 'Service Interface'. The corresponding interfaces that must be implemented by the application (e.g. for API callbacks) are denoted as 'Application Interface'. 5.4 Generic Service Interface 5.4.1 Interface Class IpService Inherits from: IpInterface All service interfaces inherit from the following interface. <<Interface>> IpService setCallback (appInterface : in IpInterfaceRef) : void setCallbackWithSessionID (appInterface : in IpInterfaceRef, sessionID : in TpSessionID) : void Method setCallback() This method specifies the reference address of the callback interface that a service uses to invoke methods on the application. It is not allowed to invoke this method on an interface that uses SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method setCallbackWithSessionID() This method specifies the reference address of the application's callback interface that a service uses for interactions associated with a specific session ID: e.g. a specific call, or call leg. It is not allowed to invoke this method on an interface that does not use SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. sessionID : in TpSessionID Specifies the session for which the service can invoke the application's callback interface. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE 6 Generic Call Control Service The Generic Call Control API of 3GPP Rel.4 relies on the CAMEL Service Environment (CSE) and thus some restrictions exist to the use of the interface. The most significant one is that there is no support for createCall method. The detailed description of the supported methods and further restrictions is given in the chapter 6.5. 6.1 Sequence Diagrams 6.1.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. 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 enableCallNotification is associated with an applicationID. The call control manager uses the applicationID to decide whether this is the same application. 3: The second instance of the application is started on node 2. The application creates a new IpAppCallControlManager to handle callbacks for this second instance of the logic. 4: The same enableCallNotification request is sent as for the first instance of the logic. Because both requests are associated with the same application, the second request is not rejected, but the specified callback object is stored as an additional callback. 5: When the trigger occurs one of the first instance of the application is notified. The gateway may have different policies on how to handle additional callbacks, e.g., always first try the first registered or use some kind of round robin scheme. 6: The event is forwarded to the first instance of the logic. 7: When the first instance of the application is overloaded or unavailable this is communicated with an exception to the call control manager. 8: Based on this exception the call control manager will notify another instance of the application (if available). 9: The event is forwarded to the second instance of the logic. 6.1.2 Alarm Call The following sequence diagram shows a "reminder message", in the form of an alarm, being delivered to a customer as a result of a trigger from an application. Typically, the application would be set to trigger at a certain time, however, the application could also trigger on events. 1: This message is used to create an object implementing the IpAppCall interface. 2: This message requests the object implementing the IpCallControlManager interface to create an object implementing the IpCall interface. 3: Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met it is created. 4: This message instructs the object implementing the IpCall interface to route the call to the customer destined to receive the "reminder message". 5: This message passes the result of the call being answered to its callback object. 6: This message is used to forward the previous message to the IpAppLogic. 7: The application requests a new UICall object that is associated with the call object. 8: Assuming all criteria are met, a new UICall object is created by the service. 9: This message instructs the object implementing the IpUICall interface to send the alarm to the customer's call. 10: When the announcement ends this is reported to the call back interface. 11: The event is forwarded to the application logic. 12: The application releases the UICall object, since no further announcements are required. Alternatively, the application could have indicated P_FINAL_REQUEST in the sendInfoReq in which case the UICall object would have been implicitly released after the announcement was played. 13: The application releases the call and all associated parties. 6.1.3 Application Initiated Call The following sequence diagram shows an application creating a call between party A and party B. This sequence could be done after a customer has accessed a Web page and selected a name on the page of a person or organisation to talk to. 1: This message is used to create an object implementing the IpAppCall interface. 2: This message requests the object implementing the IpCallControlManager interface to create an object implementing the IpCall interface. 3: Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, it is created. 4: This message is used to route the call to the A subscriber (origination). In the message the application request response when the A party answers. 5: This message indicates that the A party answered the call. 6: This message forwards the previous message to the application logic. 7: This message is used to route the call to the B-party. Also in this case a response is requested for call answer or failure. 8: This message indicates that the B-party answered the call. The call now has two parties and a speech connection is automatically established between them. 9: This message is used to forward the previous message to the IpAppLogic. 10: Since the application is no longer interested in controlling the call, the application deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.4 Call Barring 1 The following sequence diagram shows a call barring service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the destination number, the calling party is asked for a PIN code. The code is accepted and the call is routed to the original called party. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria set, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message is used to create a new UICall object. The reference to the call object is given when creating the UICall. 7: Provided all the criteria are fulfilled, a new UICall object is created. 8: The call barring service dialogue is invoked. 9: The result of the dialogue, which in this case is the PIN code, is returned to its callback object. 10: This message is used to forward the previous message to the IpAppLogic. 11: This message releases the UICall object. 12: Assuming the correct PIN is entered, the call is forward routed to the destination party. 13: This message passes the result of the call being answered to its callback object. 14: This message is used to forward the previous message to the IpAppLogic 15: When the call is terminated in the network, the application will receive a notification. This notification will always be received when the call is terminated by the network in a normal way, the application does not have to request this event explicitly. 16: The event is forwarded to the application. 17: The application must free the call related resources in the gateway by calling deassignCall. 6.1.5 Number Translation 1 The following sequence diagram shows a simple number translation service, initiated as a result of a prearranged event being received by the call control service. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of message 3. 6: This message invokes the number translation function. 7: The returned translated number is used in message 7 to route the call towards the destination. 8: This message passes the result of the call being answered to its callback object 9: This message is used to forward the previous message to the IpAppLogic. 10: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.6 Number Translation 1 (with callbacks) The following sequence diagram shows a simple number translation service, initiated as a result of a prearranged event being received by the call control service. For illustration, in this sequence the callback references are set explicitly. This is optional. All the callbacks references can also be passed in other methods. From an efficiency point of view that is also the preferred method. The rest of the sequences use that mechanism. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message sets the reference of the IpAppCallControlManager object in the CallControlManager. The CallControlManager reports the callEventNotify to referenced object only for enableCallNotifications that do not have a explicit IpAppCallControlManager reference specified in the enableCallNotification. 3: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 3, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 4: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 5: This message is used to forward message 4 to the IpAppLogic. 6: This message is used by the application to create an object implementing the IpAppCall interface. 7: This message is used to set the reference to the IpAppCall for this call. 8: This message invokes the number translation function. 9: The returned translated number is used in message 7 to route the call towards the destination. 10: This message passes the result of the call being answered to its callback object 11: This message is used to forward the previous message to the IpAppLogic. 12: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.7 Number Translation 2 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. If the translated number being routed to does not answer or is busy then the call is automatically released. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The returned translated number is used to route the call towards the destination. 8: Assuming the called party is busy or does not answer, the object implementing the IpCall interface sends a callback in this message, indicating the unavailability of the called party. 9: This message is used to forward the previous message to the IpAppLogic. 10: The application takes the decision to release the call. 6.1.8 Number Translation 3 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. If the translated number being routed to does not answer or is busy then the call is automatically routed to a voice mailbox. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The returned translated number is used to route the call towards the destination. 8: Assuming the called party is busy or does not answer, the object implementing the IpCall interface sends a callback, indicating the unavailability of the called party. 9: This message is used to forward the previous message to the IpAppLogic. 10: The application takes the decision to translate the number, but this time the number is translated to a number belonging to a voice mailbox system. 11: This message routes the call towards the voice mailbox. 12: This message passes the result of the call being answered to its callback object. 13: This message is used to forward the previous message to the IpAppLogic. 14: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.9 Number Translation 4 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the translated number, the application requests for all call related information to be delivered back to the application on completion of the call. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The application instructs the object implementing the IpCall interface to return all call related information once the call has been released. 8: The returned translated number is used to route the call towards the destination. 9: This message passes the result of the call being answered to its callback object. 10: This message is used to forward the previous message to the IpAppLogic. 11: Towards the end of the call, when one of the parties disconnects, a message (not shown) is directed to the object implementing the IpCall. This causes an event, to be passed to the object implementing the IpAppCall object. 12: This message is used to forward the previous message to the IpAppLogic. 13: The application now waits for the call information to be sent. Now that the call has completed, the object implementing the IpCall interface passes the call information to its callback object. 14: This message is used to forward the previous message to the IpAppLogic 15: After the last information is received, the application deassigns the call. This will free the resources related to this call in the gateway. 6.1.10 Number Translation 5 The following sequence diagram shows a simple number translation service which contains a status check function, initiated as a result of a prearranged event being received. In the following sequence, when the application receives an incoming call, it checks the status of the user, and returns a busy code to the calling party. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of message 3. 6: This message invokes the status checking function. 7: The application decides to release the call, and sends a release cause to the calling party indicating that the user is busy. 6.1.11 Prepaid This sequence shows a Pre-paid application. The subscriber is using a pre-paid card or credit card to pay for the call. The application each time allows a certain timeslice for the call. After the timeslice, a new timeslice can be started or the application can terminate the call. In the following sequence the end-user will receive an announcement before his final timeslice. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a pre-paid service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: The incoming call triggers the Pre-Paid Application (PPA). 4: The message is forwarded to the application. 5: A new object on the application side for the Generic Call object is created 6: The Pre-Paid Application (PPA) requests to supervise the call. The application will be informed after the period indicated in the message. This period is related to the credits left on the account of the pre-paid subscriber. 7: Before continuation of the call, PPA sends all charging information, a possible tariff switch time and the call duration supervision period, towards the GW which forwards it to the network. 8: At the end of each supervision period the application is informed and a new period is started. 9: The message is forwarded to the application. 10: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. 11: At the end of each supervision period the application is informed and a new period is started. 12: The message is forwarded to the application. 13: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. When the timer expires it will indicate that the user is almost out of credit. 14: When the user is almost out of credit the application is informed. 15: The message is forwarded to the application. 16: The application decides to play an announcement to the parties in this call. A new UICall object is created and associated with the call. 17: An announcement is played informing the user about the near-expiration of his credit limit. 18: When the announcement is completed the application is informed. 19: The message is forwarded to the application. 20: The application releases the UICall object. 21: The user does not terminate so the application terminates the call after the next supervision period. 22: The supervision period ends 23: The event is forwarded to the logic. 24: The application terminates the call. Since the user interaction is already explicitly terminated no userInteractionFaultDetected is sent to the application. 6.1.12 Pre-Paid with Advice of Charge (AoC) This sequence shows a Pre-paid application that uses the Advice of Charge feature. The application will send the charging information before the actual call setup and when during the call the charging changes new information is sent in order to update the end-user. Note: the Advice of Charge feature requires an application in the end-user terminal to display the charges for the call, depending on the information received from the application. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a pre-paid service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: The incoming call triggers the Pre-Paid Application (PPA). 4: The message is forwarded to the application. 5: A new object on the application side for the Call object is created 6: The Pre-Paid Application (PPA) sends the AoC information (e.g. the tariff switch time). (it shall be noted the PPA contains ALL the tariff information and knows how to charge the user). During this call sequence 2 tariff changes take place. The call starts with tariff 1, and at the tariff switch time (e.g., 18:00 hours) switches to tariff 2. The application is not informed about this (but the end-user is!) 7: The Pre-Paid Application (PPA) requests to supervise the call. The application will be informed after the period indicated in the message. This period is related to the credits left on the account of the pre-paid subscriber. 8: The application requests to route the call to the destination address. 9: At the end of each supervision period the application is informed and a new period is started. 10: The message is forwarded to the application. 11: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. 12: At the end of each supervision period the application is informed and a new period is started. 13: The message is forwarded to the application. 14: Before the next tariff switch (e.g., 19:00 hours) the application sends a new AOC with the tariff switch time. Again, at the tariff switch time, the network will send AoC information to the end-user. 15: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. When the timer expires it will indicate that the user is almost out of credit. 16: When the user is almost out of credit the application is informed. 17: The message is forwarded to the application. 18: The application creates a new call back interface for the User interaction messages. 19: A new UI Call object that will handle playing of the announcement needs to be created 20: The Gateway creates a new UI call object that will handle playing of the announcement. 21: With this message the announcement is played to the parties in the call. 22: The user indicates that the call should continue. 23: The message is forwarded to the application. 24: The user does not terminate so the application terminates the call after the next supervision period. 25: The user is out of credit and the application is informed. 26: The message is forwarded to the application. 27: With this message the application requests to release the call. 28: Terminating the call which has still a UICall object associated will result in a userInteractionFaultDetected. The UICall object is terminated in the gateway and no further communication is possible between the UICall and the application. 6.2 Class Diagrams This class diagram shows the interfaces of the generic call control service package. Figure: Service Interfaces The generic call control service consists of two packages, one for the interfaces on the application side and one for interfaces on the service side. The class diagrams in the following figures show the interfaces that make up the generic call control application package and the generic call control service package. Communication between these packages is indicated with the <<uses>> associations; e.g., the IpCallControlManager interface uses the IpAppCallControlManager , by means of calling callback methods. This class diagram shows the interfaces of the generic call control application package and their relations to the interfaces of the generic call control service package. Figure: Application Interfaces 6.3 Generic Call Control Service Interface Classes The Generic Call Control Service (GCCS) provides the basic call control service for the API. It is based around a third party model, which allows calls to be instantiated from the network and routed through the network. The GCCS supports enough functionality to allow call routing and call management for today's Intelligent Network (IN) services in the case of a switched telephony network, or equivalent for packet based networks. It is the intention of the GCCS that it could be readily specialised into call control specifications, for example, ITU-T recommendations H.323, ISUP, Q.931 and Q.2931, ATM Forum specification UNI3.1 and the IETF Session Initiation Protocol, or any other call control technology. For the generic call control service, only a subset of the call model defined in clause 4 is used; the API for generic call control does not give explicit access to the legs and the media channels. This is provided by the Multi-Party Call Control Service. Furthermore, the generic call is restricted to two party calls, i.e., only two legs are active at any given time. Active is defined here as 'being routed' or connected. The GCCS is represented by the IpCallControlManager and IpCall interfaces that interface to services provided by the network. Some methods are asynchronous, in that they do not lock a thread into waiting whilst a transaction performs. In this way, the client machine can handle many more calls, than one that uses synchronous message calls. To handle responses and reports, the developer must implement IpAppCallControlManager and IpAppCall to provide the callback mechanism. 6.3.1 Interface Class IpCallControlManager Inherits from: IpService This interface is the 'service manager' interface for the Generic Call Control Service. The generic call control manager interface provides the management functions to the generic call control service. The application programmer can use this interface to provide overload control functionality, create call objects and to enable or disable call-related event notifications. This interface shall be implemented by a Generic Call Control SCF. As a minimum requirement either the createCall() method shall be implemented, or the enableCallNotification() and disableCallNotification() methods shall be implemented. <<Interface>> IpCallControlManager createCall (appCall : in IpAppCallRef) : TpCallIdentifier enableCallNotification (appCallControlManager : in IpAppCallControlManagerRef, eventCriteria : in TpCallEventCriteria) : TpAssignmentID disableCallNotification (assignmentID : in TpAssignmentID) : void setCallLoadControl (duration : in TpDuration, mechanism : in TpCallLoadControlMechanism, treatment : in TpCallTreatment, addressRange : in TpAddressRange) : TpAssignmentID changeCallNotification (assignmentID : in TpAssignmentID, eventCriteria : in TpCallEventCriteria) : void getCriteria () : TpCallEventCriteriaResultSet Method createCall() This method is used to create a new call object. Call back reference: An IpAppCallControlManager should already have been passed to the IpCallControlManager, otherwise the call control will not be able to report a callAborted() to the application. The application shall invoke setCallback() prior to createCall if it wishes to ensure this. Returns callReference: Specifies the interface reference and sessionID of the call created. Parameters appCall : in IpAppCallRef Specifies the application interface for callbacks from the call created. Returns TpCallIdentifier Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method enableCallNotification() This method is used to enable call notifications so that events can be sent to the application. This is the first step an application has to do to get initial notification of calls happening in the network. When such an event happens, the application will be informed by callEventNotify(). In case the application is interested in other events during the context of a particular call session it has to use the routeReq() method on the call object. The application will get access to the call object when it receives the callEventNotify(). (Note that the enableCallNotification() is not applicable if the call is setup by the application). The enableCallNotification method is purely intended for applications to indicate their interest to be notified when certain call events take place. It is possible to subscribe to a certain event for a whole range of addresses, e.g. the application can indicate it wishes to be informed when a call is made to any number starting with 800. If some application already requested notifications with criteria that overlap the specified criteria, the request is refused with P_GCCS_INVALID_CRITERIA. The criteria are said to overlap if both originating and terminating ranges overlap and the same number plan is used and the same CallNotificationType is used. If a notification is requested by an application with the monitor mode set to notify, then there is no need to check the rest of the criteria for overlapping with any existing request as the notify mode does not allow control on a call to be passed over. Only one application can place an interrupt request if the criteria overlaps. Set of the callback reference: The call back reference can be registered either in a) enableCallNotification() or b) explicitly with a separate setCallback() method depending on how the application provides its callback reference. Case a: From an efficiency point of view the enableCallNotification() with explicit immediate registration (no "Null" value) of call back reference may be the preferred method. Case b: The enableCallNotfication() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallback(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised. In case the enableCallNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered by setCallback(). See example in clause 6.1.6. Set additional callback reference: If the same application requests two notifications with exactly the same criteria but different callback references, the second callback will be treated as an additional callback. Both notifications will share the same assignmentID. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used. See examples in clause 6.1.1. Returns assignmentID: Specifies the ID assigned by the generic call control manager interface for this newly-enabled event notification. Parameters appCallControlManager : in IpAppCallControlManagerRef If this parameter is set (i.e. not NULL) it specifies a reference to the application interface, which is used for callbacks. If set to NULL, the application interface defaults to the interface specified previously via the setCallback() method. eventCriteria : in TpCallEventCriteria Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Examples of events are "incoming call attempt reported by network", "answer", "no answer", "busy". Individual addresses or address ranges may be specified for destination and/or origination. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_CRITERIA, P_INVALID_INTERFACE_TYPE, P_INVALID_EVENT_TYPE Method disableCallNotification() This method is used by the application to disable call notifications. Parameters assignmentID : in TpAssignmentID Specifies the assignment ID given by the generic call control manager interface when the previous enableCallNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the exception P_INVALID_ASSIGNMENTID will be raised. If two callbacks have been registered under this assignment ID both of them will be disabled. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID Method setCallLoadControl() This method imposes or removes load control on calls made to a particular address range within the generic call control service. The address matching mechanism is similar as defined for TpCallEventCriteria. Returns assignmentID: Specifies the assignmentID assigned by the gateway to this request. This assignmentID can be used to correlate the callOverloadEncountered and callOverloadCeased methods with the request. Parameters duration : in TpDuration Specifies the duration for which the load control should be set. A duration of 0 indicates that the load control should be removed. A duration of -1 indicates an infinite duration (i.e., until disabled by the application) A duration of -2 indicates the network default duration. mechanism : in TpCallLoadControlMechanism Specifies the load control mechanism to use (for example, admit one call per interval), and any necessary parameters, such as the call admission rate. The contents of this parameter are ignored if the load control duration is set to zero. treatment : in TpCallTreatment Specifies the treatment of calls that are not admitted. The contents of this parameter are ignored if the load control duration is set to zero. addressRange : in TpAddressRange Specifies the address or address range to which the overload control should be applied or removed. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN Method changeCallNotification() This method is used by the application to change the event criteria introduced with enableCallNotification. Any stored criteria associated with the specified assignmentID will be replaced with the specified criteria. Parameters assignmentID : in TpAssignmentID Specifies the ID assigned by the generic call control manager interface for the event notification. If two call backs have been registered under this assignment ID both of them will be changed. eventCriteria : in TpCallEventCriteria Specifies the new set of event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method getCriteria() This method is used by the application to query the event criteria set with enableCallNotification or changeCallNotification. Returns eventCriteria: Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Parameters No Parameters were identified for this method Returns TpCallEventCriteriaResultSet Raises TpCommonExceptions 6.3.2 Interface Class IpAppCallControlManager Inherits from: IpInterface The generic call control manager application interface provides the application call control management functions to the generic call control service. <<Interface>> IpAppCallControlManager callAborted (callReference : in TpSessionID) : void callEventNotify (callReference : in TpCallIdentifier, eventInfo : in TpCallEventInfo, assignmentID : in TpAssignmentID) : IpAppCallRef callNotificationInterrupted () : void callNotificationContinued () : void callOverloadEncountered (assignmentID : in TpAssignmentID) : void callOverloadCeased (assignmentID : in TpAssignmentID) : void Method callAborted() This method indicates to the application that the call object (at the gateway) has aborted or terminated abnormally. No further communication will be possible between the call and application. Parameters callReference : in TpSessionID Specifies the sessionID of call that has aborted or terminated abnormally. Method callEventNotify() This method notifies the application of the arrival of a call-related event. If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of 102 (Recovery on timer expiry). Set of the callback reference: A reference to the application interface has to be passed back to the call interface to which the notification relates. However, the setting of a call back reference is only applicable if the notification is in INTERRUPT mode. When callEventNotify() is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, the application writer should ensure that no continue processing e.g. routeReq() is performed until an IpAppCall has been passed to the gateway, either through an explicit setCallbackWithSessionID() invocation on the supplied IpCall, or via the return of the callEventNotify() method. The call back reference can be registered either in a) callEventNotify() or b) explicitly with a setCallbackWithSessionID() method e.g. depending on how the application provides its call reference. Case a: From an efficiency point of view the callEventNotify() with explicit pass of registration may be the preferred method. Case b: The callEventNotify() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the callback reference is provided previously in a setCallbackWithSessionID(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised, and no further application invocations related to the call shall be permitted. In case the callEventNotify() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered previously by setCallbackWithSessionID(). See example in clause 6.1.6. Returns appCall: Specifies a reference to the application interface which implements the callback interface for the new call. If the application has previously explicitly passed a reference to the IpAppCall interface using a setCallbackWithSessionID() invocation, this parameter may be null, or if supplied must be the same as that provided during the setCallbackWithSessionID(). This parameter will be null if the notification is in NOTIFY mode and in case b. Parameters callReference : in TpCallIdentifier Specifies the reference to the call interface to which the notification relates. If the notification is in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking callEventNotify may populate this parameter as it chooses. eventInfo : in TpCallEventInfo Specifies data associated with this event. assignmentID : in TpAssignmentID Specifies the assignment id which was returned by the enableCallNotification() method. The application can use assignment id to associate events with event specific criteria and to act accordingly. Returns IpAppCallRef Method callNotificationInterrupted() This method indicates to the application that all event notifications have been temporarily interrupted (for example, due to faults detected). Note that more permanent failures are reported via the Framework (integrity management). Parameters No Parameters were identified for this method Method callNotificationContinued() This method indicates to the application that event notifications will again be possible. Parameters No Parameters were identified for this method Method callOverloadEncountered() This method indicates that the network has detected overload and may have automatically imposed load control on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the address range for within which the overload has been encountered. Method callOverloadCeased() This method indicates that the network has detected that the overload has ceased and has automatically removed any load controls on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the address range for within which the overload has been ceased 6.3.3 Interface Class IpCall Inherits from: IpService The generic Call provides the possibility to control the call routing, to request information from the call, control the charging of the call, to release the call and to supervise the call. It does not give the possibility to control the legs directly and it does not allow control over the media. The first capability is provided by the multi-party call and the latter as well by the multi-media call. The call is limited to two party calls, although it is possible to provide 'follow-on' calls, meaning that the call can be rerouted after the terminating party has disconnected or routing to the terminating party has failed. Basically, this means that at most two legs can be in connected or routing state at any time. This interface shall be implemented by a Generic Call Control SCF. As a minimum requirement, the routeReq (), release() and deassignCall() methods shall be implemented. <<Interface>> IpCall routeReq (callSessionID : in TpSessionID, responseRequested : in TpCallReportRequestSet, targetAddress : in TpAddress, originatingAddress : in TpAddress, originalDestinationAddress : in TpAddress, redirectingAddress : in TpAddress, appInfo : in TpCallAppInfoSet) : TpSessionID release (callSessionID : in TpSessionID, cause : in TpCallReleaseCause) : void deassignCall (callSessionID : in TpSessionID) : void getCallInfoReq (callSessionID : in TpSessionID, callInfoRequested : in TpCallInfoType) : void setCallChargePlan (callSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void getMoreDialledDigitsReq (callSessionID : in TpSessionID, length : in TpInt32) : void superviseCallReq (callSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallSuperviseTreatment) : void <<new>> continueProcessing (callSessionID : in TpSessionID) : void Method routeReq() This asynchronous method requests routing of the call to the remote party indicated by the targetAddress. Note that in case of routeReq() it is recommended to request for 'successful' (e.g. 'answer' event) and 'failure' events at invocation, because those are needed for the application to keep track of the state of the call. The extra address information such as originatingAddress is optional. If not present (i.e., the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in corresponding addresses from the route is used, otherwise the network or gateway provided numbers will be used. If this method in invoked, and call reports have been requested, yet no IpAppCall interface has been provided, this method shall throw the P_NO_CALLBACK_ADDRESS_SET exception. This operation continues processing of the call implicitly. Returns callLegSessionID: Specifies the sessionID assigned by the gateway. This is the sessionID of the implicitly created call leg. The same ID will be returned in the routeRes or Err. This allows the application to correlate the request and the result. This parameter is only relevant when multiple routeReq() calls are executed in parallel, e.g., in the multi-party call control service. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. responseRequested : in TpCallReportRequestSet Specifies the set of observed events that will result in zero or more routeRes() being generated. E.g., when both answer and disconnect is monitored the result can be received two times. If the application wants to control the call (in whatever sense) it shall enable event reports targetAddress : in TpAddress Specifies the destination party to which the call leg should be routed. originatingAddress : in TpAddress Specifies the address of the originating (calling) party. originalDestinationAddress : in TpAddress Specifies the original destination address of the call. redirectingAddress : in TpAddress Specifies the address from which the call was last redirected. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call (such as alerting method, tele-service type, service identities and interaction indicators). Returns TpSessionID Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN, P_INVALID_NETWORK_STATE, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method release() This method requests the release of the call object and associated objects. The call will also be terminated in the network. If the application requested reports to be sent at the end of the call (e.g., by means of getCallInfoReq) these reports will still be sent to the application. This operation continues processing of the call implicitly. The application should always either release or deassign the call when it is finished with the call, unless a callFaultDetected is received by the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. cause : in TpCallReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method deassignCall() This method requests that the relationship between the application and the call and associated objects be de-assigned. It leaves the call in progress, however, it purges the specified call object so that the application has no further control of call processing. If a call is de-assigned that has event reports, call information reports or call Leg information reports requested, then these reports will be disabled and any related information discarded. This operation continues processing of the call implicitly. The application should always either release or deassign the call when it is finished with the call, unless callFaultDetected is received by the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getCallInfoReq() This asynchronous method requests information associated with the call to be provided at the appropriate time (for example, to calculate charging). This method must be invoked before the call is routed to a target address. A report is received when the destination leg or party terminates or when the call ends. The call object will exist after the call is ended if information is required to be sent to the application at the end of the call. In case the originating party is still available the application can still initiate a follow-on call using routeReq. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoRequested : in TpCallInfoType Specifies the call information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setCallChargePlan() Set an operator specific charge plan for the call. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getMoreDialledDigitsReq() This asynchronous method requests the call control service to collect further digits and return them to the application. Depending on the administered data, the network may indicate a new call to the gateway if a caller goes off-hook or dialled only a few digits. The application then gets a new call event which contains no digits or only the few dialled digits in the event data. The application should use this method if it requires more dialled digits, e.g. to perform screening. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. length : in TpInt32 Specifies the maximum number of digits to collect. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method superviseCallReq() The application calls this method to supervise a call. The application can set a granted connection time for this call. If an application calls this function before it calls a routeReq() or a user interaction function the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method <<new>> continueProcessing() This operation continues processing of the call explicitly. Applications can invoke this operation after call processing was interrupted due to detection of a notification or event the application subscribed its interest in. In case the operation is invoked and call processing is not interrupted the exception P_INVALID_NETWORK_STATE will be raised. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE 6.3.4 Interface Class IpAppCall Inherits from: IpInterface The generic call application interface is implemented by the client application developer and is used to handle call request responses and state reports. <<Interface>> IpAppCall routeRes (callSessionID : in TpSessionID, eventReport : in TpCallReport, callLegSessionID : in TpSessionID) : void routeErr (callSessionID : in TpSessionID, errorIndication : in TpCallError, callLegSessionID : in TpSessionID) : void getCallInfoRes (callSessionID : in TpSessionID, callInfoReport : in TpCallInfoReport) : void getCallInfoErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseCallRes (callSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseCallErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callFaultDetected (callSessionID : in TpSessionID, fault : in TpCallFault) : void getMoreDialledDigitsRes (callSessionID : in TpSessionID, digits : in TpString) : void getMoreDialledDigitsErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callEnded (callSessionID : in TpSessionID, report : in TpCallEndedReport) : void Method routeRes() This asynchronous method indicates that the request to route the call to the destination was successful, and indicates the response of the destination party (for example, the call was answered, not answered, refused due to busy, etc.). If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of 102 (Recovery on timer expiry). Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. eventReport : in TpCallReport Specifies the result of the request to route the call to the destination party. It also includes the network event, date and time, monitoring mode and event specific information such as release cause. callLegSessionID : in TpSessionID Specifies the sessionID of the associated call leg. This corresponds to the sessionID returned at the routeReq() and can be used to correlate the response with the request. Method routeErr() This asynchronous method indicates that the request to route the call to the destination party was unsuccessful - the call could not be routed to the destination party (for example, the network was unable to route the call, the parameters were incorrect, the request was refused, etc.). Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. callLegSessionID : in TpSessionID Specifies the sessionID of the associated call leg. This corresponds to the sessionID returned at the routeReq() and can be used to correlate the error with the request. Method getCallInfoRes() This asynchronous method reports time information of the finished call or call attempt as well as release cause depending on which information has been requested by getCallInfoReq. This information may be used e.g. for charging purposes. The call information will possibly be sent after routeRes in all cases where the call or a leg of the call has been disconnected or a routing failure has been encountered. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoReport : in TpCallInfoReport Specifies the call information requested. Method getCallInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseCallRes() This asynchronous method reports a call supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection is terminated before the supervision event occurs. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call supervision response. usedTime : in TpDuration Specifies the used time for the call supervision (in milliseconds). Method superviseCallErr() This asynchronous method reports a call supervision error to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callFaultDetected() This method indicates to the application that a fault in the network has been detected. The call may or may not have been terminated. The system deletes the call object. Therefore, the application has no further control of call processing. No report will be forwarded to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call in which the fault has been detected. fault : in TpCallFault Specifies the fault that has been detected. Method getMoreDialledDigitsRes() This asynchronous method returns the collected digits to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. digits : in TpString Specifies the additional dialled digits if the string length is greater than zero. Method getMoreDialledDigitsErr() This asynchronous method reports an error in collecting digits to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callEnded() This method indicates to the application that the call has terminated in the network. However, the application may still receive some results (e.g., getCallInfoRes) related to the call. The application is expected to deassign the call object after having received the callEnded. Note that the event that caused the call to end might also be received separately if the application was monitoring for it. Parameters callSessionID : in TpSessionID Specifies the call sessionID. report : in TpCallEndedReport Specifies the reason the call is terminated. 6.4 Generic Call Control Service State Transition Diagrams 6.4.1 State Transition Diagrams for IpCallControlManager The state transition diagram shows the application view on the Call Control Manager object. Figure : Application view on the Call Control Manager 6.4.1.1 Active State In this state a relation between the Application and the Generic Call Control Service has been established. The state allows the application to indicate that it is interested in call related events. In case such an event occurs, the Call Control Manager will create a Call object and inform the application by invoking the operation callEventNotify() on the IpAppCallControlManager interface. The application can also indicate it is no longer interested in certain call related events by calling disableCallNotification(). 6.4.1.2 Notification terminated State When the Call Control Manager is in the Notification terminated state, events requested with enableCallNotification() will not be forwarded to the application. There can be multiple reasons for this: for instance it might be that the application receives more notifications from the network than defined in the Service Level Agreement. Another example is that the Service has detected it receives no notifications from the network due to e.g. a link failure. In this state no requests for new notifications will be accepted. 6.4.2 State Transition Diagrams for IpCall The state transition diagram shows the application view on the Call object for 3GPP. Figure : Application view on the IpCall object for 3GPP 6.4.2.1 Network Released State In this state the call has ended and the Gateway collects the possible call information requested with getCallInfoReq() and / or superviseCallReq(). The information will be returned to the application by invoking the methods getCallInfoRes() and / or superviseCallRes() on the application. Also when a call was unsuccessful these methods are used. In case the application has not requested additional call related information immediately a transition is made to state Finished. 6.4.2.2 Finished State In this state the call has ended and no call related information is to be send to the application. The application can only release the call object. Calling the deassignCall() operation has the same effect. Note that the application has to release the object itself as good OO practice requires that when an object was created on behalf of a certain entity, this entity is also responsible for destroying it when the object is no longer needed. 6.4.2.3 Application Released State In this state the application has requested to release the Call object and the Gateway collects the possible call information requested with getCallInfoReq() and / or superviseCallReq(). In case the application has not requested additional call related information the Call object is destroyed immediately. 6.4.2.4 Active State In this state a call between two parties is being setup or present. Refer to the substates for more details. The application can request supervision of the call by calling superviseCallReq(). It is also allowed to send Advice of Charge information by calling setAdviceOfCharge() as well as to define the charging by invoking setCallChargePlan. Call processing is suspended when a network event is met for the call, which was requested to be monitored in the P_CALL_MONITOR_MODE_INTERRUPT. In order to resume of the suspended call processing, the application invokes continueProcessing(), routeReq(), release() or deassignCall() method. 6.4.2.5 1 Party in Call State When the Call is in this state a calling party is present. The application can now request that a connection to a called party be established by calling the method routeReq(). In this state the application can also request the gateway for a certain type of charging of the call by calling setCallChargePlan(). The application can also request for charging related information by calling getCallInfoReq(). The setCallChargePlan() and getCallInfoReq() should be issued before requesting a connection to a called party by means of routeReq(). When the calling party abandons the call before the application has invoked the routeReq() operation, the gateway informs the application by invoking callFaultDetected() and also the operation callEnded() will be invoked. When the calling party abandons the call after the application has invoked routeReq() but before the call has actually been established, the gateway informs the application by invoking callEnded(). When the called party answers the call, a transition will be made to the 2 Parties in Call state. In case the call can not be established because the application supplied an invalid address or the connection to the called party was unsuccessful while the application was monitoring for the latter in interrupt mode, the Call object will stay in this state In this state user interaction is possible unless there is an outstanding routing request. 6.4.2.6 2 Parties in Call State A connection between two parties has been established. In case the calling party disconnects, the gateway informs the application by invoking callEnded(). When the called party disconnects different situations apply: 1. the application is monitoring for this event in interrupt mode: a transition is made to the 1 Party in Call state, the application is informed with routeRes with indication that the called party has disconnected and all requested reports are sent to the application. The application now again has control of the call. 2. the application is monitoring for this event but not in interrupt mode. In this case a transition is made to the Network Released state and the gateway informs the application by invoking the operation routeRes() and callEnded(). 3. the application is not monitoring for this event. In this case the application is informed by the gateway invoking the callEnded() operation and a transition is made to the Network Released state. In this state user interaction is possible, depending on the underlying network. 6.5 Generic Call Control Service Properties 6.5.1 List of Service Properties The following table lists properties relevant for the GCC API. Property Type Description / Interpretation P_TRIGGERING_EVENT_TYPES INTEGER_SET Indicates the static event types supported by the SCS. Static events are the events by which applications are initiated. P_DYNAMIC_EVENT_TYPES INTEGER_SET Indicates the dynamic event types supported by the SCS. Dynamic events are the events the application can request for during the context of a call. P_ADDRESSPLAN INTEGER_SET Indicates the supported address plans (defined in TpAddressPlan.) e.g. {P_ADDRESS_PLAN_E164, P_ADDRESS_PLAN_IP}). Note that more than one address plan may be supported. P_UI_CALL_BASED BOOLEAN_SET Value = TRUE : User interaction can be performed on call level and a reference to a Call object can be used in the IpUIManager.createUICall() operation. Value = FALSE: No User interaction on call level is supported. P_UI_AT_ALL_STAGES BOOLEAN_SET Value = TRUE: User Interaction can be performed at any stage during a call . Value = FALSE: User Interaction can be performed in case there is only one party in the call. P_MEDIA_TYPE INTEGER_SET Specifies the media type used by the Service. Values are defined by data-type TpMediaType : P_AUDIO, P_VIDEO, P_DATA The previous table lists properties related to capabilities of the SCS itself. The following table lists properties that are used in the context of the Service Level Agreement, e.g. to restrict the access of applications to the capabilities of the SCS. Property Type Description P_TRIGGERING_ADDRESSES (Deprecated) ADDRESSRANGE_SET Indicates for which numbers the notification may be set. For terminating notifications it applies to the terminating number, for originating notifications it applies only to the originating number. P_NOTIFICATION_ADDRESS_RANGES XML_ADDRESS_RANGE_SET Indicates for which numbers notifications may be set. More than one range may be present. For terminating notifications they apply to the terminating number, for originating notifications they apply only to the originating number. P_NOTIFICATION_TYPES INTEGER_SET Indicates whether the application is allowed to set originating and/or terminating triggers in the ECN. Set is: P_ORIGINATING P_TERMINATING P_MONITOR_MODE INTEGER_SET Indicates whether the application is allowed to monitor in interrupt and/or notify mode. Set is: P_INTERRUPT P_NOTIFY P_NUMBERS_TO_BE_CHANGED INTEGER_SET Indicates which numbers the application is allowed to change or fill for legs in an incoming call. Allowed value set: {P_ORIGINAL_CALLED_PARTY_NUMBER, P_REDIRECTING_NUMBER, P_TARGET_NUMBER, P_CALLING_PARTY_NUMBER}. P_CHARGEPLAN_ALLOWED INTEGER_SET Indicates which charging is allowed in the setCallChargePlan indicator. Allowed values: {P_TRANSPARANT_CHARGING, P_CHARGE_PLAN} P_CHARGEPLAN_MAPPING INTEGER_INTEGER_MAP Indicates the mapping of chargeplans (we assume they can be indicated with integers) to a logical network chargeplan indicator. When the chargeplan supports indicates P_CHARGE_PLAN then only chargeplans in this mapping are allowed. 6.5.2 Service Property values for the CAMEL Service Environment. Implementations of the Generic Call Control API relying on the CSE of CAMEL phase 3 shall have the Service Properties outlined above set to the indicated values : P_OPERATION_SET = { β€œIpCallControlManager.enableCallNotification”, β€œIpCallControlManager.disableCallNotification”, β€œIpCallControlManager.changeCallNotification”, β€œIpCallControlManager.getCriteria”, β€œIpCallControlManager.setCallLoadControl”, β€œIpCall.routeReq”, β€œIpCall.release”, β€œIpCall.deassignCall”, β€œIpCall.getCallInfoReq”, β€œIpCall.setCallChargePlan”, β€œIpCall.setAdviceOfCharge”, β€œIpCall.superviseCallReq” } P_TRIGGERING_EVENT_TYPES = { P_EVENT_GCCS_ADDRESS_COLLECTED_EVENT, P_EVENT_GCCS_ADDRESS_ANALYSED_EVENT, P_EVENT_GCCS_CALLED_PARTY_BUSY, P_EVENT_GCCS_CALLED_PARTY_UNREACHABLE, P_EVENT_GCCS_NO_ANSWER_FROM_CALLED_PARTY, P_EVENT_GCCS_ROUTE_SELECT_FAILURE } P_DYNAMIC_EVENT_TYPES = { P_CALL_REPORT_ANSWER, P_CALL_REPORT_BUSY, P_CALL_REPORT_NO_ANSWER, P_CALL_REPORT_DISCONNECT, P_CALL_REPORT_ROUTING_FAILURE, P_CALL_REPORT_NOT_REACHABLE } P_ADDRESS_PLAN = { P_ADDRESS_PLAN_E164 } P_UI_CALL_BASED = { TRUE } P_UI_AT_ALL_STAGES = { FALSE } P_MEDIA_TYPE = { P_AUDIO } 6.6 Generic Call Control Data Definitions This clause provides the GCC data definitions necessary to support the API specification. The general format of a Data Definition specification is described below. β€’ Data Type This shows the name of the data type. β€’ Description This describes the data type. β€’ Tabular Specification This specifies the data types and values of the data type. β€’ Example If relevant, an example is shown to illustrate the data type. All data types referenced but not defined in this clause are either in the common call control data definitions clause of the present document (clause 8) or in the common data definitions which may be found in 3GPPΒ TSΒ 29.198-2. 6.6.1 Generic Call Control Event Notification Data Definitions 6.6.1.1 TpCallEventName Defines the names of event being notified. The following events are supported. The values may be combined by a logical 'OR' function when requesting the notifications. Additional events that can be requested / received during the call process are found in the TpCallReportType data-type. Name Value Description P_EVENT_NAME_UNDEFINED 0 Undefined P_EVENT_GCCS_OFFHOOK_EVENT 1 GCCS – Offhook event This can be used for hot-line features. In case this event is set in the TpCallEventCriteria, only the originating address(es) may be specified in the criteria. P_EVENT_GCCS_ADDRESS_COLLECTED_EVENT 2 GCCS – Address information collected The network has collected the information from the A-party, but not yet analysed the information. The number can still be incomplete. Applications might set notifications for this event when part of the number analysis needs to be done in the application (see also the getMoreDialledDigitsReq method on the call class). P_EVENT_GCCS_ADDRESS_ANALYSED_EVENT 4 GCCS – Address information is analysed The dialled number is a valid and complete number in the network. P_EVENT_GCCS_CALLED_PARTY_BUSY 8 GCCS – Called party is busy P_EVENT_GCCS_CALLED_PARTY_UNREACHABLE 16 GCCS – Called party is unreachable (e.g. the called party has a mobile telephone that is currently switched off). P_EVENT_GCCS_NO_ANSWER_FROM_CALLED_PARTY 32 GCCS – No answer from called party P_EVENT_GCCS_ROUTE_SELECT_FAILURE 64 GCCS – Failure in routing the call P_EVENT_GCCS_ANSWER_FROM_CALL_PARTY 128 GCCS – Party answered call. 6.6.1.2 TpCallNotificationType Defines the type of notification. Indicates whether it is related to the originating of the terminating user in the call. Name Value Description P_ORIGINATING 0 Indicates that the notification is related to the originating user in the call. P_TERMINATING 1 Indicates that the notification is related to the terminating user in the call. 6.6.1.3 TpCallEventCriteria Defines the Sequence of Data Elements that specify the criteria for a event notification. Of the addresses only the Plan and the AddrString are used for the purpose of matching the notifications against the criteria. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddressRange Defines the destination address or address range for which the notification is requested. OriginatingAddress TpAddressRange Defines the origination address or a address range for which the notification is requested. CallEventName TpCallEventName Name of the event(s) CallNotificationType TpCallNotificationType Indicates whether it is related to the originating or the terminating user in the call. MonitorMode TpCallMonitorMode Defines the mode that the call is in following the notification. Monitor mode P_CALL_MONITOR_MODE_DO_NOT_MONITOR is not a legal value here. 6.6.1.4 TpCallEventInfo Defines the Sequence of Data Elements that specify the information returned to the application in a Call event notification. Sequence Element Name Sequence Element Type DestinationAddress TpAddress OriginatingAddress TpAddress OriginalDestinationAddress TpAddress RedirectingAddress TpAddress CallAppInfo TpCallAppInfoSet CallEventName TpCallEventName CallNotificationType TpCallNotificationType MonitorMode TpCallMonitorMode 6.6.2 Generic Call Control Data Definitions 6.6.2.1 IpCall Defines the address of an IpCall Interface. 6.6.2.2 IpCallRef Defines a Reference to type IpCall. 6.6.2.3 IpAppCall Defines the address of an IpAppCall Interface. 6.6.2.4 IpAppCallRef Defines a Reference to type IpAppCall 6.6.2.5 TpCallIdentifier Defines the Sequence of Data Elements that unambiguously specify the Generic Call object Sequence Element Name Sequence Element Type Sequence Element Description CallReference IpCallRef This element specifies the interface reference for the call object. CallSessionID TpSessionID This element specifies the call session ID of the call. 6.6.2.6 IpAppCallControlManager Defines the address of an IpAppCallControlManager Interface. 6.6.2.7 IpAppCallControlManagerRef Defines a Reference to type IpAppCallControlManager. 6.6.2.8 IpCallControlManager Defines the address of an IpCallControlManager Interface. 6.6.2.9 IpCallControlManagerRef Defines a Reference to type IpCallControlManager. 6.6.2.10 TpCallAppInfo Defines the Tagged Choice of Data Elements that specify application-related call information. Tag Element Type TpCallAppInfoType Tag Element Value Choice Element Type Choice Element Name P_CALL_APP_ALERTING_MECHANISM TpCallAlertingMechanism CallAppAlertingMechanism P_CALL_APP_NETWORK_ACCESS_TYPE TpCallNetworkAccessType CallAppNetworkAccessType P_CALL_APP_TELE_SERVICE TpCallTeleService CallAppTeleService P_CALL_APP_BEARER_SERVICE TpCallBearerService CallAppBearerService P_CALL_APP_PARTY_CATEGORY TpCallPartyCategory CallAppPartyCategory P_CALL_APP_PRESENTATION_ADDRESS TpAddress CallAppPresentationAddress P_CALL_APP_GENERIC_INFO TpString CallAppGenericInfo P_CALL_APP_ADDITIONAL_ADDRESS TpAddress CallAppAdditionalAddress 6.6.2.11 TpCallAppInfoType Defines the type of call application-related specific information. Name Value Description P_CALL_APP_UNDEFINED 0 Undefined P_CALL_APP_ALERTING_MECHANISM 1 The alerting mechanism or pattern to use P_CALL_APP_NETWORK_ACCESS_TYPE 2 The network access type (e.g. ISDN) P_CALL_APP_TELE_SERVICE 3 Indicates the tele-service (e.g. telephony) P_CALL_APP_BEARER_SERVICE 4 Indicates the bearer service (e.g. 64kbit/s unrestricted data). P_CALL_APP_PARTY_CATEGORY 5 The category of the calling party P_CALL_APP_PRESENTATION_ADDRESS 6 The address to be presented to other call parties P_CALL_APP_GENERIC_INFO 7 Carries unspecified service-service information P_CALL_APP_ADDITIONAL_ADDRESS 8 Indicates an additional address 6.6.2.12 TpCallAppInfoSet Defines a Numbered Set of Data Elements of TpCallAppInfo. 6.6.2.13 TpCallEndedReport Defines the Sequence of Data Elements that specify the reason for the call ending. Sequence Element Name Sequence Element Type Description CallLegSessionID TpSessionID The leg that initiated the release of the call. If the call release was not initiated by the leg, then this value is set to –1. Cause TpCallReleaseCause The cause of the call ending. 6.6.2.14 TpCallFault Defines the cause of the call fault detected. Name Value Description P_CALL_FAULT_UNDEFINED 0 Undefined P_CALL_TIMEOUT_ON_RELEASE 1 This fault occurs when the final report has been sent to the application, but the application did not explicitly release or deassign the call object, within a specified time. The timer value is operator specific. P_CALL_TIMEOUT_ON_INTERRUPT 2 This fault occurs when the application did not instruct the gateway how to handle the call within a specified time, after the gateway reported an event that was requested by the application in interrupt mode. The timer value is operator specific. 6.6.2.15 TpCallInfoReport Defines the Sequence of Data Elements that specify the call information requested. Information that was not requested is invalid. Sequence Element Name Sequence Element Type Description CallInfoType TpCallInfoType The type of call report. CallInitiationStartTime TpDateAndTime The time and date when the call, or follow-on call, was started as a result of a routeReq. CallConnectedToResourceTime TpDateAndTime The date and time when the call was connected to the resource. This data element is only valid when information on user interaction is reported. CallConnectedToDestinationTime TpDateAndTime The date and time when the call was connected to the destination (i.e. when the destination answered the call). If the destination did not answer, the time is set to an empty string. This data element is invalid when information on user interaction is reported. CallEndTime TpDateAndTime The date and time when the call or follow-on call or user interaction was terminated. Cause TpCallReleaseCause The cause of the termination. A callInfoReport will be generated at the end of user interaction and at the end of the connection with the associated address. This means that either the destination related information is present or the resource related information, but not both. 6.6.2.16 TpCallReleaseCause Defines the Sequence of Data Elements that specify the cause of the release of a call. Sequence Element Name Sequence Element Type Value TpInt32 Location TpInt32 NOTE: The Value and Location are specified as in ITU-T Recommendation Q.850. The following example was taken from Q.850 to aid understanding: Equivalent Call Report Cause Value Set by Application Cause Value from Network P_CALL_REPORT_BUSY 17 17 P_CALL_REPORT_NO_ANSWER 19 18,19,21 P_CALL_REPORT_DISCONNECT 16 16 P_CALL_REPORT_REDIRECTED 23 23 P_CALL_REPORT_SERVICE_CODE 31 NA P_CALL_REPORT_NOT_REACHABLE 20 20 P_CALL_REPORT_ROUTING_FAILURE 3 Any other value 6.6.2.17 TpCallReport Defines the Sequence of Data Elements that specify the call report and call leg report specific information. Sequence Element Name Sequence Element Type MonitorMode TpCallMonitorMode CallEventTime TpDateAndTime CallReportType TpCallReportType AdditionalReportInfo TpCallAdditionalReportInfo 6.6.2.18 TpCallAdditionalReportInfo Defines the Tagged Choice of Data Elements that specify additional call report information for certain types of reports. Tag Element Type TpCallReportType Tag Element Value Choice Element Type Choice Element Name P_CALL_REPORT_UNDEFINED NULL Undefined P_CALL_REPORT_PROGRESS NULL Undefined P_CALL_REPORT_ALERTING NULL Undefined P_CALL_REPORT_ANSWER NULL Undefined P_CALL_REPORT_BUSY TpCallReleaseCause Busy P_CALL_REPORT_NO_ANSWER NULL Undefined P_CALL_REPORT_DISCONNECT TpCallReleaseCause CallDisconnect P_CALL_REPORT_REDIRECTED TpAddress ForwardAddress P_CALL_REPORT_SERVICE_CODE TpCallServiceCode ServiceCode P_CALL_REPORT_ROUTING_FAILURE TpCallReleaseCause RoutingFailure P_CALL_REPORT_QUEUED TpString QueueStatus P_CALL_REPORT_NOT_REACHABLE TpCallReleaseCause NotReachable 6.6.2.19 TpCallReportRequest Defines the Sequence of Data Elements that specify the criteria relating to call report requests. Sequence Element Name Sequence Element Type MonitorMode TpCallMonitorMode CallReportType TpCallReportType AdditionalReportCriteria TpCallAdditionalReportCriteria 6.6.2.20 TpCallAdditionalReportCriteria Defines the Tagged Choice of Data Elements that specify specific criteria. Tag Element Type TpCallReportType Tag Element Value Choice Element Type Choice Element Name P_CALL_REPORT_UNDEFINED NULL Undefined P_CALL_REPORT_PROGRESS NULL Undefined P_CALL_REPORT_ALERTING NULL Undefined P_CALL_REPORT_ANSWER NULL Undefined P_CALL_REPORT_BUSY NULL Undefined P_CALL_REPORT_NO_ANSWER TpDuration NoAnswerDuration P_CALL_REPORT_DISCONNECT NULL Undefined P_CALL_REPORT_REDIRECTED NULL Undefined P_CALL_REPORT_SERVICE_CODE TpCallServiceCode ServiceCode P_CALL_REPORT_ROUTING_FAILURE NULL Undefined P_CALL_REPORT_QUEUED NULL Undefined P_CALL_REPORT_NOT_REACHABLE NULL Undefined 6.6.2.21 TpCallReportRequestSet Defines a Numbered Set of Data Elements of TpCallReportRequest. 6.6.2.22 TpCallReportType Defines a specific call event report type. Name Value Description P_CALL_REPORT_UNDEFINED 0 Undefined. P_CALL_REPORT_PROGRESS 1 Call routing progress event: an indication from the network that progress has been made in routing the call to the requested call party. This message may be sent more than once, or may not be sent at all by the gateway with respect to routing a given call leg to a given address. P_CALL_REPORT_ALERTING 2 Call is alerting at the call party. P_CALL_REPORT_ANSWER 3 Call answered at address. P_CALL_REPORT_BUSY 4 Called address refused call due to busy. P_CALL_REPORT_NO_ANSWER 5 No answer at called address. P_CALL_REPORT_DISCONNECT 6 The media stream of the called party has disconnected. This does not imply that the call has ended. When the call is ended, the callEnded method is called. This event can occur both when the called party hangs up, or when the application explicitly releases the leg using IpCallLeg.release() This cannot occur when the app explicitly releases the call leg and the call. P_CALL_REPORT_REDIRECTED 7 Call redirected to new address: an indication from the network that the call has been redirected to a new address. P_CALL_REPORT_SERVICE_CODE 8 Mid-call service code received. P_CALL_REPORT_ROUTING_FAILURE 9 Call routing failed - re-routing is possible. P_CALL_REPORT_QUEUED 10 The call is being held in a queue. This event may be sent more than once during the routing of a call. P_CALL_REPORT_NOT_REACHABLE 11 The called address is not reachable; e.g., the phone has been switched off or the phone is outside the coverage area of the network. 6.6.2.23 TpCallTreatment Defines the Sequence of Data Elements that specify the treatment for calls that will be handled only by the network (for example, call which are not admitted by the call load control mechanism). Sequence Element Name Sequence Element Type CallTreatmentType TpCallTreatmentType ReleaseCause TpCallReleaseCause AdditionalTreatmentInfo TpCallAdditionalTreatmentInfo 6.6.2.24 TpCallEventCriteriaResultSet Defines a set of TpCallEventCriteriaResult. 6.6.2.25 TpCallEventCriteriaResult Defines a sequence of data elements that specify a requested call event notification criteria with the associated assignmentID. Sequence Element Name Sequence Element Type Sequence Element Description CallEventCriteria TpCallEventCriteria The event criteria that were specified by the application. AssignmentID TpInt32 The associated assignmentID. This can be used to disable the notification. 7 MultiParty Call Control Service The Multi-Party Call Control API of 3GPP Rel4 relies on the CAMEL Service Environment (CSE). It should be noted that a number of restrictions exist because CAMEL phase 3 supports only two-party calls and no leg based operations. Furthermore application initiated calls are not supported in CAMEL phase 3. The detailed description of the supported methods is given in the chapter 7.5. 7.1 Sequence Diagrams 7.1.1 Application initiated call setup The following sequence diagram shows an application creating a call between party A and party B. Here, a call is created first. Then party A's call leg is created before events are requested on it for answer and then routed to the call. On answer from Party A, an announcement is played indicating that the call is being set up to party B. While the announcement is being played, party B's call leg is created and then events are requested on it for answer. On answer from Party B the announcement is cancelled and party B is routed to the call. The service may as a variation be extended to include 3 parties (or more). After the two party call is established, the application can create a new leg and request to route it to a new destination address in order to establish a 3 party call. The event that causes this to happen could for example be the report of answer event from B-party or controlled by the A-party by entering a service code (mid-call event). The procedure for call setup to party C is exactly the same as for the set up of the connection to party B (sequence 13 to 17 in the sequence diagram). 1: This message is used to create an object implementing the IpAppMultiPartyCall interface. 2: This message requests the object implementing the IpMultiPartyCallControlManager interface to create an object implementing the IpMultiPartyCall interface. 3: Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met it is created. 4: Once the object implementing the IpMultiPartyCall interface is created it is used to pass the reference of the object implementing the IpAppMultiPartyCall interface as the callback reference to the object implementing the IpMultiPartyCall interface. Note that the reference to the callback interface could already have been passed in the createCall. 5: This message instructs the object implementing the IpMultiPartyCall interface to create a call leg for customer A. 6: Assuming that the criteria for creating an object implementing the IpCallLeg interface is met, message 6 is used to create it. 7: This message requests the call leg for customer A to inform the application when the call leg answers the call. 8: The call is then routed to the originating call leg. 9: Assuming the call is answered, the object implementing party A's IpCallLeg interface passes the result of the call being answered back to its callback object. This message is then forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 10: A UICall object is created and associated with the just created call leg. 11: This message is used to inform party A that the call is being routed to party B. 12: An indication that the dialogue with party A has commenced is returned via message 13 and eventually forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 13: This message instructs the object implementing the IpMultiPartyCall interface to create a call leg for customer B. 14: Assuming that the criteria for creating a second object implementing the IpCallLeg interface is met, it is created. 15: This message requests the call leg for customer B to inform the application when the call leg answers the call. 16: The call is then routed to the call leg. 17: Assuming the call is answered, the object implementing party B's IpCallLeg interface passes the result of the call being answered back to its callback object. This message is then forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 18: This message then instructs the object implementing the IpUICall interface to stop sending announcements to party A. 19: The application deassigns the call. This will also deassign the associated user interaction. 7.1.2 Call Barring 2 The following sequence diagram shows a call barring service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the destination number, the calling party is asked for a PIN code. The code is rejected and the call is cleared. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the callEventNotify. 6: The application requests an list of all the legs currently in the call. 7: This message is used to create a UICall object that is associated with the incoming leg of the call. 8: The call barring service dialogue is invoked. 9: The result of the dialogue, which in this case is the PIN code, is returned to its callback object. 10: This message is used to forward the previous message to the IpAppLogic 11: Assuming an incorrect PIN is entered, the calling party is informed using additional dialogue of the reason why the call cannot be completed. 12: This message passes the indication that the additional dialogue has been sent. 13: This message is used to forward the previous message to the IpAppLogic. 14: No more UI is required, so the UICall object is released. 15: This message is used by the application to clear the call. 7.1.3 Call forwarding on Busy Service The following sequence diagram shows an application establishing a call forwarding on busy. When a call is made from A to B but the B-party is detected to be busy, then the application is informed of this and sets up a connection towards a C party. The C party can for instance be a voicemail system. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("busy") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg objects. 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Initiating. 9: 10: 11: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 12: This message is used to forward the message to the IpAppLogic. 13: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 14: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 15: A new AppCallLeg C is created to receive callbacks for another leg. 16: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 17: 18: 19: The application requests to be notified (monitor mode "INTERRUPT") when party C answers the call. 20: The application requests to route the terminating leg to reach the associated party C. The application may request information about the original destination address be sent by setting up the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo in the request to route the call leg to the remote party C. 21: 22: 23: The application requests to resume call processing for the terminating call leg to party B to terminate the leg. Alternative the application could request to deassign the leg to party B for example if it is not interested in possible requested call leg information (getInfoRes, superviseRes). When the terminating call leg is destroyed, the AppLeg B is notified and the event is forwarded to the application logic (not shown). 24: 25: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party B. 26: When the party C answers the call, the termination call leg is notified. 27: Assuming the call is answered, the object implementing party C's IpCallLeg interface passes the result of the call being answered back to its callback object. 28: This answer message is then forwarded to the object implementing the IpAppLogic interface. 7.1.4 Call Information Collect Service The following sequence diagram shows an application monitoring a call between party A and a party B in order to collect call information at the end of the call for e.g. charging and/or statistic information collection purposes. The service may apply to ordinary two-party calls, but could also include a number translation of the dialled number and special charging (e.g. a premium rate service) . Additional call leg related information is requested with the getInfoReq and superviseReq methods. The answer and call release events are in this service example requested to be reported in notify mode and additional call leg related information is requested with the getInfoReq and superviseReq methods in order to illustrate the information that can be collected and sent to the application at the end of the call. Furthermore is shows the order in which information is sent to the application: network release event followed by possible requested call leg information, then the destroy of the call leg object (callLegEnded) and finally the destroy of the call object (callEnded). 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("analysed information") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg object 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Active. 9: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 10: This message is used to forward message 9 to the IpAppLogic. 11: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 12: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 13: A new AppCallLeg is created to receive callbacks for another leg. 14: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 15: A new CallLeg corresponding to party B is created. 16: A transition to state Idle is made after the Call leg has been created. 17: The application requests to be notified (monitor mode "NOTIFY") when party B answers the call and when the leg to B-party is released. 18: The application requests to supervise the call leg to party B. 19: The application requests information associated with the call leg to party b for example to calculate charging. 20: The application requests a specific charge plan to be set for the call leg to party B. 21: The application requests to route the terminating leg to reach the associated party B. 22: The Call Leg instance transits to state Active. 23: 24: The application requests to be notified (monitor mode "Notify") when the leg to A-party is released. 25: The application requests information associated with the call leg to party A for example to calculate charging. 26: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party B. 27: 28: 29: When the B-party answers the call, the termination call leg is notified. 30: Assuming the call is answered, the object implementing party B's IpCallLeg interface passes the result of the call being answered back to its callback object (monitor mode "NOTIFY"). 31: This answer message is then forwarded. 32: When the A-party releases the call, the originating call leg is notified (monitor mode "NOTIFY") and makes a transition to "releasing state". 33: 34: The application IpAppLeg A is notified, as the release event has been requested to be reported in Notify mode. 35: The event is forwarded to the application logic 36: The call leg information is reported. 37: The event is forwarded to the application logic 38: The origination call leg is destroyed, the AppLeg A is notified. 39: The event is forwarded to the application logic 40: 41: When the B-party releases the call or the call is released as a result of the release request from party A, i.e. a "originating release" indication, the terminating call leg is notified and makes a transition to "releasing state". 42: 43: If a network release event is received being a "terminating release" indication from called party B, the application IpAppLeg B is notified, as the release event from party B has been requested to be reported in NOTIFY mode. Note that no report is sent if the release is caused by propagation of network release event being a "originating release" indication coming from calling party A. 44: The event is forwarded to the application logic. 45: The call leg information is reported. 46: The event is forwarded to the application logic. 47: The supervised call leg information is reported. 48: The event is forwarded to the application logic. 49: The terminating call leg is destroyed, the AppLeg B is notified. 50: The event is forwarded to the application logic. 51: 52: Assuming the IpCall object has been informed that the legs have been destroyed, the IpAppMultiPartyCall is notified that the call is ended . 53: The event is forwarded to the application logic. 7.1.5 Complex Card Service The following sequence diagram shows an advanced card service, initiated as a result of a prearranged event being received by the call control service. Before the call is made, the calling party is asked for an ID and PIN code. If the ID and PIN code are accepted, the calling party is prompted to enter the address of the destination party. A trigger of '#5' is then set on the controlling leg (the calling party's leg) such that if the calling party enters a '#5' an event will be sent to the application. The call is then routed to the destination party. Sometime during the call the calling party enters '#5' which causes the called leg to be released. The calling party is now prompted to enter the address of a new destination party, to which it is then routed. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range result in the caller being prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of message 3. 6: This message returns the call legs currently in the call. In principle a reference to the call leg of the calling party is already obtained by the application when it was notified of the new call event. 7: This message is used to associate a user interaction object with the calling party. 8: The initial card service dialogue is invoked using this message. 9: The result of the dialogue, which in this case is the ID and PIN code, is returned to its callback object using this message and eventually forwarded via another message (not shown) to the IpAppLogic. 10: Assuming the correct ID and PIN are entered, the final dialogue is invoked. 11: The result of the dialogue, which in this case is the destination address, is returned and eventually forwarded via another message (not shown) to the IpAppLogic. 12: This message is used to forward the address of the callback object. 13: The trigger for follow-on calls is set (on service code). 14: A new AppCallLeg is created to receive callbacks for another leg. Alternatively, the already existing AppCallLeg object could be passed in the subsequent createCallLeg(). In that case the application has to use the sessionIDs of the legs to distinguish between callbacks destined for the A-leg and callbacks destined for the B-leg. 15: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 16: The application requests to be notified when the leg is answered. 17: The application routes the leg. As a result the network will try to reach the associated party. 18: When the B-party answers the call, the application is notified. 19: The event is forwarded to the application logic. 20: Legs that are created and routed explicitly are by default in state detached. This means that the media is not connected to the other parties in the call. In order to allow inband communication between the new party and the other parties in the call the media have to be explicitly attached. 21: At some time during the call the calling party enters '#5'. This causes this message to be sent to the object implementing the IpAppCallLeg interface, which forwards this event as a message (not shown) to the IpAppLogic. 22: The event is forwarded to the application. 23: This message releases the called party. 24: Another user interaction dialogue is invoked. 25: The result of the dialogue, which in this case is the new destination address is returned and eventually forwarded via another message (not shown) to the IpAppLogic. 26: A new AppCallLeg is created to receive callbacks for another leg. 27: The call is then forward routed to the new destination party. 28: As a result a new Callleg object is created. 29: This message passes the result of the call being answered to its callback object and is eventually forwarded via another message (not shown) to the IpAppLogic. 30: When the A-party terminates the application is informed. 31: The event is forwarded to the application logic. 32: Since the release of the A-party will in this case terminate the entire call, the application is also notified with this message. 33: The event is forwarded to the application logic. 34: Since the user interaction object were not released at the moment that the call terminated, the application receives this message to indicate that the UI resources are released in the gateway and no further communication is possible. 35: The event is forwarded to the application logic. 36: The application deassigns the call object. 7.1.6 Hotline Service The following sequence diagram shows an application establishing a call between party A and pre-arranged party B defined to constitute a hot-line address. The address of the destination party is provided by the application as the calling party makes a call attempt (goes off-hook) and do not dial any number within a predefined time. In this case a pre-defined number (hot-line number) is provided by the application. The call is then routed to the pre-defined destination party. The call release is monitored to enable the sending of information to the application at call release, e.g. for charging purposes. Note that this service could be extended as follows: Sometime during the call the calling party enters '#5' which causes the called leg to be released. The calling party is now prompted to enter the address of a new destination party, to which it is then routed. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("analysed information") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg object 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Initiating. 9: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 10: This message is used to forward message 9 to the IpAppLogic. 11: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 12: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 13: A new AppCallLeg is created to receive callbacks for another leg. 14: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 15: A new CallLeg corresponding to party B is created. 16: A transition to state Idle is made after the Call leg has been created. 17: The application requests to be notified (monitor mode "NOTIFY") when the leg to party B is released. 18: The application requests to route the terminating leg to reach the associated party as specified by the application ("hot-line number"). 19: The Call Leg instance transits to state Active. 20: 21: The application requests to be notified (monitor mode "Notify") when the leg to A-party is released. 22: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party as specified by the application (E.164 number provided by application). 23: 24: 25: The originating call leg is notified that the number (provided by application) has been analysed by the network and the originating call leg STD makes a transition to "active" state. The application is not notified as it has not requested this event to be reported. 26: 27: When the B-party releases the call, the terminating call leg is notified (monitor mode "NOTIFY") and makes a transition to "Releasing state". 28: 29: The application is notified, as the release event has been requested to be reported in Notify mode. 30: The event is forwarded to the application logic. 31: The terminating call leg is destroyed, the AppLeg B is notified. 32: This answer message is then forwarded. 33: 34: When the call release ("terminating release" indication) is propagated in the network toward the party A, the originating call leg is notified and makes a transition to "releasing state". This release event (being propagated from party B) is not reported to the application. 35: 36: When the originating call leg is destroyed, the AppLeg A is notified. 37: The event is forwarded to the application logic 38: 39: When all legs have been destroyed, the IpAppMultiPartyCall is notified that the call is ended. 40: The event is forwarded to the application logic. 7.1.7 Use of the Redirected event 1: The application has already created the call and a call leg. It places an event report request for the ANSWER and REDIRECTED events in NOTIFY mode. 2: The application routes the call leg. 3: The call is redirected within the network and the application is informed. The new destination address is passed within the event. The event is not disarmed, so subsequent redirections will also be reported. Also, the same call leg is used so the application does not have to create a new one. 4: The call is answered at its new destination. 7.2 Class Diagrams The multiparty call control service consists of two packages, one for the interfaces on the application side and one for interfaces on the service side. The class diagrams in the following figures show the interfaces that make up the multi party call control application package and the multi party call control service package. This class diagram shows the interfaces of the multi-party call control application package and their relations to the interfaces of the multi-party call control service package. Figure: Application Interfaces This class diagram shows the interfaces of the multi-party call control service package. Figure: Service Interfaces 7.3 MultiParty Call Control Service Interface Classes The Multi-party Call Control service enhances the functionality of the Generic Call Control Service with leg management. It also allows for multi-party calls to be established, i.e., up to a service specific number of legs can be connected simultaneously to the same call. The Multi-party Call Control Service is represented by the IpMultiPartyCallControlManager, IpMultiPartyCall, IpCallLeg interfaces that interface to services provided by the network. Some methods are asynchronous, in that they do not lock a thread into waiting whilst a transaction performs. In this way, the client machine can handle many more calls, than one that uses synchronous message calls. To handle responses and reports, the developer must implement IpAppMultiPartyCallControlManager, IpAppMultiPartyCall and IpAppCallLeg to provide the callback mechanism. 7.3.1 Interface Class IpMultiPartyCallControlManager Inherits from: IpService This interface is the 'service manager' interface for the Multi-party Call Control Service. The multi-party call control manager interface provides the management functions to the multi-party call control service. The application programmer can use this interface to provide overload control functionality, create call objects and to enable or disable call-related event notifications. The action table associated with the STD shows in what state the IpMultiPartyCallControlManager must be if a method can successfully complete. In other words, if the IpMultiPartyCallControlManager is in another state the method will throw an exception immediately. This interface shall be implemented by a Multi Party Call Control SCF. As a minimum requirement either the createCall() method shall be implemented, or the createNotification() and destroyNotification() methods shall be implemented. <<Interface>> IpMultiPartyCallControlManager createCall (appCall : in IpAppMultiPartyCallRef) : TpMultiPartyCallIdentifier createNotification (appCallControlManager : in IpAppMultiPartyCallControlManagerRef, notificationRequest : in TpCallNotificationRequest) : TpAssignmentID destroyNotification (assignmentID : in TpAssignmentID) : void changeNotification (assignmentID : in TpAssignmentID, notificationRequest : in TpCallNotificationRequest) : void getNotification () : TpNotificationRequestedSet setCallLoadControl (duration : in TpDuration, mechanism : in TpCallLoadControlMechanism, treatment : in TpCallTreatment, addressRange : in TpAddressRange) : TpAssignmentID Method createCall() This method is used to create a new call object. An IpAppMultiPartyCallControlManager should already have been passed to the IpMultiPartyCallControlManager, otherwise the call control will not be able to report a callAborted() to the application. The application shall invoke setCallback() prior to createCall() if it wishes to ensure this. Returns callReference: Specifies the interface reference and sessionID of the call created. Parameters appCall : in IpAppMultiPartyCallRef Specifies the application interface for callbacks from the call created. Returns TpMultiPartyCallIdentifier Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method createNotification() This method is used to enable call notifications so that events can be sent to the application. This is the first step an application has to do to get initial notifications of calls happening in the network. When such an event happens, the application will be informed by reportNotification(). In case the application is interested in other events during the context of a particular call session it has to use the createAndRouteCallLegReq() method on the call object or the eventReportReq() method on the call leg object. The application will get access to the call object when it receives the reportNotification(). (Note that createNotification() is not applicable if the call is setup by the application). The createNotification method is purely intended for applications to indicate their interest to be notified when certain call events take place. It is possible to subscribe to a certain event for a whole range of addresses, e.g. the application can indicate it wishes to be informed when a call is made to any number starting with 800. If some application already requested notifications with criteria that overlap the specified criteria, the request is refused with P_INVALID_CRITERIA. The criteria are said to overlap if both originating and terminating ranges overlap and the same number plan is used. If a notification is requested by an application with monitor mode set to notify, then there is no need to check the rest of the criteria for overlapping with any existing request as the notify mode does not allow control on a call to be passed over. Only one application can place an interrupt request if the criteria overlaps. Set of the callback reference: The call back reference can be registered either in a) createNotification() or b) explicitly with a setCallback() method e.g. depending on how the application provides its callback reference. Case a: From an efficiency point of view the createNotification() with explicit registration may be the preferred method. Case b: The createNotification() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallback(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised. In case the createNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered by setCallback(). Set additional Call back: If the same application requests two notifications with exactly the same criteria but different callback references, the second callback will be treated as an additional callback. Both notifications will share the same assignmentID. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used. Returns assignmentID: Specifies the ID assigned by the call control manager interface for this newly-enabled event notification. Parameters appCallControlManager : in IpAppMultiPartyCallControlManagerRef If this parameter is set (i.e. not NULL) it specifies a reference to the application interface, which is used for callbacks. If set to NULL, the application interface defaults to the interface specified previously via the setCallback() method. notificationRequest : in TpCallNotificationRequest Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Examples of events are "incoming call attempt reported by network", "answer", "no answer", "busy". Individual addresses or address ranges may be specified for destination and/or origination. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_CRITERIA, P_INVALID_INTERFACE_TYPE, P_INVALID_EVENT_TYPE Method destroyNotification() This method is used by the application to disable call notifications. Parameters assignmentID : in TpAssignmentID Specifies the assignment ID given by the generic call control manager interface when the previous enableNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the exception P_INVALID_ASSIGNMENTID will be raised. If two callbacks have been registered under this assignment ID both of them will be disabled. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID Method changeNotification() This method is used by the application to change the event criteria introduced with createNotification. Any stored criteria associated with the specified assignmentID will be replaced with the specified criteria. Parameters assignmentID : in TpAssignmentID Specifies the ID assigned by the generic call control manager interface for the event notification. If two callbacks have been registered under this assignment ID both of them will be changed. notificationRequest : in TpCallNotificationRequest Specifies the new set of event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method getNotification() This method is used by the application to query the event criteria set with createNotification or changeNotification. Returns notificationsRequested: Specifies the notifications that have been requested by the application. Parameters No Parameters were identified for this method Returns TpNotificationRequestedSet Raises TpCommonExceptions Method setCallLoadControl() This method imposes or removes load control on calls made to a particular address range within the call control service. The address matching mechanism is similar as defined for TpCallEventCriteria. Returns assignmentID: Specifies the assignmentID assigned by the gateway to this request. This assignmentID can be used to correlate the callOverloadEncountered and callOverloadCeased methods with the request. Parameters duration : in TpDuration Specifies the duration for which the load control should be set. A duration of 0 indicates that the load control should be removed. A duration of -1 indicates an infinite duration (i.e., until disabled by the application) A duration of -2 indicates the network default duration. mechanism : in TpCallLoadControlMechanism Specifies the load control mechanism to use (for example, admit one call per interval), and any necessary parameters, such as the call admission rate. The contents of this parameter are ignored if the load control duration is set to zero. treatment : in TpCallTreatment Specifies the treatment of calls that are not admitted. The contents of this parameter are ignored if the load control duration is set to zero. addressRange : in TpAddressRange Specifies the address or address range to which the overload control should be applied or removed. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN 7.3.2 Interface Class IpAppMultiPartyCallControlManager Inherits from: IpInterface The Multi-Party call control manager application interface provides the application call control management functions to the Multi-Party call control service. <<Interface>> IpAppMultiPartyCallControlManager reportNotification (callReference : in TpMultiPartyCallIdentifier, callLegReferenceSet : in TpCallLegIdentifierSet, notificationInfo : in TpCallNotificationInfo, assignmentID : in TpAssignmentID) : TpAppMultiPartyCallBack callAborted (callReference : in TpSessionID) : void managerInterrupted () : void managerResumed () : void callOverloadEncountered (assignmentID : in TpAssignmentID) : void callOverloadCeased (assignmentID : in TpAssignmentID) : void Method reportNotification() This method notifies the application of the arrival of a call-related event. If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of P_TIMER_EXPIRY. Set of the callback reference: A reference to the application interface has to be passed back to the call interface to which the notification relates. However, the setting of a call back reference is only applicable if the notification is in INTERRUPT mode. When reportNotification() is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, the application writer should ensure that no continue processing e.g. createAndRouteCallLegReq() is performed until the callback interface for the new call and/or new call leg has been passed to the gateway, either through an explicit setCallbackWithSessionID() invocation, or via the return of the reportNotification() method. The call back reference can be registered either in a) reportNotification() or b) explicitly with a setCallbackWithSessionID() method depending on how the application provides its callback reference. Case a: From an efficiency point of view the reportNotification() with explicit pass of registration may be the preferred method. Case b: The reportNotification() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallbackWithSessionID(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised, and no further application invocations related to the call shall be permitted. In case reportNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered previously by setCallbackWithSessionID(). Returns appCallBack: Specifies references to the application interface which implements the callback interface for the new call and/or new call leg. If the application has previously explicitly passed a reference to the callback interface using a setCallbackWithSessionID() invocation, this parameter may be set to P_APP_CALLBACK_UNDEFINED, or if supplied must be the same as that provided during the setCallbackWithSessionID(). This parameter will be set to P_APP_CALLBACK_UNDEFINED if the notification is in NOTIFY mode and in case b. Parameters callReference : in TpMultiPartyCallIdentifier Specifies the reference to the call interface to which the notification relates. If the notification is being given in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking reportNotification may populate this parameter as it chooses. callLegReferenceSet : in TpCallLegIdentifierSet Specifies the set of all call leg references. First in the set is the reference to the originating callLeg. It indicates the call leg related to the originating party. In case there is a destination call leg this will be the second leg in the set. from the notificationInfo can be found on whose behalf the notification was sent. However, if the notification is being given in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking reportNotification may populate this parameter as it chooses. notificationInfo : in TpCallNotificationInfo Specifies data associated with this event (e.g. the originating or terminating leg which reports the notification ). assignmentID : in TpAssignmentID Specifies the assignment id which was returned by the createNotification() method. The application can use assignment id to associate events with event specific criteria and to act accordingly. Returns TpAppMultiPartyCallBack Method callAborted() This method indicates to the application that the call object has aborted or terminated abnormally. No further communication will be possible between the call and application. Parameters callReference : in TpSessionID Specifies the sessionID of call that has aborted or terminated abnormally. Method managerInterrupted() This method indicates to the application that event notifications and method invocations have been temporarily interrupted (for example, due to network resources unavailable). Note that more permanent failures are reported via the Framework (integrity management). Parameters No Parameters were identified for this method Method managerResumed() This method indicates to the application that event notifications are possible and method invocations are enabled. Parameters No Parameters were identified for this method Method callOverloadEncountered() This method indicates that the network has detected overload and may have automatically imposed load control on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the addressrange for within which the overload has been encountered. Method callOverloadCeased() This method indicates that the network has detected that the overload has ceased and has automatically removed any load controls on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the addressrange for within which the overload has been ceased 7.3.3 Interface Class IpMultiPartyCall Inherits from: IpService The Multi-Party Call provides the possibility to control the call routing, to request information from the call, control the charging of the call, to release the call and to supervise the call. It also gives the possibility to manage call legs explicitly. An application may create more then one call leg. This interface shall be implemented by a Multi Party Call Control SCF. The release() and deassignCall() methods, and either the createCallLeg() or the createAndRouteCallLegReq(), shall be implemented as a minimum requirement. <<Interface>> IpMultiPartyCall getCallLegs (callSessionID : in TpSessionID) : TpCallLegIdentifierSet createCallLeg (callSessionID : in TpSessionID, appCallLeg : in IpAppCallLegRef) : TpCallLegIdentifier createAndRouteCallLegReq (callSessionID : in TpSessionID, eventsRequested : in TpCallEventRequestSet, targetAddress : in TpAddress, originatingAddress : in TpAddress, appInfo : in TpCallAppInfoSet, appLegInterface : in IpAppCallLegRef) : TpCallLegIdentifier release (callSessionID : in TpSessionID, cause : in TpReleaseCause) : void deassignCall (callSessionID : in TpSessionID) : void getInfoReq (callSessionID : in TpSessionID, callInfoRequested : in TpCallInfoType) : void setChargePlan (callSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void superviseReq (callSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallSuperviseTreatment) : void Method getCallLegs() This method requests the identification of the call leg objects associated with the call object. Returns the legs in the order of creation. Returns callLegList: Specifies the call legs associated with the call. The set contains both the sessionIDs and the interface references. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Returns TpCallLegIdentifierSet Raises TpCommonExceptions, P_INVALID_SESSION_ID Method createCallLeg() This method requests the creation of a new call leg object. Returns callLeg: Specifies the interface and sessionID of the call leg created. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. appCallLeg : in IpAppCallLegRef Specifies the application interface for callbacks from the call leg created. Returns TpCallLegIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE Method createAndRouteCallLegReq() This asynchronous operation requests creation and routing of a new callLeg. In case the connection to the destination party is established successfully the CallLeg is attached to the call, i.e. no explicit attachMediaReq() operation is needed. Requested events will be reported on the IpAppCallLeg interface. This interface the application must provide through the appLegInterface parameter. The extra address information such as originatingAddress is optional. If not present (i.e., the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in corresponding addresses from the route is used, otherwise the network or gateway provided numbers will be used. If the application wishes that the call leg should be represented in the network as being a redirection it should include a value for the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo. If this method is invoked, and call reports have been requested, yet the IpAppCallLeg interface parameter is NULL, this method shall throw the P_NO_CALLBACK_ADDRESS_SET exception. Returns callLegReference: Specifies the reference to the CallLeg interface that was created. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. eventsRequested : in TpCallEventRequestSet Specifies the event specific criteria used by the application to define the events required. Only events that meet these criteria are reported. Examples of events are "address analysed", "answer" and "release". targetAddress : in TpAddress Specifies the destination party to which the call should be routed. originatingAddress : in TpAddress Specifies the address of the originating (calling) party. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call (such as alerting method, tele-service type, service identities and interaction indicators). appLegInterface : in IpAppCallLegRef Specifies a reference to the application interface that implements the callback interface for the new call leg. Requested events will be reported by the eventReportRes() operation on this interface. Returns TpCallLegIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN, P_INVALID_NETWORK_STATE, P_INVALID_EVENT_TYPE, P_INVALID_CRITERIA Method release() This method requests the release of the call object and associated objects. The call will also be terminated in the network. If the application requested reports to be sent at the end of the call (e.g., by means of getInfoReq) these reports will still be sent to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. cause : in TpReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method deassignCall() This method requests that the relationship between the application and the call and associated objects be de-assigned. It leaves the call in progress, however, it purges the specified call object so that the application has no further control of call processing. If a call is de-assigned that has call information reports, call leg event reports or call Leg information reports requested, then these reports will be disabled and any related information discarded. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getInfoReq() This asynchronous method requests information associated with the call to be provided at the appropriate time (for example, to calculate charging). This method must be invoked before the call is routed to a target address. A report is received when the destination leg or party terminates or when the call ends. The call object will exist after the call is ended if information is required to be sent to the application at the end of the call. In case the originating party is still available the application can still initiate a follow-on call using routeReq. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoRequested : in TpCallInfoType Specifies the call information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setChargePlan() Set an operator specific charge plan for the call. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_CURRENCY, P_INVALID_AMOUNT Method superviseReq() The application calls this method to supervise a call. The application can set a granted connection time for this call. If an application calls this operation before it routes a call or a user interaction operation the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID 7.3.4 Interface Class IpAppMultiPartyCall Inherits from: IpInterface The Multi-Party call application interface is implemented by the client application developer and is used to handle call request responses and state reports. <<Interface>> IpAppMultiPartyCall getInfoRes (callSessionID : in TpSessionID, callInfoReport : in TpCallInfoReport) : void getInfoErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseRes (callSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callEnded (callSessionID : in TpSessionID, report : in TpCallEndedReport) : void createAndRouteCallLegErr (callSessionID : in TpSessionID, callLegReference : in TpCallLegIdentifier, errorIndication : in TpCallError) : void Method getInfoRes() This asynchronous method reports time information of the finished call or call attempt as well as release cause depending on which information has been requested by getInfoReq. This information may be used e.g. for charging purposes. The call information will possibly be sent after reporting of all cases where the call or a leg of the call has been disconnected or a routing failure has been encountered. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoReport : in TpCallInfoReport Specifies the call information requested. Method getInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseRes() This asynchronous method reports a call supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection is terminated before the supervision event occurs. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call supervision response. usedTime : in TpDuration Specifies the used time for the call supervision (in milliseconds). Method superviseErr() This asynchronous method reports a call supervision error to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callEnded() This method indicates to the application that the call has terminated in the network. Note that the event that caused the call to end might have been received separately if the application was monitoring for it. Parameters callSessionID : in TpSessionID Specifies the call sessionID. report : in TpCallEndedReport Specifies the reason the call is terminated. Method createAndRouteCallLegErr() This asynchronous method indicates that the request to route the call leg to the destination party was unsuccessful - the call leg could not be routed to the destination party (for example, the network was unable to route the call leg, the parameters were incorrect, the request was refused, etc.). Note that the event cases that can be monitored and correspond to an unsuccessful setup of a connection (e.g. busy, no_answer) will be reported by eventReportRes() and not by this operation. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callLegReference : in TpCallLegIdentifier Specifies the reference to the CallLeg interface that was created. errorIndication : in TpCallError Specifies the error which led to the original request failing. 7.3.5 Interface Class IpCallLeg Inherits from: IpService The call leg interface represents the logical call leg associating a call with an address. The call leg tracks its own states and allows charging summaries to be accessed. The leg represents the signalling relationship between the call and an address. An application that uses the IpCallLeg interface to set up connections has good control, e.g. by defining leg specific event request and can obtain call leg specific report and events. This interface shall be implemented by a Multi Party Call Control SCF. The routeReq(), eventReportReq(), release(), continueProcessing() and deassign() methods shall be implemented as a minimum requirement. <<Interface>> IpCallLeg routeReq (callLegSessionID : in TpSessionID, targetAddress : in TpAddress, originatingAddress : in TpAddress, appInfo : in TpCallAppInfoSet, connectionProperties : in TpCallLegConnectionProperties) : void eventReportReq (callLegSessionID : in TpSessionID, eventsRequested : in TpCallEventRequestSet) : void release (callLegSessionID : in TpSessionID, cause : in TpReleaseCause) : void getInfoReq (callLegSessionID : in TpSessionID, callLegInfoRequested : in TpCallLegInfoType) : void getCall (callLegSessionID : in TpSessionID) : TpMultiPartyCallIdentifier attachMediaReq (callLegSessionID : in TpSessionID) : void detachMediaReq (callLegSessionID : in TpSessionID) : void getCurrentDestinationAddress (callLegSessionID : in TpSessionID) : TpAddress continueProcessing (callLegSessionID : in TpSessionID) : void setChargePlan (callLegSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callLegSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void superviseReq (callLegSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallLegSuperviseTreatment) : void deassign (callLegSessionID : in TpSessionID) : void Method routeReq() This asynchronous method requests routing of the call leg to the remote party indicated by the targetAddress. In case the connection to the destination party is established successfully the CallLeg will be either detached or attached to the call based on the attach Mechanism values specified in the connectionProperties parameter. The extra address information such as originatingAddress is optional. If not present (i.e. the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in the corresponding addresses from the route is used, otherwise network or gateway provided addresses will be used. If the application wishes that the call leg should be represented in the network as being a redirection it should include a value for the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo. This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. targetAddress : in TpAddress Specifies the destination party to which the call leg should be routed originatingAddress : in TpAddress Specifies the address of the originating (calling) party. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call leg (such as alerting method, tele-service type, service identities and interaction indicators). connectionProperties : in TpCallLegConnectionProperties Specifies the properties of the connection. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN Method eventReportReq() This asynchronous method sets, clears or changes the criteria for the events that the call leg object will be set to observe. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. eventsRequested : in TpCallEventRequestSet Specifies the event specific criteria used by the application to define the events required. Only events that meet these criteria are reported. Examples of events are "address analysed", "answer" and "release". Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_EVENT_TYPE, P_INVALID_CRITERIA Method release() This method requests the release of the call leg. If successful, the associated address (party) will be released from the call, and the call leg deleted. Note that in some cases releasing the party may lead to release of the complete call in the network. The application will be informed of this with callEnded(). This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. cause : in TpReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method getInfoReq() This asynchronous method requests information associated with the call leg to be provided at the appropriate time (for example, to calculate charging). Note that in the call leg information must be accessible before the objects of concern are deleted. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. callLegInfoRequested : in TpCallLegInfoType Specifies the call leg information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getCall() This method requests the call associated with this call leg. Returns callReference: Specifies the interface and sessionID of the call associated with this call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Returns TpMultiPartyCallIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID Method attachMediaReq() This method requests that the call leg be attached to its call object. This will allow transmission on all associated bearer connections or media streams to and from other parties in the call. The call leg must be in the connected state for this method to complete successfully. Parameters callLegSessionID : in TpSessionID Specifies the sessionID of the call leg to attach to the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method detachMediaReq() This method will detach the call leg from its call, i.e., this will prevent transmission on any associated bearer connections or media streams to and from other parties in the call. The call leg must be in the connected state for this method to complete successfully. Parameters callLegSessionID : in TpSessionID Specifies the sessionID of the call leg to detach from the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method getCurrentDestinationAddress() Queries the current address of the destination the leg has been directed to. Returns the address of the destination point towards which the call leg has been routed.. If this method is invoked on the Originating Call Leg, exception P_INVALID_STATE will be thrown. Parameters callLegSessionID : in TpSessionID Specifies the call session ID of the call leg. Returns TpAddress Raises TpCommonExceptions, P_INVALID_SESSION_ID Method continueProcessing() This operation continues processing of the call leg. Applications can invoke this operation after call leg processing was interrupted due to detection of a notification or event the application subscribed its interest in. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method setChargePlan() Set an operator specific charge plan for the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_CURRENCY, P_INVALID_AMOUNT Method superviseReq() The application calls this method to supervise a call leg. The application can set a granted connection time for this call. If an application calls this function before it calls a routeReq() or a user interaction function the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallLegSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method deassign() This method requests that the relationship between the application and the call leg and associated objects be de-assigned. It leaves the call leg in progress, however, it purges the specified call leg object so that the application has no further control of call leg processing. If a call leg is de-assigned that has event reports or call leg information reports requested, then these reports will be disabled and any related information discarded. The application should not release or deassign the call leg when received a callLegEnded() or callEnded(). This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Raises TpCommonExceptions, P_INVALID_SESSION_ID 7.3.6 Interface Class IpAppCallLeg Inherits from: IpInterface The application call leg interface is implemented by the client application developer and is used to handle responses and errors associated with requests on the call leg in order to be able to receive leg specific information and events. <<Interface>> IpAppCallLeg eventReportRes (callLegSessionID : in TpSessionID, eventInfo : in TpCallEventInfo) : void eventReportErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void attachMediaRes (callLegSessionID : in TpSessionID) : void attachMediaErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void detachMediaRes (callLegSessionID : in TpSessionID) : void detachMediaErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void getInfoRes (callLegSessionID : in TpSessionID, callLegInfoReport : in TpCallLegInfoReport) : void getInfoErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void routeErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseRes (callLegSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void callLegEnded (callLegSessionID : in TpSessionID, cause : in TpReleaseCause) : void Method eventReportRes() This asynchronous method reports that an event has occurred that was requested to be reported (for example, a mid-call event, the party has requested to disconnect, etc.). Depending on the type of event received, outstanding requests for events are discarded. The exact details of these so-called disarming rules are captured in the data definition of the event type. If this method is invoked for a report with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the application has control of the call leg. If the application does nothing with the call leg within a specified time period (the duration which forms a part of the service level agreement), then the connection in the network shall be released and callLegEnded() shall be invoked, giving a release cause of P_TIMER_EXPIRY. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg on which the event was detected. eventInfo : in TpCallEventInfo Specifies data associated with this event. Method eventReportErr() This asynchronous method indicates that the request to manage call leg event reports was unsuccessful, and the reason (for example, the parameters were incorrect, the request was refused, etc.). Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method attachMediaRes() This asynchronous method reports the attachment of a call leg to a call has succeeded. The media channels or bearer connections to this leg is now available. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. Method attachMediaErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method detachMediaRes() This asynchronous method reports the detachment of a call leg from a call has succeeded. The media channels or bearer connections to this leg is no longer available. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. Method detachMediaErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method getInfoRes() This asynchronous method reports all the necessary information requested by the application, for example to calculate charging. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. callLegInfoReport : in TpCallLegInfoReport Specifies the call leg information requested. Method getInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method routeErr() This asynchronous method indicates that the request to route the call leg to the destination party was unsuccessful - the call leg could not be routed to the destination party (for example, the network was unable to route the call leg, the parameters were incorrect, the request was refused, etc.). Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseRes() This asynchronous method reports a call leg supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection to a party is terminated before the supervision event occurs. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call leg supervision response. usedTime : in TpDuration Specifies the used time for the call leg supervision (in milliseconds). Method superviseErr() Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callLegEnded() This method indicates to the application that the leg has terminated in the network. The application has received all requested results (e.g., getInfoRes) related to the call leg. The call leg will be destroyed after returning from this method. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. cause : in TpReleaseCause Specifies the reason the connection is terminated. 7.4 MultiParty Call Control Service State Transition Diagrams 7.4.1 State Transition Diagrams for IpMultiPartyCallControlManager Figure : Application view and the Multi-Party Call Control Manager 7.4.1.1 Active State In this state a relation between the Application and the Service has been established. The state allows the application to indicate that it is interested in call related events. In case such an event occurs, the Manager will create a Call object with the appropriate number of Call Leg objects and inform the application. The application can also indicate it is no longer interested in certain call related events by calling destroyNotification(). 7.4.1.2 Interrupted State When the Manager is in the Interrupted state it is temporarily unavailable for use. Events requested cannot be forwarded to the application and methods in the API cannot successfully be executed. A number of reasons can cause this: for instance the application receives more notifications from the network than defined in the Service Agreement. Another example is that the Service has detected it receives no notifications from the network due to e.g. a link failure. 7.4.1.3 Overview of allowed methods Call Control Manager State Methods applicable Active createCall, createNotification, destroyNotification, changeNotification, getNotification, setCallLoadControl Interrupted getNotification 7.4.2 State Transition Diagrams for IpMultiPartyCall The state transition diagram shows the application view on the MultiParty Call object. When an IpMultiPartyCall is created using createCall, or when an IpMultiPartyCall is given to the application for a notification with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, an activity timer is started. The activity timer is stopped when the application invokes a method on the IpMultiPartyCall. The action upon expiry of this activity timer is to invoke callEnded() on the IpAppMultiPartyCall with a release cause of P_TIMER_EXPIRY. In the case when no IpAppMultiPartyCall is available on which to invoke callEnded(), callAborted() shall be invoked on the IpAppMultiPartyCallControlManager as this is an abnormal termination. Figure : Application view on the MultiParty Call object 7.4.2.1 IDLE State In this state the Call object has no Call Leg object associated to it. The application can request for charging related information reports, call supervision, set the charge plan and set Advice Of Charge indicators. When the first Call Leg object is requested to be created a state transition is made to the Active state. 7.4.2.2 ACTIVE State In this state the Call object has one or more Call Leg objects associated to it. The application is allowed to create additional Call Leg objects. Furthermore, the application can request for call supervision. The Application can request charging related information reports, set the charge plan and set Advice Of Charge indicators in this state prior to call establishment. 7.4.2.3 RELEASED State In this state the last Call leg object has released or the call itself was released. While the call is in this state, the requested call information will be collected and returned through getInfoRes() and / or superviseRes(). As soon as all information is returned, the application will be informed that the call has ended and Call object transition to the end state. 7.4.2.4 Overview of allowed methods Methods applicable Call Control Call State Call Control Manager State getCallLegs, Idle, Active, Released - createCallLeg, createAndRouteCallLegReq, setAdviceOfCharge, superviseReq, Idle, Active Active release Active Active deassignCall Idle, Active - setChargePlan, getInfoReq Idle, Active Active 7.4.3 State Transition Diagrams for IpCallLeg The IpCallLeg State Transition Diagram is divided in two State Transition Diagrams, one for the originating call leg and one for the terminating call leg. Call Leg State Model General Objectives: 1) Events in backwards direction (upstream), coming from terminating leg, are not visible in originating leg model. 2) Events in forwards direction (downstream), coming from originating leg, are not visible in terminating leg model. 3) States are as seen from the application: if there is no change in the method an application is permitted to apply on the IpCallLeg object, then there is no state change. Therefore receipt of e.g. answer or alerting events on terminating leg do not change state. NOTE 2 4) The application is to send a request to continue processing (using an appropriate method like continueProcessing) for each leg and event reported in monitor mode β€˜interrupt’. 5) In case on a leg more than one network event (for example mid-call event β€˜service_code’) is to be reported to the application at quasi the same time, then the events are to be reported one by one to the application in the order received from the network. When for a leg an event is reported in interrupt mode, a next pending event is not to be reported to the application until a request to resume call processing for the current reported event has been received on the leg. NOTE1: Call processing is suspended if for a leg a network event is met, which was requested to be monitored in the P_CALL_MONITOR_MODE_INTERRUPT. NOTE2: Even though there in the Originating Call Leg STD is no change in the methods the application is permitted to apply to the IpCallLeg object for the states Analysing and Active, separate states are maintained. The states may therefore from an application viewpoint appear as just one state that may be have substates like Analysing and Active. The digit collection task in state Analysing state may be viewed as a specialised task that may not at all be applicable in some networks and therefore here described as being a state on its own. 7.4.3.1 Originating Call Leg Figure : Originating Leg 7.4.3.1.1 Initiating State Entry events: β€’ Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an β€œOriginating_Call_Attempt” initial notification criterion. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an β€œOriginating_Call_Attempt_Authorised” initial notification criterion. Functions: In this state the network checks the authority/ability of the party to place the connection to the remote (destination) party with the given properties, e.g. based on the originating party’s identity and service profile. The setup of the connection for the party has been initiated and the application activity timer is being provided. The figure below shows the order in which network events may be detected in the Initiating state and depending on the monitor mode be reported to the application. Note 1: Event oCA only applicable as an initial notification . Note 2: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: oCA: originating Call Attempt; oCAA originating Call Attempt Authorized; AC: Address Collected, oREL originating RELease. Figure : Application view on event reporting order in Initiating State In this state the following functions are applicable: - The detection of a β€œOriginating_Call_Attempt” initial notification criterion. - The detection of an β€œOriginating_Call_Attempt_Authorised” initial notification criterion as a result that the call attempt authorisation is successful. - The report of the β€œOriginating_Call_Attempt_Authorised” event indication whereby the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then no monitoring is performed. - The receipt of destination address information, i.e. initial information package/dialling string as received from calling party. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Availability of destination address information, i.e. the initial information package/dialling string received from the calling party. - Application activity timer expiry indicating that no requests from the application have been received during a certain period. - Receipt of a deassign() method. β€’ Receipt of a release() method. - Detection of a β€œoriginating release” indication as a result of a premature disconnect from the calling party. 7.4.3.1.2 Analysing State Entry events: - Availability of an β€œAddress_Collected” event indication as a result of the receipt of the (complete) initial information package/dialling string from the calling party. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an β€œAddress_Collected” initial notification criterion. Functions: In this state the destination address provided by the calling party is collected and analysed. The received information (dialled address string from the calling party) is being collected and examined in accordance to the dialling plan in order to determine end of address information (digit) collection. Additional address digits can be collected. Upon completion of address collection the address is analysed. The address analysis is being made according to the dialling plan in force to determine the routing address of the call leg connection and the connection type (e.g. local, transit, gateway). The request (with eventReportReq method) to collect a variable number of more address digits and report them to the application (within eventReportRes method)) is handled within this state. The collection of more digits as requested and the reporting of received digits to the application (when the digit collect criteria is met) is done in this state. This action is recursive, e.g. the application could ask for 3 digits to be collected and when report request can be done repeatedly, e.g. the application may for example request first for 3 digits to be collected and when reported request further digits. The figure below shows the order in which network events may be detected in the Analysing state and depending on the monitor mode be reported to the application. Note 1: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: oCAA: originating Call Attempt Authorized; AC: Address Collected; AA: Address Analysed; oREL: originating RELease. Figure : Application view on event reporting order in Analysing State In this state the following functions are applicable: - The detection of a β€œAddress_Collectedβ€œ initial notification criterion. - On receipt of the β€œAddress_Collected” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then no monitoring is performed. - Receipt of a eventReportReq() method defining the criteria for the events the call leg object is to observe. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() or a routeReq() method. Exit events: - Detection of an β€œAddress_Analysed” indication as a result of the availability of the routing address and nature of address. - Receipt of a deassign() method. - Receipt of a release() method. - Detection of a β€œoriginating release” indication as a result of a premature disconnect from the calling party. 7.4.3.1.3 Active State Entry events: - Receipt of an β€œAddress_Analysed” indication as a result of the availability of the routing address and nature of address. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an β€œAddress_Analysed initial indication criterion. Functions: In this state the call leg connection to the calling party exists and originating mid call events can be received. The figure below shows the order in which network events may be detected in the Active state and depending on the monitor mode be reported to the application. Note 1: Only the detected service code or the range to which the service code belongs is disarmed as the service code is reported to the application Note 2: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: AC: Address Collected; AA: Address Analysed; oSC: originating Service Code; oREL: originating RELease. Figure : Application view on event reporting order Active State In this state the following functions are applicable: - The detection of a Address_Analysed initial indication criterion. - On receipt of the β€œAddress_Analysed” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then no monitoring is performed. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. - In this state the routing information is interpreted, the authority of the calling party to establish this connection is verified and the call leg connection is set up to the remote party. - In this state a connection to the call party is established. - Detection of a β€œterminating release” indication (not visible to the application) from remote party caused by a network release event propagated from a terminating party, possibly resulting in an β€œoriginating release” indication and causing the originating call leg STD to transit to Releasing state: - Detection of a disconnect from the calling party. - Receipt of a deassign() method. - Receipt of a release() method. - On receipt of the β€œoriginating_service code” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODED then the event is notified and call leg processing continues.. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODE then no monitoring is performed. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Detection of an β€œoriginating release” indication as a result of a disconnect from the calling party and a β€œterminating release” indication as a result of a disconnect from called party. - Receipt of a deassign() method. - Receipt of a release() method from the application. 7.4.3.1.4 Releasing State Entry events: - Detection of an β€œOriginating_Release” indication as a result of the network release initiated by calling party or called party. - Reception of the release() method from the application. - A transition due to fault detection to this state is made when the Call leg object is in a state and no requests from the application have been received during a certain time period (timer expiry). Functions: In this state the connection to the call party is released as requested by the network or by the application and the reports are processed and sent to the application if requested. When the Releasing state is entered the order of actions to be performed is as follows: i) the network release event handling is performed. ii) the possible call leg information requested with getInfoReq() and/ or superviseReq() is collected and send to the application. iii) the callLegEnded() method is sent to the application to inform that the call leg object is destroyed. In this state the following functions are applicable: β€’ The detection of a β€œoriginating_release” initial indication criterion.. - On receipt of the β€œoriginating_release” indication the following functions are performed: - The network release event handling is performed as follows: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_RELEASE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_RELEASE then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_RELEASE then no monitoring is performed. β€’ Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. β€’ The possible call leg information requested with the getInfoReq() and/or superviseReq() is collected and sent to the application with respectively the getInfoRes() and/or superviseRes() methods. β€’ The callLegEnded() method is sent to the application after all information has been sent. In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application will also be informed that the connection has ended β€’ In case of abnormal termination due to a fault and the application requested for call leg related information previously, the application will be informed that this information is not available and additionally the application is informed that the call leg object is destroyed (callLegEnded). Note: the call in the network may continue or be released, depending e.g. on the call state. - In case the release() method is received in Releasing state it will be discarded. The request from the application to release the leg is ignored in this case because release of the leg is already ongoing. Exit events: - In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. - After the sending of the last call leg information to the application the Call Leg object is destroyed and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. 7.4.3.1.5 Overview of allowed methods, Originating Call Leg STD State Methods allowed Initiating attachMediaReq (as a request), detachMediaReq, (as a request) getCall , continueProcessing, release (call leg), deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Analysing attachMediaReq (as a request), detachMediaReq, (as a request) getCall , continueProcessing, release (call leg), deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Active attachMediaReq, detachMediaReq, getCall, continueProcessing, release deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Releasing getCall , continueProcessing, release deassign 7.4.3.2 Terminating Call Leg Figure : Terminating Leg 7.4.3.2.1 Idle (terminating) State Entry events: - Receipt of a createCallLeg() method to start an application initiated call leg connection. Functions: In this state the call leg object is created and the interface connection is idled. The application activity timer is being provided. In this state the following functions are applicable: - Invoking routeReq will result in a request to actually route the call leg object. - Resumption of call leg processing occurs on receipt of a routeReq() method. Exit events: - Receipt of a routeReq() method from the application. - Application activity timer expiry indicating that no requests from the application have been received during a certain period to continue processing. - Receipt of a deassign() method. - Receipt of a release() method. - Detection of a network release event being an β€œoriginating release” indication as a result of a premature disconnect from the calling party. 7.4.3.2.2 Active (terminating) State Entry events: β€’ Receipt of an routeReq will result in actually routing the call leg object. β€’ Receipt of a createAndRouteCallLegReq() method to start an application initiated call leg connection. β€’ Sending of a reportNotification() method by the IpMultiPartyCallControlManager for the following trigger criteria: β€œTerminating_Call_Attempt”, β€œTerminating_Call_Attempt_Authorised”, β€œAlerting”, β€œAnswer”, β€œTerminating service code”, β€œRedirected” and β€œQueued”. Functions: In this state the routing information is interpreted, the authority of the called party to establish this connection is verified for the call leg connection. In this state a connection to the call party is established whereby events from the network may indicate to the application when the party is alerted (acknowledge connection setup) and when the party answer (confirmation of connection setup). Furthermore, in this state terminating service code events can be received. The figure below shows the order in which network events may be detected in the Active state and depending on the monitor mode be reported to the application. Note 1: Event tCA applicable as initial notification Note 2: Only the detected service code or the range to which the service code belongs is disarmed as the service code is reported to the application Note 3: The release event (tREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: tCA: Terminating Call Attempt; tCAA: terminating Call Attempt Authorized; AL: Alerting; ANS: Answer; tREL: terminating RELease; Q: Queued; RD: ReDirected; tSC: terminating Service Code. Figure : Application view on event reporting order in Active State In this state the following functions are applicable: - The detection and report of the β€œTerminating_Call_Attempt_Authorised” event indication whereby the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_CALL_TERMINATING_ATTEMPT_AUTHORISED then no monitoring is performed. β€’ Detection of an β€œQueued” indication as a result of the terminating call being queued. - On receipt of the β€œQueued” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_QUEUED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_QUEUED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_QUEUED then no monitoring is performed. - On receipt of the β€œAlerting” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ALERTING then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ALERTING then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ALERTING then no monitoring is performed. β€’ Detection of an β€œAnswer” indication as a result of the remote party being connected (answered). - On receipt of the β€œAnswer” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ANSWER then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ANSWER then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ANSWER then no monitoring is performed. - The detection of a β€œservice_code” trigger criterion suspends call leg processing. - On receipt of the β€œservice code” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then this is not a valid event (that event is not notified) and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then no monitoring is performed. - On receipt of the β€œredirected” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_REDIRECTED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_REDIRECTED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_REDIRECTED then no monitoring is performed. - Resumption of call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Detection of a network release event being an β€œterminating release” indication as a result of the following events: i) Unable to select a route or indication from the remote party of the call leg connection cannot be presented (this is the network determined busy condition) ii) Occurrence of an authorisation failure when the authority to place the call leg connection was denied (e.g. business group restriction mismatch). iii) Detection of a route busy condition received from the remote call leg connection portion. iv) Detection of a no-answer condition received from the remote call leg connection portion. v) Detection that the remote party was not reachable. - Detection of a network release event being an β€œoriginating release” indication as a result of the following events: vi) Detection of a premature disconnect from the calling party. - Receipt of a deassign() method. - Receipt of a release() method from the application. - Detection of a network release event being an β€œoriginating release” indication as a result of a disconnect from the calling party or a β€œterminating release” indication as a result of a disconnect from the called party. 7.4.3.2.3 Releasing (terminating) State Entry events: - Detection of a network release event being an β€œoriginating release” indication as a result of the network release initiated by calling party or a β€œterminating release” indication as a result of the network release initiated by called party.. - Sending of the release() method by the application. β€’ A transition due to fault detection to this state is made when the Call leg object awaits a request from the application and this is not received within a certain time period. - Detection of a network event being a β€œterminating release” indication as a result of the following events: i) Unable to select a route or indication from the remote party of the call leg connection cannot be presented (this is the network determined busy condition) ii) Occurrence of an authorisation failure when the authority to place the call leg connection was denied (e.g. business group restriction mismatch). iii) Detection of a route busy condition received from the remote call leg connection portion. iv) Detection of a no-answer condition received from the remote call leg connection portion. v) Detection that the remote party was not reachable. - Detection of a network release event being an β€œoriginating release” indication as a result of the following events: vi) Detection of a premature disconnect from the calling party. Functions: In this state the connection to the call party is released as requested by the network or by the application and the reports are processed and sent to the application if requested . When the Releasing state is entered the order of actions to be performed is as follows: i) the release event handling is performed. ii) the possible call leg information requested with getInfoReq() and/ or superviseReq() is collected and send to the application. iii) the callLegEnded() method is sent to the application to inform that the call leg object is destroyed. Where the entry to this state is caused by the application, for example because the application has requested the leg to be released or deassigned or a fault (e.g. timer expiry, no response from application) has been detected, then i) is not applicable. In the fault case for action ii) error report methods are sent to the application for any possible requested reports. In this state the following functions are applicable: β€’ The detection of a β€œTerminating Release” trigger criterion. - On receipt of the network release event being a β€œTerminating Release” indication the following functions are performed: - The network release event handling is performed as follows: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then no monitoring is performed. β€’ Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. β€’ The possible call leg information requested with the getInfoReq() and/or superviseReq() is collected and sent to the application with respectively the getInfoRes() and/or superviseRes() methods. β€’ The callLegEnded() method is sent to the application after all information has been sent. In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application will also be informed that the connection has ended β€’ In case of abnormal termination due to a fault and the application requested for call leg related information previously, the application will be informed that this information is not available and additionally the application is informed that the call leg object is destroyed (callLegEnded). Note: the call in the network may continue or be released, depending e.g. on the call state. β€’ In case the release() method is received in Releasing state it will be discarded. The request from the application to release the leg is ignored in this case because release of the leg is already ongoing. Exit events: - In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. - After the sending of the last call leg information to the application the Call Leg object is destroyed and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. 7.4.3.2.4 Overview of allowed methods and trigger events, Terminating Call Leg STD State Methods allowed Idle routeReq, getCall , getCurrentDestinationAddress, release, deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Active attachMediaReq detachMediaReq getCall , getCurrentDestinationAddress, continueProcessing, release, deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Releasing getCall , getCurrentDestinationAddress, continueProcessing, release, deassign 7.5 Multi-Party Call Control Service Properties 7.5.1 List of Service Properties The following table lists properties relevant for the MPCC API. These properties are additional to the properties of the GCC, from which the MPCC is an extension. Property Type Description P_MAX_CALLLEGS_PER_CALL INTEGER_SET Indicates how many parties can be in one call. P_UI_CALLLEG_BASED BOOLEAN_SET Value = TRUE : User interaction can be performed on leg level and a reference to a CallLeg object can be used in the IpUIManager.createUICall() operation. Value = FALSE : No user interaction on leg level is supported. P_ROUTING_WITH_CALLLEG_OPERATIONS BOOLEAN_SET Value = TRUE : the atomic operations for routing a CallLeg are supported {IpMultiPartyCall.createCallLeg(), IpCallLeg.eventReportReq(), IpCallLeg.routeReq(), IpCallLeg.attachMediaReq()} Value = FALSE : the convenience function has to be used for routing a CallLeg. P_MEDIA_ATTACH_EXPLICIT BOOLEAN_SET Value = TRUE : the CallLeg shall be explicitly attached to a Call. Value = FALSE : the CallLeg is automatically attached to a Call, no IpCallLeg.attachMediaReq() is needed when a party answers. 7.5.2 Service Property values for the CAMEL Service Environment. Implementations of the MultiParty Call Control API relying on the CSE of CAMEL phase 3 shall have the Service Properties outlined above set to the indicated values : P_OPERATION_SET = { β€œIpMultiPartyCallControlManager.createNotification”, β€œIpMultiPartyCallControlManager.destroyNotification”, β€œIpMultiPartyCallControlManager.changeNotification”, β€œIpMultiPartyCallControlManager.getNotification”, β€œIpMultiPartyCallControlManager.setCallLoadControl” β€œIpMultiPartyCall.getCallLegs”, β€œIpMultiPartyCall.createCallLeg”, β€œIpMultiPartyCall.createAndRouteCallLegReq”, β€œIpMultiPartyCall.release”, β€œIpMultiPartyCall.deassignCall”, β€œIpMultiPartyCall.getInfoReq”, β€œIpMultiPartyCall.setChargePlan”, β€œIpMultiPartyCall.setAdviceOfCharge”, β€œIpMultiPartyCall.superviseReq”, β€œIpCallLeg.routeReq”, β€œIpCallLeg.eventReportReq”, β€œIpCallLeg.release”, β€œIpCallLeg.getInfoReq”, β€œIpCallLeg.getCall”, β€œIpCallLeg.continueProcessing” } P_TRIGGERING_EVENT_TYPES = { P_CALL_EVENT_ADDRESS_COLLECTED, P_CALL_EVENT_ADDRESS_ANALYSED, P_CALL_EVENT_ORIGINATING_RELEASE, P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED, P_CALL_EVENT_TERMINATING_RELEASE } Note: P_CALL_EVENT_ORIGINATING_RELEASE only for the routing failure case, TpReleaseCause = P_ROUTING_FAILURE P_DYNAMIC_EVENT_TYPES = { P_CALL_EVENT_ANSWER, P_CALL_EVENT_ORIGINATING_RELEASE, P_CALL_EVENT_TERMINATING_RELEASE } P_ADDRESS_PLAN = { P_ADDRESS_PLAN_E164 } P_UI_CALL_BASED = { TRUE } P_UI_AT_ALL_STAGES = { FALSE } P_MEDIA_TYPE = { P_AUDIO } P_MAX_CALLLEGS_PER_CALL = { 0, 2 } P_UI_CALLLEG_BASED = { FALSE } P_MEDIA_ATTACH_EXPLICIT = { FALSE } 7.6 Multi-Party Call Control Data Definitions This clause provides the MPCC data definitions necessary to support the API specification. The general format of a data definition specification is described below. β€’ Data Type This shows the name of the data type. β€’ Description This describes the data type. β€’ Tabular Specification This specifies the data types and values of the data type. β€’ Example If relevant, an example is shown to illustrate the data type. All data types referenced but not defined in this clause are either in the common call control data definitions clause of the present document (clause 8) or in the common data definitions which may be found in 3GPPΒ TSΒ 29.198-2. 7.6.1 Event Notification Data Definitions No specific event notification data defined. 7.6.2 Multi-Party Call Control Data Definitions 7.6.2.1 IpCallLeg Defines the address of an IpCallLeg Interface. 7.6.2.2 IpCallLegRef Defines a Reference to type IpCallLeg. 7.6.2.3 IpAppCallLeg Defines the address of an IpAppCallLeg Interface. 7.6.2.4 IpAppCallLegRef Defines a Reference to type IpAppCallLeg. 7.6.2.5 IpMultiPartyCall Defines the address of an IpMultiPartyCall Interface. 7.6.2.6 IpMultiPartyCallRef Defines a Reference to type IpMultiPartyCall. 7.6.2.7 IpAppMultiPartyCall Defines the address of an IpAppMultiPartyCall Interface. 7.6.2.8 IpAppMultiPartyCallRef Defines a Reference to type IpAppMultiPartyCall. 7.6.2.9 IpMultiPartyCallControlManager Defines the address of an IpMultiPartyCallControlManager Interface. 7.6.2.10 IpMultiPartyCallControlManagerRef Defines a Reference to type IpMultiPartyCallControlManager. 7.6.2.11 IpAppMultiPartyCallControlManager Defines the address of an IpAppMultiPartyCallControlManager Interface. 7.6.2.12 IpAppMultiPartyCallControlManagerRef Defines a Reference to type IpAppMultiPartyCallControlManager.. 7.6.2.13 TpAppCallLegRefSet Defines a Numbered Set of Data Elements of IpAppCallLegRef. 7.6.2.14 TpMultiPartyCallIdentifier Defines the Sequence of Data Elements that unambiguously specify the Call object Sequence Element Name Sequence Element Type Sequence Element Description CallReference IpMultiPartyCallRef This element specifies the interface reference for the Multi-party call object. CallSessionID TpSessionID This element specifies the call session ID. 7.6.2.15 TpAppMultiPartyCallBack Defines the Tagged Choice of Data Elements that references the application callback interfaces Tag Element Type TpAppMultiPartyCallBackRefType Tag Element Value Choice Element Type Choice Element Name P_APP_CALLBACK_UNDEFINED NULL Undefined P_APP_MULTIPARTY_CALL_CALLBACK IpAppMultiPartyCallRef AppMultiPartyCall P_APP_CALL_LEG_CALLBACK IpAppCallLegRef AppCallLeg P_APP_CALL_AND_CALL_LEG_CALLBACK TpAppCallLegCallBack AppMultiPartyCallAndCallLeg 7.6.2.16 TpAppMultiPartyCallBackRefType Defines the type application call back interface. Name Value Description P_APP_CALLBACK_UNDEFINED 0 Application Call back interface undefined P_APP_MULTIPARTY_CALL_CALLBACK 1 Application Multi-Party Call interface referenced P_APP_CALL_LEG_CALLBACK 2 Application CallLeg interface referenced P_APP_CALL_AND_CALL_LEG_CALLBACK 3 Application Multi-Party Call and CallLeg interface referenced 7.6.2.17 TpAppCallLegCallBack Defines the Sequence of Data Elements that references a call and a call leg application interface. Sequence Element Name Sequence Element Type AppMultiPartyCall IpAppMultiPartyCallRef AppCallLegSet TpAppCallLegRefSet Specifies the set of all call leg call back references. First in the set is the reference to the call back of the originating callLeg. In case there is a call back to a destination call leg this will be second in the set. 7.6.2.18 TpMultiPartyCallIdentifierSet Defines a Numbered Set of Data Elements of TpMultiPartyCallIdentifier. 7.6.2.19 TpCallAppInfo Defines the Tagged Choice of Data Elements that specify application-related call information. Tag Element Type TpCallAppInfoType Tag Element Value Choice Element Type Choice Element Name P_CALL_APP_ALERTING_MECHANISM TpCallAlertingMechanism CallAppAlertingMechanism P_CALL_APP_NETWORK_ACCESS_TYPE TpCallNetworkAccessType CallAppNetworkAccessType P_CALL_APP_TELE_SERVICE TpCallTeleService CallAppTeleService P_CALL_APP_BEARER_SERVICE TpCallBearerService CallAppBearerService P_CALL_APP_PARTY_CATEGORY TpCallPartyCategory CallAppPartyCategory P_CALL_APP_PRESENTATION_ADDRESS TpAddress CallAppPresentationAddress P_CALL_APP_GENERIC_INFO TpString CallAppGenericInfo P_CALL_APP_ADDITIONAL_ADDRESS TpAddress CallAppAdditionalAddress P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS TpAddress CallAppOriginalDestinationAddress P_CALL_APP_REDIRECTING_ADDRESS TpAddress CallAppRedirectingAddress 7.6.2.20 TpCallAppInfoType Defines the type of call application-related specific information. Name Value Description P_CALL_APP_UNDEFINED 0 Undefined P_CALL_APP_ALERTING_MECHANISM 1 The alerting mechanism or pattern to use P_CALL_APP_NETWORK_ACCESS_TYPE 2 The network access type (e.g. ISDN) P_CALL_APP_TELE_SERVICE 3 Indicates the tele-service (e.g. telephony) P_CALL_APP_BEARER_SERVICE 4 Indicates the bearer service (e.g. 64 kbit/s unrestricted data). P_CALL_APP_PARTY_CATEGORY 5 The category of the calling party P_CALL_APP_PRESENTATION_ADDRESS 6 The address to be presented to other call parties P_CALL_APP_GENERIC_INFO 7 Carries unspecified service-service information P_CALL_APP_ADDITIONAL_ADDRESS 8 Indicates an additional address P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS 9 Contains the original address specified by the originating user when launching the call. P_CALL_APP_REDIRECTING_ADDRESS 10 Contains the address of the user from which the call is diverting. 7.6.2.21 TpCallAppInfoSet Defines a Numbered Set of Data Elements of TpCallAppInfo. 7.6.2.22 TpCallEventRequest Defines the Sequence of Data Elements that specify the criteria relating to call report requests. Sequence Element Name Sequence Element Type CallEventType TpCallEventType AdditionalCallEventCriteria TpAdditionalCallEventCriteria CallMonitorMode TpCallMonitorMode 7.6.2.23 TpCallEventRequestSet Defines a Numbered Set of Data Elements of TpCallEventRequest. 7.6.2.24 TpCallEventType Defines a specific call event report type. Name Value Description P_CALL_EVENT_UNDEFINED 0 Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT 1 An originating call attempt takes place (e.g. Off-hook event). P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED 2 An originating call attempt is authorised P_CALL_EVENT_ADDRESS_COLLECTED 3 The destination address has been collected. P_CALL_EVENT_ADDRESS_ANALYSED 4 The destination address has been analysed. P_CALL_EVENT_ORIGINATING_SERVICE_CODE 5 Mid-call originating service code received. P_CALL_EVENT_ORIGINATING_RELEASE 6 A originating call/call leg is released P_CALL_EVENT_TERMINATING_CALL_ATTEMPT 7 A terminating call attempt takes place P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED 8 A terminating call is authorized P_CALL_EVENT_ALERTING 9 Call is alerting at the call party. P_CALL_EVENT_ANSWER 10 Call answered at address. P_CALL_EVENT_TERMINATING_RELEASE 11 A terminating call leg has been released or the call could not be routed. P_CALL_EVENT_REDIRECTED 12 Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this). P_CALL_EVENT_TERMINATING_SERVICE_CODE 13 Mid call terminating service code received. P_CALL_EVENT_QUEUED 14 The Call Event has been queued. (no events are disarmed as a result of this) EVENT HANDLING RULES: The following general event handling rules apply to dynamically armed events: When requesting events for one leg; β€’ When the monitor mode is set to P_CALL_MONITOR_MODE_DO_NOT_MONITOR all events armed for that eventtype are disarmed. The additionalEventCriteria are not taken into account. β€’ When requesting two events for the same event type with different criteria and/or different monitor mode the last used criteria and monitor mode apply. β€’ Events that are not applicable to a leg are refused with exception P_INVALID_EVENT_TYPE. The same exception is used when criteria are used that are not applicable to the leg, E.g., requesting P_CALL_EVENT_TERMINATING_SERVICE_CODE on an originating leg is refused with exception P_INVALID_CRITERIA. When P_CALL_EVENT_ORIGINATING_RELEASE is requested with P_BUSY in the criteria the request is refused with the same exception. When receiving events: β€’ If an armed event is met, then it is disarmed, unless explicit stated that it will not to be disarmed. β€’ If an event is met that causes the release of the related leg, then all events related to that leg are disarmed . β€’ When an event is met on a call leg irrespective of the event monitor mode, then only events belonging to that call leg may become disarmed (see table below) . β€’ If a call is released, then all events related to that call are disarmed. NOTE 1: Event disarmed means monitor mode is set to DO_NOT_MONITOR. and event armed means monitor mode is set to INTERRUPT or NOTIFY.. The table below defines the disarming rules for dynamic events. In case such an event occurs on a call leg the table shows which events are disarmed (are not monitored anymore) on that call leg and should be re-armed by eventReportReq() in case the application is still interested in these events. Event Occurred Events Disarmed P_CALL_EVENT_UNDEFINED Not Applicable P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT Not applicable, can only be armed as trigger P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_ANALYSED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_ANALYSED P_CALL_EVENT_ALERTING P_CALL_EVENT_ALERTING P_CALL_EVENT_TERMINATING_RELEASE with criteria: P_USER_NOT_AVAILABLE P_BUSY P_NOT_REACHABLE P_ROUTING_FAILURE P_CALL_RESTRICTED P_UNAVAILABLE_RESOURCES P_CALL_EVENT_ANSWER P_CALL_EVENT_ALERTING P_CALL_EVENT_ANSWER P_CALL_EVENT_TERMINATING_RELEASE with criteria: P_USER_NOT_AVAILABLE P_BUSY P_NOT_REACHABLE P_ROUTING_FAILURE P_CALL_RESTRICTED P_UNAVAILABLE_RESOURCES P_NO_ANSWER P_CALL_EVENT_ORIGINATING_RELEASE All pending network events for the call leg are disarmed P_CALL_EVENT_TERMINATING_RELEASE All pending network events for the call leg are disarmed P_CALL_EVENT_ORIGINATING_SERVICE_CODE P_CALL_EVENT_ORIGINATING_SERVICE_CODE *) see NOTE 2 P_CALL_EVENT_TERMINATING_SERVICE_CODE P_CALL_EVENT_TERMINATING_SERVICE_CODE *) see NOTE 2 NOTE 2: Only the detected service code or the range to which the service code belongs is disarmed. 7.6.2.25 TpAdditionalCallEventCriteria Defines the Tagged Choice of Data Elements that specify specific criteria. Tag Element Type TpCallEventType Tag Element Value Choice Element Type Choice Element Name P_CALL_EVENT_UNDEFINED NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ADDRESS_COLLECTED TpInt32 MinAddressLength P_CALL_EVENT_ADDRESS_ANALYSED NULL Undefined P_CALL_EVENT_ORIGINATING_SERVICE_CODE TpCallServiceCodeSet OriginatingServiceCode P_CALL_EVENT_ORIGINATING_RELEASE TpReleaseCauseSet OriginatingReleaseCauseSet P_CALL_EVENT_TERMINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ALERTING NULL Undefined P_CALL_EVENT_ANSWER NULL Undefined P_CALL_EVENT_TERMINATING_RELEASE TpReleaseCauseSet TerminatingReleaseCauseSet P_CALL_EVENT_REDIRECTED NULL Undefined P_CALL_EVENT_TERMINATING_SERVICE_CODE TpCallServiceCodeSet TerminatingServiceCode P_CALL_EVENT_QUEUED NULL Undefined 7.6.2.26 TpCallEventInfo Defines the Sequence of Data Elements that specify the event report specific information. Sequence Element Name Sequence Element Type CallEventType TpCallEventType AdditionalCallEventInfo TpCallAdditionalEventInfo CallMonitorMode TpCallMonitorMode CallEventTime TpDateAndTime 7.6.2.27 TpCallAdditionalEventInfo Defines the Tagged Choice of Data Elements that specify additional call event information for certain types of events. Tag Element Type TpCallEventType Tag Element Value Choice Element Type Choice Element Name P_CALL_EVENT_UNDEFINED NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ADDRESS_COLLECTED TpAddress CollectedAddress P_CALL_EVENT_ADDRESS_ANALYSED TpAddress CalledAddress P_CALL_EVENT_ORIGINATING_SERVICE_CODE TpCallServiceCode OriginatingServiceCode P_CALL_EVENT_ORIGINATING_RELEASE TpReleaseCause OriginatingReleaseCause P_CALL_EVENT_TERMINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ALERTING NULL Undefined P_CALL_EVENT_ANSWER NULL Undefined P_CALL_EVENT_TERMINATING_RELEASE TpReleaseCause TerminatingReleaseCause P_CALL_EVENT_REDIRECTED TpAddress ForwardAddress P_CALL_EVENT_TERMINATING_SERVICE_CODE TpCallServiceCode TerminatingServiceCode P_CALL_EVENT_QUEUED NULL Undefined 7.6.2.28 TpCallNotificationRequest Defines the Sequence of Data Elements that specify the criteria for an event notification Sequence Element Name Sequence Element Type Description CallNotificationScope TpCallNotificationScope Defines the scope of the notification request. CallEventsRequested TpCallEventRequestSet Defines the events which are requested 7.6.2.29 TpCallNotificationScope Defines a the sequence of Data elements that specify the scope of a notification request. Of the addresses only the Plan and the AddrString are used for the purpose of matching the notifications against the criteria. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddressRange Defines the destination address or address range for which the notification is requested. OriginatingAddress TpAddressRange Defines the origination address or address range for which the notification is requested. 7.6.2.30 TpCallNotificationInfo Defines the Sequence of Data Elements that specify the information returned to the application in a Call notification report. Sequence Element Name Sequence Element Type Description CallNotificationReportScope TpCallNotificationReportScope Defines the scope of the notification report. CallAppInfo TpCallAppInfoSet Contains additional call info. CallEventInfo TpCallEventInfo Contains the event which is reported. 7.6.2.31 TpCallNotificationReportScope Defines the Sequence of Data Elements that specify the scope for which a notification report was sent. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddress Contains the destination address of the call. OriginatingAddress TpAddress Contains the origination address of the call 7.6.2.32 TpNotificationRequested Defines the Sequence of Data Elements that specify the criteria relating to event requests. Sequence Element Name Sequence Element Type AppCallNotificationRequest TpCallNotificationRequest AssignmentID TpInt32 7.6.2.33 TpNotificationRequestedSet Defines a numbered Set of Data Elements of TpNotificationRequested. 7.6.2.34 TpReleaseCause Defines the reason for which a call is released. Name Value Description P_UNDEFINED 0 The reason of release is not known, because no info was received from the network. P_USER_NOT_AVAILABLE 1 The user is not available in the network. This means that the number is not allocated or that the user is not registered. P_BUSY 2 The user is busy. P_NO_ANSWER 3 No answer was received P_NOT_REACHABLE 4 The user terminal is not reachable P_ROUTING_FAILURE 5 A routing failure occurred. For example an invalid address was received P_PREMATURE_DISCONNECT 6 The user disconnected the call / call leg during the setup phase. P_DISCONNECTED 7 A disconnect was received. P_CALL_RESTRICTED 8 The call was subject of restrictions P_UNAVAILABLE_RESOURCE 9 The request could not be carried out as no resources were available. P_GENERAL_FAILURE 10 A general network failure occurred. P_TIMER_EXPIRY 11 The call / call leg was released because an activity timer expired. 7.6.2.35 TpReleaseCauseSet Defines a Numbered Set of Data Elements of TpReleaseCause. 7.6.2.36 TpCallLegIdentifier Defines the Sequence of Data Elements that unambiguously specify the Call Leg object. Sequence Element Name Sequence Element Type Sequence Element Description CallLegReference IpCallLegRef This element specifies the interface reference for the callLeg object. CallLegSessionID TpSessionID This element specifies the callLeg session ID. 7.6.2.37 TpCallLegIdentifierSet Defines a Numbered Set of Data Elements of TpCallLegIdentifier. 7.6.2.38 TpCallLegAttachMechanism Defines how a CallLeg should be attached to the call. Name Value Description P_CALLLEG_ATTACH_IMPLICITLY 0 CallLeg should be attached implicitly to the call. P_CALLLEG_ATTACH_EXPLICITLY 1 CallLeg should be attached explicitly to the call by using the attachMediaReq() operation. This allows e.g. the application to do first user interaction to the party before he/she is placed in the call. 7.6.2.39 TpCallLegConnectionProperties Defines the Sequence of Data Elements that specify the connection properties of the Call Leg object Sequence Element Name Sequence Element Type Sequence Element Description AttachMechanism TpCallLegAttachMechanism Defines how a CallLeg should be attached to the call. 7.6.2.40 TpCallLegInfoReport Defines the Sequence of Data Elements that specify the call leg information requested. Sequence Element Name Sequence Element Type Description CallLegInfoType TpCallLegInfoType The type of call leg information. CallLegStartTime TpDateAndTime The time and date when the call leg was started (i.e. the leg was routed). CallLegConnectedToResourceTime TpDateAndTime The date and time when the call leg was connected to the resource. If no resource was connected the time is set to an empty string. Either this element is valid or the CallConnectedToAddressTime is valid, depending on whether the report is sent as a result of user interaction. CallLegConnectedToAddressTime TpDateAndTime The date and time when the call leg was connected to the destination (i.e. when the destination answered the call). If the destination did not answer, the time is set to an empty string. Either this element is valid or the CallConnectedToResourceTime is valid, depending on whether the report is sent as a result of user interaction. CallLegEndTime TpDateAndTime The date and time when the call leg was released. ConnectedAddress TpAddress The address of the party associated with the leg. If during the call the connected address was received from the party then this is returned, otherwise the destination address (for legs connected to a destination) or the originating address (for legs connected to the origination) is returned. CallLegReleaseCause TpReleaseCause The cause of the termination. May be present with P_CALL_LEG_INFO_RELEASE_CAUSE was specified. CallAppInfo TpCallAppInfoSet Additional information for the leg. May be present with P_CALL_LEG_INFO_APPINFO was specified. 7.6.2.41 TpCallLegInfoType Defines the type of call leg information requested and reported. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_LEG_INFO_UNDEFINED 00h Undefined P_CALL_LEG_INFO_TIMES 01h Relevant call times P_CALL_LEG_INFO_RELEASE_CAUSE 02h Call leg release cause P_CALL_LEG_INFO_ADDRESS 04h Call leg connected address P_CALL_LEG_INFO_APPINFO 08h Call leg application related information 7.6.2.42 TpCallLegSuperviseTreatment Defines the treatment of the call leg by the call control service when the call leg supervision timer expires. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_LEG_SUPERVISE_RELEASE 01h Release the call leg when the call leg supervision timer expires P_CALL_LEG_SUPERVISE_RESPOND 02h Notify the application when the call leg supervision timer expires P_CALL_LEG_SUPERVISE_APPLY_TONE 04h Send a warning tone on the call leg when the call leg supervision timer expires. If call leg release is requested, then the call leg will be released following the tone after an administered time period 8 Common Call Control Data Types The following data types referenced in this clause are defined in 3GPPΒ TSΒ 29.198-5: TpUIInfo All other data types referenced but not defined in this clause are common data definitions which may be found in 3GPPΒ TSΒ 29.198-2. 8.1 TpCallAlertingMechanism This data type is identical to a TpInt32, and defines the mechanism that will be used to alert a call party. The values of this data type are operator specific. 8.2 TpCallBearerService This data type defines the type of call application-related specific information (Q.931: Information Transfer Capability, and 3G TS 22.002) Name Value Description P_CALL_BEARER_SERVICE_UNKNOWN 0 Bearer capability information unknown at this time P_CALL_BEARER_SERVICE_SPEECH 1 Speech P_CALL_BEARER_SERVICE_DIGITALUNRESTRICTED 2 Unrestricted digital information P_CALL_BEARER_SERVICE_DIGITALRESTRICTED 3 Restricted digital information P_CALL_BEARER_SERVICE_AUDIO 4 3,1 kHz audio P_CALL_BEARER_SERVICE_DIGITALUNRESTRICTEDTONES 5 Unrestricted digital information with tones/announcements P_CALL_BEARER_SERVICE_VIDEO 6 Video 8.3 TpCallChargePlan Defines the Sequence of Data Elements that specify the charge plan for the call. Sequence Element Name Sequence Element Type Description ChargeOrderType TpCallChargeOrderCategory Charge order TransparentCharge TpOctetSet Operator specific charge plan specification, e.g. charging table name / charging table entry. The associated charge plan data will be send transparently to the charging records. Only applicable when transparent charging is selected. ChargePlan TpInt32 Pre-defined charge plan. Example of the charge plan set from which the application can choose could be : (0 = normal user, 1 = silver card user, 2 = gold card user). Only applicable when predefined charge plan is selected. AdditionalInfo TpOctetSet Descriptive string which is sent to the billing system without prior evaluation. Could be included in the ticket. PartyToCharge TpCallPartyToChargeType Identifies the entity or party to be charged for the call or call leg. PartyToChargeAdditionalInfo TpCallPartyToChargeAdditionalInfo Contains additional information regarding the charged party. 8.4 TpCallPartyToChargeAdditionalInfo Defines the Tagged Choice of Data Elements that identifies the entity or party to be charged. Tag Element Type TpCallPartyToChargeType Tag Element Value Choice Element Type Choice Element Name P_CALL_PARTY_ORIGINATING NULL Undefined P_CALL_PARTY_DESTINATION NULL Undefined P_CALL_PARTY_SPECIAL TpAddress CallPartySpecial 8.5 TpCallPartyToChargeType Defines the type of call party to charge Name Value Description P_CALL_PARTY_ORIGINATING 0 Calling party, i.e. party that initiated the call. For application initiated calls this indicates the first party of the call P_CALL_PARTY_DESTINATION 1 Called party P_CALL_PARTY_SPECIAL 2 An address identifying e.g. a third party, a service provider 8.6 TpCallChargeOrderCategory Defines the type of charging to be applied Name Value Description P_CALL_CHARGE_TRANSPARENT 0 Operator specific charge plan specification, e.g. charging table name / charging table entry. The associated charge plan data will be send transparently to the charging records P_CALL_CHARGE_PREDEFINED_SET 1 Pre-defined charge plan. Example of the charge plan set from which the application can choose could be : (0 = normal user, 1 = silver card user, 2 = gold card user). 8.7 TpCallEndedReport Defines the Sequence of Data Elements that specify the reason for the call ending. Sequence Element Name Sequence Element Type Description CallLegSessionID TpSessionID The leg that initiated the release of the call. If the call release was not initiated by the leg, then this value is set to –1. Cause TpReleaseCause The cause of the call ending. 8.8 TpCallError Defines the Sequence of Data Elements that specify the additional information relating to a call error. Sequence Element Name Sequence Element Type ErrorTime TpDateAndTime ErrorType TpCallErrorType AdditionalErrorInfo TpCallAdditionalErrorInfo 8.9 TpCallAdditionalErrorInfo Defines the Tagged Choice of Data Elements that specify additional call error and call error specific information. This is also used to specify call leg errors and information errors. Tag Element Type TpCallErrorType Tag Element Value Choice Element Type Choice Element Name P_CALL_ERROR_UNDEFINED NULL Undefined P_CALL_ERROR_INVALID_ADDRESS TpAddressError CallErrorInvalidAddress P_CALL_ERROR_INVALID_STATE NULL Undefined P_CALL_ERROR_RESOURCE_UNAVAILABLE NULL Undefined 8.10 TpCallErrorType Defines a specific call error. Name Value Description P_CALL_ERROR_UNDEFINED 0 Undefined; the method failed or was refused, but no specific reason can be given. P_CALL_ERROR_INVALID_ADDRESS 1 The operation failed because an invalid address was given P_CALL_ERROR_INVALID_STATE 2 The call was not in a valid state for the requested operation P_CALL_ERROR_RESOURCE_UNAVAILABLE 3 There are not enough resources to complete the request successfully 8.11 TpCallInfoReport Defines the Sequence of Data Elements that specify the call information requested. Information that was not requested is invalid. Sequence Element Name Sequence Element Type Description CallInfoType TpCallInfoType The type of call report. CallInitiationStartTime TpDateAndTime The time and date when the call, or follow-on call, was started. CallConnectedToResourceTime TpDateAndTime The date and time when the call was connected to the resource. This data element is only valid when information on user interaction is reported. CallConnectedToDestinationTime TpDateAndTime The date and time when the call was connected to the destination (i.e., when the destination answered the call). If the destination did not answer, the time is set to an empty string. This data element is invalid when information on user interaction is reported with an intermediate report. CallEndTime TpDateAndTime The date and time when the call or follow-on call or user interaction was terminated. Cause TpReleaseCause The cause of the termination. A callInfoReport will be generated at the end of user interaction and at the end of the connection with the associated address. This means that either the destination related information is present or the resource related information, but not both. 8.12 TpCallInfoType Defines the type of call information requested and reported. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_INFO_UNDEFINED 00h Undefined P_CALL_INFO_TIMES 01h Relevant call times P_CALL_INFO_RELEASE_CAUSE 02h Call release cause 8.13 TpCallLoadControlMechanism Defines the Tagged Choice of Data Elements that specify the applied mechanism and associated parameters. Tag Element Type TpCallLoadControlMechanismType Tag Element Value Choice Element Type Choice Element Name P_CALL_LOAD_CONTROL_PER_INTERVAL TpCallLoadControlIntervalRate CallLoadControlPerInterval 8.14 TpCallLoadControlIntervalRate Defines the call admission rate of the call load control mechanism used. This data type indicates the interval (in milliseconds) between calls that are admitted. Name Value Description P_CALL_LOAD_CONTROL_ADMIT_NO_CALLS 0 Infinite interval (do not admit any calls) 1 - 60000 Duration in milliseconds 8.15 TpCallLoadControlMechanismType Defines the type of call load control mechanism to use. Name Value Description P_CALL_LOAD_CONTROL_PER_INTERVAL 0 admit one call per interval 8.16 TpCallMonitorMode Defines the mode that the call will monitor for events, or the mode that the call is in following a detected event. Name Value Description P_CALL_MONITOR_MODE_INTERRUPT 0 The call event is intercepted by the call control service and call processing is interrupted. The application is notified of the event and call processing resumes following an appropriate API call or network event (such as a call release) P_CALL_MONITOR_MODE_NOTIFY 1 The call event is detected by the call control service but not intercepted. The application is notified of the event and call processing continues P_CALL_MONITOR_MODE_DO_NOT_MONITOR 2 Do not monitor for the event 8.17 TpCallNetworkAccessType This data defines the bearer capabilities associated with the call. (3G TS 24.002) This information is network operator specific and may not always be available because there is no standard protocol to retrieve the information. Name Value Description P_CALL_NETWORK_ACCESS_TYPE_UNKNOWN 0 Network type information unknown at this time P_CALL_NETWORK_ACCESS_TYPE_POT 1 POTS P_CALL_NETWORK_ACCESS_TYPE_ISDN 2 ISDN P_CALL_NETWORK_ACCESS_TYPE_DIALUPINTERNET 3 Dial-up Internet P_CALL_NETWORK_ACCESS_TYPE_XDSL 4 xDSL P_CALL_NETWORK_ACCESS_TYPE_WIRELESS 5 Wireless 8.18 TpCallPartyCategory This data type defines the category of a calling party. (Q.763: Calling Party Category / Called Party Category) Name Value Description P_CALL_PARTY_CATEGORY_UNKNOWN 0 calling party's category unknown at this time P_CALL_PARTY_CATEGORY_OPERATOR_F 1 operator, language French P_CALL_PARTY_CATEGORY_OPERATOR_E 2 operator, language English P_CALL_PARTY_CATEGORY_OPERATOR_G 3 operator, language German P_CALL_PARTY_CATEGORY_OPERATOR_R 4 operator, language Russian P_CALL_PARTY_CATEGORY_OPERATOR_S 5 operator, language Spanish P_CALL_PARTY_CATEGORY_ORDINARY_SUB 6 ordinary calling subscriber P_CALL_PARTY_CATEGORY_PRIORITY_SUB 7 calling subscriber with priority P_CALL_PARTY_CATEGORY_DATA_CALL 8 data call (voice band data) P_CALL_PARTY_CATEGORY_TEST_CALL 9 test call P_CALL_PARTY_CATEGORY_PAYPHONE 10 payphone 8.19 TpCallServiceCode Defines the Sequence of Data Elements that specify the service code and type of service code received during a call. The service code type defines how the value string should be interpreted. Sequence Element Name Sequence Element Type CallServiceCodeType TpCallServiceCodeType ServiceCodeValue TpString 8.20 TpCallServiceCodeSet Defines a Numbered Set of Data Elements of TpCallServiceCode. 8.21 TpCallServiceCodeType Defines the different types of service codes that can be received during the call. Name Value Description P_CALL_SERVICE_CODE_UNDEFINED 0 The type of service code is unknown. The corresponding string is operator specific. P_CALL_SERVICE_CODE_DIGITS 1 The user entered a digit sequence during the call. The corresponding string is an ASCII representation of the received digits. P_CALL_SERVICE_CODE_FACILITY 2 A facility information element is received. The corresponding string contains the facility information element as defined in ITU Q.932 P_CALL_SERVICE_CODE_U2U 3 A user-to-user message was received. The associated string contains the content of the user-to-user information element. P_CALL_SERVICE_CODE_HOOKFLASH 4 The user performed a hookflash, optionally followed by some digits. The corresponding string is an ASCII representation of the entered digits. P_CALL_SERVICE_CODE_RECALL 5 The user pressed the register recall button, optionally followed by some digits. The corresponding string is an ASCII representation of the entered digits. 8.22 TpCallSuperviseReport Defines the responses from the call control service for calls that are supervised. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_SUPERVISE_TIMEOUT 01h The call supervision timer has expired P_CALL_SUPERVISE_CALL_ENDED 02h The call has ended, either due to timer expiry or call party release. In case the called party disconnects but a follow-on call can still be made also this indication is used. P_CALL_SUPERVISE_TONE_APPLIED 04h A warning tone has been applied. This is only sent in combination with P_CALL_SUPERVISE_TIMEOUT P_CALL_SUPERVISE_UI_FINISHED 08h The user interaction has finished. 8.23 TpCallSuperviseTreatment Defines the treatment of the call by the call control service when the call supervision timer expires. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_SUPERVISE_RELEASE 01h Release the call when the call supervision timer expires P_CALL_SUPERVISE_RESPOND 02h Notify the application when the call supervision timer expires P_CALL_SUPERVISE_APPLY_TONE 04h Send a warning tone to the originating party when the call supervision timer expires. If call release is requested, then the call will be released following the tone after an administered time period 8.24 TpCallTeleService This data type defines the tele-service associated with the call. (Q.763: User Teleservice Information, Q.931: High Layer Compatibility Information, and 3G TS 22.003) Name Value Description P_CALL_TELE_SERVICE_UNKNOWN 0 Teleservice information unknown at this time P_CALL_TELE_SERVICE_TELEPHONY 1 Telephony P_CALL_TELE_SERVICE_FAX_2_3 2 Facsimile Group 2/3 P_CALL_TELE_SERVICE_FAX_4_I 3 Facsimile Group 4, Class I P_CALL_TELE_SERVICE_FAX_4_II_III 4 Facsimile Group 4, Classes II and III P_CALL_TELE_SERVICE_VIDEOTEX_SYN 5 Syntax based Videotex P_CALL_TELE_SERVICE_VIDEOTEX_INT 6 International Videotex interworking via gateways or interworking units P_CALL_TELE_SERVICE_TELEX 7 Telex service P_CALL_TELE_SERVICE_MHS 8 Message Handling Systems P_CALL_TELE_SERVICE_OSI 9 OSI application P_CALL_TELE_SERVICE_FTAM 10 FTAM application P_CALL_TELE_SERVICE_VIDEO 11 Videotelephony P_CALL_TELE_SERVICE_VIDEO_CONF 12 Videoconferencing P_CALL_TELE_SERVICE_AUDIOGRAPH_CONF 13 Audiographic conferencing P_CALL_TELE_SERVICE_MULTIMEDIA 14 Multimedia services P_CALL_TELE_SERVICE_CS_INI_H221 15 Capability set of initial channel of H.221 P_CALL_TELE_SERVICE_CS_SUB_H221 16 Capability set of subsequent channel of H.221 P_CALL_TELE_SERVICE_CS_INI_CALL 17 Capability set of initial channel associated with an active 3,1 kHz audio or speech call. P_CALL_TELE_SERVICE_DATATRAFFIC 18 Data traffic. P_CALL_TELE_SERVICE_EMERGENCY_CALLS 19 Emergency Calls P_CALL_TELE_SERVICE_SMS_MT_PP 20 Short message MT/PP P_CALL_TELE_SERVICE_SMS_MO_PP 21 Short message MO/PP P_CALL_TELE_SERVICE_CELL_BROADCAST 22 Cell Broadcast Service P_CALL_TELE_SERVICE_ALT_SPEECH_FAX_3 23 Alternate speech and facsimile group 3 P_CALL_TELE_SERVICE_AUTOMATIC_FAX_3 24 Automatic Facsimile group 3 P_CALL_TELE_SERVICE_VOICE_GROUP_CALL 25 Voice Group Call Service P_CALL_TELE_SERVICE_VOICE_BROADCAST 26 Voice Broadcast Service 8.25 TpCallTreatment Defines the Sequence of Data Elements that specify the treatment for calls that will be handled only by the network (for example, call which are not admitted by the call load control mechanism). Sequence Element Name Sequence Element Type CallTreatmentType TpCallTreatmentType ReleaseCause TpReleaseCause AdditionalTreatmentInfo TpCallAdditionalTreatmentInfo 8.26 TpCallTreatmentType Defines the treatment for calls that will be handled only by the network. Name Value Description P_CALL_TREATMENT_DEFAULT 0 Default treatment P_CALL_TREATMENT_RELEASE 1 Release the call P_CALL_TREATMENT_SIAR 2 Send information to the user, and release the call (Send Info & Release) 8.27 TpCallAdditionalTreatmentInfo Defines the Tagged Choice of Data Elements that specify the information to be sent to a call party. Tag Element Type TpCallTreatmentType Tag Element Value Choice Element Type Choice Element Name P_CALL_TREATMENT_DEFAULT NULL Undefined P_CALL_TREATMENT_RELEASE NULL Undefined P_CALL_TREATMENT_SIAR TpUIInfo InformationToSend 8.28 TpMediaType Defines the media type of a media stream. The values may be combined by a logical 'OR' function. Name Value Description P_AUDIO 1 Audio stream P_VIDEO 2 Video stream P_DATA 4 Data stream (e.g., T.120) Annex A (normative): OMG IDL Description of Call Control SCF The OMG IDL representation of this interface specification is contained in text files (contained in archive 2919804V4b0IDL.ZIP) which accompany the present document. Annex B (informative): Change history Change history Date TSGΒ # TSG Doc. CR Rev Subject/Comment Old New Mar 2001 CN_11 NP-010134 047 - CR 29.198: for moving TS 29.198 from R99 to Rel 4 (N5-010158) 3.2.0 1.0.0 June 2001 CN_12 NP-010327 -- -- Approved at TSG CN#12 and placed under Change Control 2.0.0 4.0.0 Sep 2001 CN_13 NP-010467 001 -- Changing references to JAIN 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 002 -- Correction of text descriptions for methods enableCallNotification and createNotification 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 003 -- Specify the behaviour when a call leg times out 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 004 -- Removal of Faulty state in MPCCS Call State Transition Diagram and method callFaultDetected in MPCCS in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 005 -- Missing TpCallAppInfoSet description in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 006 -- Redirecting a call leg vs. creating a call leg clarification in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 007 -- Introduction of MPCC Originating and Terminating Call Leg STDs for IpCallLeg 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 008 -- Corrections to SetChargePlan() Addition of PartyToCharge parmeter 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 009 -- Corrections to SetChargePlan() 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 010 -- Remove distinction between final- and intermediate-report 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 011 -- Inclusion of TpMediaType 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 012 -- Corrections to GCC STD 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 013 -- Introduction of sequence diagrams for MPCC services 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 014 -- The use of the REDIRECT event needs to be illustrated 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 015 -- Corrections to SetCallChargePlan() 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 016 -- Add one additional error indication 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 017 -- Corrections to Call Control – GCCS Exception handling 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 018 -- Corrections to Call Control – Errors in Exceptions 4.0.0 4.1.0 Dec 2001 CN_14 NP-010597 019 -- Replace Out Parameters with Return Types 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 020 -- Removal of time based charging property 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 021 -- Make attachMedia() and detachMedia() asynchronous 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 022 -- Correction of treatment datatype in superviseReq on call leg 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 023 -- Corrections to Call Control Data Types 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 024 -- Correction to Call Control (CC) 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 025 -- Amend the Generic Call Control introductory part 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 026 -- Correction in TpCallEventType 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 027 -- Addition of missing description of RouteErr() 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 028 -- Misleading description of createAndRouteCallLegErr() 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 029 -- Correction to values of TpCallNotificationType, TpCallLoadControlMechanismType 4.1.0 4.2.0 Dec 2001 CN_14 NP-010695 030 -- Correction of method getLastRedirectionAddress 4.1.0 4.2.0 Mar 2002 CN_15 NP-020106 031 -- Add P_INVALID_INTERFACE_TYPE exception to IpService.setCallback() and IpService.setCallbackWithSessionID() 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 032 -- Correction of Event Subscription/Notification Data Type 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 033 -- Correction of parameter name in IpCallLeg.routeReq() and in IpCallLeg.setAdviceOfCharge() 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 034 -- Clarification of ambiguous Event handling rules 4.2.0 4.3.0 Jun 2002 CN_16 NP-020180 035 -- Correction to TpCallChargePlan 4.3.0 4.4.0 Jun 2002 CN_16 NP-020180 036 -- Correction to CAMEL Service Property values 4.3.0 4.4.0 Sep 2002 CN_17 NP-020424 057 -- Correction on use of NULL in Call Control API 4.4.0 4.5.0 Mar 2003 CN_19 NP-030020 058 -- Correction of status of methods to interfaces in clause 6.3 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 059 -- Correction to TpReleaseCauseSet in Multi Party Call Control 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 060 -- Correction to Sequence Diagrams to remove incorrect Framework references 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 061 -- Correction to User Interaction Prepaid Sequence Diagrams 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 062 -- Correction to remove unused TpCallChargeOrder 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 063 -- Correction to TpCallEventCriteriaResult in Generic Call Control 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 064 -- Correction of status of methods to interfaces in clause 7.3 4.5.0 4.6.0 Jun 2003 CN_20 NP-030238 065 -- Correction of the description for callEventNotify & reportNotification 4.6.0 4.7.0 Dec 2003 CN_22 NP-030544 066 -- Correction of description in superviseRes and superviseCallRes 4.7.0 4.8.0 Jun 2004 CN_24 NP-040255 067 -- Correction of continueProcessing method for Generic Call Control Service (GCCS) 4.8.0 4.9.0 Jun 2004 CN_24 NP-040256 068 -- Correct the P_TRIGGERING_ADDRESSES service property 4.8.0 4.9.0 Jun 2004 CN_24 NP-040257 069 -- Correction of callbacks sequence and timing conditions in GCCS and MPCCS 4.8.0 4.9.0 Sep 2004 CN_25 NP-040352 070 -- Correct State Transition Diagram for IpCall 4.9.0 4.10.0 Dec 2004 CN_25 NP-040483 071 -- Correct Behaviour of CallBack sequence and timing 4.10.0 4.11.0
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
1 Scope
The present document deals with the procedures allowing the technical realization of the real time end‑to‑end facsimile groupΒ 3 service within the GSM PLMN using non‑transparent network support according to the definition of the Teleservices 61 and 62 specified in GSMΒ 02.03. Within the present document particular attention is given to Teleservice "Alternate speech/facsimile groupΒ 3" (TeleserviceΒ 61). However, the definitions apply also to Teleservice "Automatic facsimile groupΒ 3" (TeleserviceΒ 62) with the exception of all actions concerned with the speech phase. Consequently, in the following descriptions the term "Teleservice" denotes both TeleserviceΒ 61 and TeleserviceΒ 62 as appropriate. NOTE: Some facilities associated with alternate speech/ facsimile groupΒ 3 may not be available with version 1 of MAP. In particular, the in‑call modification procedure following an inter MSC handover is not supported by this version. This imposes the limitation that for all calls it will not be possible to change between speech and facsimile following an inter MSC handover.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. β€’ References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. β€’ For a specific reference, subsequent revisions do not apply. β€’ For a non-specific reference, the latest version applies. β€’ A non-specific reference to an ETS shall also be taken to refer to later versions published as an EN with the same number. β€’ For this Release 1998 document, references to GSM documents are for Release 1998 versions (version 7.x.y). [1] GSMΒ 01.04: "Digital cellular telecommunications system (PhaseΒ 2+); Abbreviations and acronyms". [2] GSMΒ 02.03: "Digital cellular telecommunications system (PhaseΒ 2+); Teleservices supported by a GSM Public Land Mobile Network (PLMN)". [3] GSMΒ 03.10: "Digital cellular telecommunications system (PhaseΒ 2+); GSM Public Land Mobile Network (PLMN) connection types". [4] GSMΒ 04.02: "Digital cellular telecommunications system (PhaseΒ 2+); GSM Public Land Mobile Network (PLMN) access reference configuration". [5] GSMΒ 04.08: "Digital cellular telecommunications system (PhaseΒ 2+); Mobile radio interface layer 3 specification". [6] GSMΒ 04.21: "Digital cellular telecommunications system (Phase 2+); Rate adaption on the Mobile Station ‑ Base Station System (MS ‑ BSS) interface". [7] GSMΒ 07.01: "Digital cellular telecommunications system (PhaseΒ 2+); General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)". [8] GSMΒ 07.03: "Digital cellular telecommunications system (PhaseΒ 2+); Terminal Adaptation Functions (TAF) for services using synchronous bearer capabilities". [9] GSMΒ 09.07: "Digital cellular telecommunications system (PhaseΒ 2+); General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". [10] CCITTΒ RecommendationΒ F.160: "General operational provisions for the international public facsimile services". [11] CCITTΒ RecommendationΒ T.4: "Standardization of group 3 facsimile apparatus for document transmission". [12] CCITTΒ RecommendationΒ T.30: "Procedures for document facsimile transmission in the general switched telephone network". [13] CCITTΒ RecommendationΒ T.35: "Procedure for the allocation of CCITT members' codes". [14] CCITTΒ RecommendationΒ V.21: "300 bits per second duplex modem standardized for use in the general switched telephone network". [15] CCITTΒ RecommendationΒ V.24: "List of definitions for interchange circuits between data terminal equipment (DTE) and data circuit‑terminating equipment (DCE)". [16] CCITTΒ RecommendationΒ V.25 bis: "Automatic calling and/or answering equipment on the general switched telephone network (GSTN) using the 100‑series interchange circuits". [17] CCITTΒ RecommendationΒ V.27 ter: "4Β 800/2Β 400 bits per second modem standardized for use in the general switched telephone network". [18] CCITTΒ RecommendationΒ V.29: "9Β 600 bits per second modem standardized for use on point‑to‑point 4‑wire leased telephone‑type circuits". [19] CCITTΒ RecommendationΒ X.300: "General principles and arrangements for interworking between public data networks, and between public data networks and other networks".
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.1 Abbreviations
In addition to those below abbreviations used in the present document are listed in GSMΒ 01.04. BCS Binary coded signalling CCT Circuit(s) I/F Interface RA1,RA1',RA2 Rate adaptation functions SREJ Selective reject The abbreviations for the facsimile specific protocol elements and signals are listed in appendix I.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3 Service definition
The fixed network facsimile groupΒ 3 service, as basically defined in CCITT Recommendation F.160, is an international telematic service for document transmission between two facsimile groupΒ 3 terminals. The service specifications are comprised of two parts: ‑ the control procedures described in CCITT Recommendation T.30 and ‑ the document transmission coding described in CCITT RecommendationΒ T.4. The GSM facsimile groupΒ 3 Teleservice is intended to allow connections between facsimile groupΒ 3 terminals using: ‑ a GSM PLMN as stand‑alone facility for mobile‑to‑mobile communication; ‑ a GSM PLMN to have access to fixed networks PSTN and/or ISDN for mobile to/from fixed network communication. For this Teleservice, the coding of the facsimile document is as per CCITT Recommendation T.4 and the protocol as per CCITT Recommendation T.30 both modified within the PLMN as detailed in the present document. The interworking between different networks is based on CCITT Recommendation X.300. The particular features of this Teleservice are: ‑ it uses point‑to‑point communication; ‑ the information transfer mode is circuit, duplex, synchronous; ‑ the information transfer capability is alternate speech/ facsimile groupΒ 3 or facsimile groupΒ 3 only; ‑ both mobile originated and mobile terminated calls are supported; ‑ different end‑to‑end message speeds as per CCITT Recommendation T.30 may be used within the same connection to match the appropriate quality requirements; ‑ use of the standard synchronous terminal adaptation function for non‑transparent network support (as per GSMΒ 07.03) within the MS is envisaged.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
4 Network architecture
The network architecture applicable to this Teleservice is shown in figure 1/03.46 below. : ╔════════╗ : : β•‘ β•‘ : :─╒ PLMN β•Ÿβ”€: : β•‘ β•‘ : : β•šβ•β•β•β•β•β•β•β•β• : v v : ╔════════╗ : ╔═════╗ β”Œβ”€β”€β”€β”€β”€β”€β” β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β” : β•‘ β•‘ : ╔═════╗ β•‘ FAX β•Ÿβ”€β”€ MT β”œβ”€β”˜ └── BSS β”œβ”€β”€MSC/IWFβ”œβ”€:─╒ PSTN β•Ÿβ”€:─╒ FAX β•‘ β•šβ•β•β•β•β•β• β””β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”˜ : β•‘ β•‘ : β•šβ•β•β•β•β•β• : β•šβ•β•β•β•β•β•β•β•β• : : ╔════════╗ : : β•‘ β•‘ : :─╒ ISDN β•Ÿβ”€: : β•‘ β•‘ : : β•šβ•β•β•β•β•β•β•β•β• : Figure 1/03.46: Network architecture It shows the case of mobile to fixed network interworking. For mobile‑to‑mobile calls, there would effectively be a loop back within the PLMN using two IWFs.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
5 Reference configuration at the mobile station
The mobile station reference configurations described in this clause are defined as per GSMΒ 04.02. <----------------- Mobile station -----------------> ╔═══════╗ 2-w β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” R β”Œβ”€β”€β”€β”€β”€β” : a) β•‘ FAX β•Ÿβ”€β”€β”Όβ”€β”€β”€FAX Adaptorβ”œβ”€β”€β•«β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ MT2 β”œβ”€β•« β•šβ•β•β•β•β•β•β•β• β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ : β””β”€β”€β”€β”€β”€β”˜ : : : ╔═══════╗ 2-w β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” R β”Œβ”€β”€β”€β”€β”€β”€β” S β”Œβ”€β”€β”€β”€β”€β” : b) β•‘ FAX β•Ÿβ”€β”€β”Όβ”€β”€β”€FAX Adaptorβ”œβ”€β”€β•«β”€β”€β”€ TA β”œβ”€β”€β•«β”€β”€β”€ MT1 β”œβ”€β•« β•šβ•β•β•β•β•β•β•β• β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ : β””β”€β”€β”€β”€β”€β”€β”˜ : β””β”€β”€β”€β”€β”€β”˜ : : : ╔═══════╗ 2-w β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β” S β”Œβ”€β”€β”€β”€β”€β” : c) β•‘ FAX β•Ÿβ”€β”€β”Όβ”€β”€β”€β”€β”€β”€FAX Adaptorβ”‚ TA β”œβ”€β”€β”€β”€β”€β•«β”€β”€β”€ MT1 β”œβ”€β•« β•šβ•β•β•β•β•β•β•β• β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”˜ : β””β”€β”€β”€β”€β”€β”˜ : : : ╔═══════╗ R : β”Œβ”€β”€β”€β”€β”€β” : d) β•‘ FAX β•Ÿβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β•«β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ MT2 β”œβ”€β•« β•šβ•β•β•β•β•β•β•β• : : β””β”€β”€β”€β”€β”€β”˜ : : : : ╔═══════╗ R β”Œβ”€β”€β”€β”€β”€β”€β” S β”Œβ”€β”€β”€β”€β”€β” : e) β•‘ FAX β•Ÿβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β•«β”€β”€β”€ TA β”œβ”€β”€β•«β”€β”€β”€ MT1 β”œβ”€β•« β•šβ•β•β•β•β•β•β•β• : β””β”€β”€β”€β”€β”€β”€β”˜ : β””β”€β”€β”€β”€β”€β”˜ : : β”Œβ”€β”€β”€β”€β”€β” : f) β”‚ MT0 β”œβ”€β•« β””β”€β”€β”€β”€β”€β”˜ : Figure 2/03.46: Reference configurations The teleservice definitions in GSMΒ 02.03 regard the facsimile groupΒ 3 terminal as a 2‑wire analogue terminated equipment. In order to connect this to the MT2 a separate "fax adaptor" device is necessary. This configuration, shown in figure 2a/03.46, has to be considered as the standard configuration, so that all the existing facsimile groupΒ 3 terminals can be connected to the PLMN. An alternative realization would be to combine a facsimile groupΒ 3 terminal and the fax adaptor into a special "GSM facsimile machine", directly providing a digital output. Although such a terminal must appear to the MT2 as identical as the fax adaptor (i.e. with an identical interface and protocol), it would allow for a significantly smaller and simpler facsimile machine. This configuration is shown in figure 2d/03.46. In addition of course, it is always possible to realize an MT0, as per figure 2f/03.46, where both the facsimile and mobile termination functions are considered to be part of one integrated unit. The remaining configurations concern the use of an S interface and are considered as optional configurations. Their use is for further study. The particular terminal adaptation functions used are those detailed in GSMΒ 07.03 for non‑transparent bearer capability. The interface to the MT2 used is according to CCITT Recommendation V.24 with an option for support of CCITT RecommendationΒ V.25bis procedures for auto calling and auto answering.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
5.1 Fax adaptor functionality
The fax adaptor block, figure 3/03.46, is intended to specifically complement the facsimile groupΒ 3 terminal in order to be able to communicate over a GSM PLMN. ╔═══════════════════╀═══════════════════╗ β•‘ β”‚ β•‘ β•‘ Composite β”‚ β•‘ β•‘ Modem β”‚ Control, β•‘ 2-w β•‘ β”‚ Protocol β•‘ R ──┼──╫──────────────────── Monitoring β•Ÿβ”€β”€β•«β”€β”€ β•‘ β”‚ & β•‘ β•‘ Tone β”‚ Buffer β•‘ β•‘ Handling β”‚ β•‘ β•‘ β”‚ β•‘ β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• Figure 3/03.46: Fax adaptor scheme Whether it has to be a function internal to the GSM PLMN, or an external accessory associated with the facsimile groupΒ 3 terminal, is beyond the scope of the present document, and in any case, does not affect the working of the procedure as described here. It can be functionally partitioned in two sections: ‑ an analogue section, dealing with: ‑ the modulation and demodulation processes according to CCITT Recommendation V.21, V.27ter, and V.29 as explained in CCITT Recommendation T.4 and T.30; ‑ handling of the signalling on the 2‑wire path to the associated facsimile terminal, including auto calling and auto answering functions where necessary (see clause 8). ‑ a digital section, dealing with: ‑ overall control of the adaptor; ‑ monitoring and, where necessary, manipulating the CCITT Recommendation T.30 protocol as detailed in the present document; ‑ connection to the MT using the interface according to CCITT Recommendation V.24 as described in GSMΒ 07.03; ‑ buffering of facsimile data; ‑ transcoding of the CCITT Recommendation T.4 document content for transmission across the radio interface as detailed in the present document; ‑ where necessary, auto calling and auto answering functions according to CCITT Recommendation V.25bis.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
5.2 GSM facsimile machine functionality
The special GSM facsimile machine shown in the MS configuration of figure 2d/03.46 is similar to the digital part of the fax adaptor, but without any of the analogue portions. It appears at the CCITT Recommendation V.24 interface as identical as the fax adaptor, i.e. the MT2 needs to have no knowledge of the particular configuration used.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6 Connection types
Table 1/03.46 shows the connection elements attributes applicable to these Teleservices, extracted from GSMΒ 03.10. Table 1/03.46: Connection elements Protocol type Access to TAF Radio interface Intermediate BS‑MSC/IWF of fig.Β 6 of the Mobile connection element rate connection GSMΒ 03.10 Station RA1 to RA2 element Model 6: Speech ‑‑‑‑ Speech/GSM ‑‑‑‑ CCITT A‑law Model 7: C/D/S UDI C/D/S UDI C/D/S UDI C/D/S UDI Facsimile ‑ 9.6 kbit/s ‑ 12 kbit/s ‑ 16 kbit/s ‑ 64 kbit/s GroupΒ 3 NT (‑ 4.8 kbit/s) (‑ 2.4 kbit/s) C = circuit switched S = synchronous D = duplex UDI = unrestricted digital information Figure 4/03.46 shows the scheme of a typical GSM PLMN connection for these teleservices, considering R and S access, respectively, at network termination. To support the CCITT Recommendation T.30, requiring different transmission rates, the following strategy shall be implemented: ‑ the channel on the radio interface shall be a full rate channel used for RLP protocol transmission (non‑transparent network support); ‑ no modification procedure (Channel Mode Modify: CMM) shall be performed during the data phase of the call; ‑ the user rate of the MT2 is preferably set to 9Β 600 bit/s; ‑ the transmission rate between the fax adaptor and the associated facsimile terminal at both ends shall be the same, i.e. there will be only one common end‑to‑end transmission rate at any given time; ‑ the negotiation of the message speed shall be end‑to‑end between the two facsimile terminals; this allows also for a message speed of 7Β 200 bit/s to be used; ‑ the connection between the fax terminals is divided into three logical sections (fax terminal ‑(1)‑ fax adaptor ‑(2)‑ fax adaptor ‑(3)‑ fax terminal); ‑ flag stuffing is applied by the fax adaptor towards the associated facsimile terminal within the constraints of CCITT Recommendation T.30, to keep the data link active whenever a procedure delay occurs; ‑ the BCS protocol elements and the facsimile coded data are buffered at both ends of the radio interface (in the fax adaptors), if necessary, to guarantee data integrity; ‑ a specific fax adaptor protocol (FA protocol) is provided between both the fax adaptors to cater for the appropriate link control. R DTE β”‚ DCE ╔═══╗ ╔═════════╗ V ╔═════< >═════╗ ╔═══╗ β•‘ G β•‘ β•‘ β•‘<----114-----β•‘ β•‘ β•‘ G β•‘ β•‘ r β•‘ β•‘ β•‘<----115-----β•‘ β•‘ β•‘ r β•‘ β•‘ o β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ o β•‘ β•‘ u β•‘ β•‘ β•‘-----108---->β•‘ β•‘ β•‘ u β•‘ β•‘ p β•‘ β•‘ β•‘<----107-----β•‘ P β•‘ β•‘ p β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ M β•‘ β•‘ β•‘ β•‘ 3 β•‘ β•‘ β•‘-----105---->β•‘ L S β•‘ β•‘ 3 β•‘ β•‘ β•‘2-wβ•‘ Fax β•‘<----106-----β•‘ C β•‘ 2-wβ•‘ β•‘ β•‘ t β•Ÿβ”€β”Όβ”€β•’ Adaptor β•‘<----109-----β•‘ MT2 M / β•Ÿβ”€β”€ ─ ─┼─╒ t β•‘ β•‘ e β•‘ β•‘ β•‘ β•‘ I β•‘ β•‘ e β•‘ β•‘ r β•‘ β•‘ β•‘<----125-----β•‘ N W β•‘ β•‘ r β•‘ β•‘ m β•‘ β•‘ β•‘ β•‘ F β•‘ β•‘ m β•‘ β•‘ i β•‘ β•‘ β•‘-----103---->β•‘ β•‘ β•‘ i β•‘ β•‘ n β•‘ β•‘ β•‘<----104-----β•‘ β•‘ β•‘ n β•‘ β•‘ a β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ a β•‘ β•‘ l β•‘ β•‘ β•‘<----102---->β•‘ β•‘ β•‘ l β•‘ β•šβ•β•β•β• β•šβ•β•β•β•β•β•β•β•β•β• β•šβ•β•β•β•β•< >═════╝ β•šβ•β•β•β• Figure 4a/03.46: Standard Teleservice connection S β”‚ ╔═══╗ ╔════════╀══╗ V ╔═════< >═════╗ ╔═══╗ β•‘ G β•‘ β•‘ β”‚ β•‘---------->β•‘ β•‘ β•‘ G β•‘ β•‘ r β•‘ β•‘ β”‚ β•‘ X bit β•‘ β•‘ β•‘ r β•‘ β•‘ o β•‘ β•‘ β”‚ β•‘<----------β•‘ β•‘ β•‘ o β•‘ β•‘ u β•‘ β•‘ β”‚ β•‘ β•‘ β•‘ β•‘ u β•‘ β•‘ p β•‘ β•‘ β”‚ β•‘---------->β•‘ P β•‘ β•‘ p β•‘ β•‘ β•‘ β•‘ β”‚ β•‘ SA bits β•‘ M β•‘ β•‘ β•‘ β•‘ 3 β•‘ β•‘ β”‚ β•‘<----------β•‘ L S β•‘ β•‘ 3 β•‘ β•‘ β•‘2-wβ•‘ Fax β”‚ β•‘ β•‘ C β•‘ 2-wβ•‘ β•‘ β•‘ t β•Ÿβ”€β”Όβ”€β•’Adaptor β”‚TAβ•‘---------->β•‘ MT1 M / β•Ÿβ”€β”€ ─ ─┼─╒ t β•‘ β•‘ e β•‘ β•‘ β”‚ β•‘ SB bits β•‘ I β•‘ β•‘ e β•‘ β•‘ r β•‘ β•‘ β”‚ β•‘<----------β•‘ N W β•‘ β•‘ r β•‘ β•‘ m β•‘ β•‘ β”‚ β•‘ β•‘ F β•‘ β•‘ m β•‘ β•‘ i β•‘ β•‘ β”‚ β•‘ β•‘ β•‘ β•‘ i β•‘ β•‘ n β•‘ β•‘ β”‚ β•‘---------->β•‘ β•‘ β•‘ n β•‘ β•‘ a β•‘ β•‘ β”‚ β•‘ D bits β•‘ β•‘ β•‘ a β•‘ β•‘ l β•‘ β•‘ β”‚ β•‘<----------β•‘ β•‘ β•‘ l β•‘ β•šβ•β•β•β• β•šβ•β•β•β•β•β•β•β•β•§β•β•β• β•šβ•β•β•β•β•< >═════╝ β•šβ•β•β•β• Figure 4b/03.46: Optional Teleservice connection
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.1 Protocol model
Figure 5/03.46 depicts the protocol model for this Teleservice, deduced from model 7 of figureΒ 6/GSMΒ 03.10. It should be noted that depending on the particular implementation the R reference point may not explicitly exist. In this case the LAPB protocol and consequently the LAPB entities operating across this interface may be omitted. The protocol stack at the radio interface, however, is not affected by this consideration, i.e. RLP and L2RBOP always apply. The main point to be underlined is that all the protocol modules specific for this Teleservice are confined in the fax adaptor functions at both the MT and MSC/IWF ends. This includes the layer 2 entity function for LAPB to be operated towards the standard TAF for synchronous non‑transparent bearer capability. Mobile station Base station MSC/IWF <------------------------------------------> <------------> <-------------------------------------> Fax adaptor R I/F Radio I/F BSS-MSC I/F Fax adaptor -------------------->| | | |<------------------- T.30β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β” | FA protocol | β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”T.30 ───── β”œ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ β”œβ”€β”€β”€β”€ β”‚Fax β”‚ | β”Œβ”€β”€β”€β”€β”€β”€β” | L2RBOP | β”Œβ”€β”€β”€β”€β”€β”€β” | β”‚Fax β”‚ β”‚Adaptor β”‚ | β”‚ L2R β”œ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─L2R β”œ ─ ─ ─ ─ ─ ─ ─Adaptor β”‚ β”‚Functionβ”‚ | LAPB β”œβ”€β”€β”¬β”€β”€β”€β”€ | RLP | β”œβ”€β”€β”€β”¬β”€β”€β”˜ | β”‚Functionβ”‚ β”‚ β”œ ─ ─ ─ ─ ─ ─ ─ ─ ─L2β”‚RLPβ”œ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─RLPβ”‚ | β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜ | β””β”€β”€β”΄β”€β”€β”€β”˜ | | β””β”€β”€β”€β”˜ | β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜ \\ | // \\ | β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β” | // | \\ | // β”Œβ”€β”€β”€β”€β” | β”‚\───┬──/β”‚ | β”Œβ”€β”€β”€β” | \\ | // β”‚RA1'β”‚ | β”‚RA1'β”‚RA1β”‚ | β”‚RA1β”‚ | \\ | // β””β”€β”€β”€β”€β”˜ | β””β”€β”€β”€β”€β”΄β”€β”€β”€β”˜ | β””β”€β”€β”€β”˜ | \\ | // \ | / \ | / | β”Œβ”€β”€β”€β”€β”€β”€β”€β”|β”Œβ”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”|β”Œβ”€β”€β”€β” β”Œβ”€β”€β”€β”|β”Œβ”€β”€β”€β” | β”‚I/F cctβ”œβ”€β”€I/F cctβ”‚ β”‚FECβ”œβ”€β”€FECβ”‚ β”‚RA2β”œβ”€β”€RA2β”‚ | β””β”€β”€β”€β”€β”€β”€β”€β”˜|β””β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”˜|β””β”€β”€β”€β”˜ β””β”€β”€β”€β”˜|β””β”€β”€β”€β”˜ | Figure 5/03.46: Protocol model for non‑transparent support
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2 Principles of the Facsimile Protocol Adaptation
The basic approach of the present document for facsimile groupΒ 3 is: ‑ to use the standard non‑transparent network support (including e.g. standard MT) as basically defined in technical specifications GSMΒ 07.01, GSMΒ 07.03, and GSMΒ 09.07; ‑ to use the CCITT Recommendation T.30 procedure at both ends of the connection between the fax adaptor and the associated facsimile terminal and to pass the protocol elements according to CCITT Recommendation T.30 functionally unchanged wherever possible; ‑ to use a specific protocol between both the fax adaptors across the radio interface; and ‑ to intervene within the fax adaptors in order to concatenate the applicable connection sections. Basically there are four problem areas: ‑ support of facsimile groupΒ 3 with a digital connection type; ‑ unpredictable delays on the radio interface due to actual RLP working conditions (ARQ); ‑ the need to change the transmission rate "locally" in the fax adaptors both in the MS and in the MSC/IWF and to adapt it to the constant user rate of the TAF; ‑ the inability to support some CCITT Recommendation T.30 features. To overcome these problems some particular functions within the fax adaptors are necessary, such as: ‑ buffering of BCS frames and facsimile coded data prior to transfer; ‑ autonomous interventions such as BCS command inhibiting within the fax adaptors; ‑ autonomous interactions between any fax adaptor and the associated facsimile terminal such as BCS command/response repetition; and ‑ provision of a fax adaptor protocol as interchange protocol between the fax adaptors. Following this strategy, an interchange model is defined concentrating on the facsimile relevant components. According to this model three connection sections can be distinguished: a) between fax adaptor and associated facsimile terminal; b) between the both fax adaptors and again; c) between fax adaptor and associated facsimile terminal. The fax adaptors fully relying on the standard supporting layers (e.g. TAF) will also have to cater for the correct establishment and control of these layers including traffic channel synchronization and status information exchange in particular with respect to circuit 106 and circuit 109 (according to CCITT Recommendation V.24). Once these circuits have been set to ON (traffic channel synchronization), they must be kept in the ON condition during the entire facsimile phase of a connection (refer subclauseΒ 6.3 "Procedure Interrupts"). ╔═════════╗ ╔═════════╗ ╔═════════╗ ╔═════════╗ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ Fax β•Ÿβ”€β”€β•’ FA β•Ÿβ”€ ─ ─ ─ ─ ─ ─ ─╒ FA β•Ÿβ”€β”€β•’ Fax β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•‘ β•šβ•β•β•β•β•β•β•β•β•β• β•šβ•β•β•β•β•€β•β•β•β•β• β•šβ•β•β•β•β•€β•β•β•β•β• β•šβ•β•β•β•β•β•β•β•β•β• β”Œβ”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β” β”‚ standard supporting layers β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ CCITT Recommendation T.30 β”œβ”€ ─── ─── ─── ─── ─── ─── ─── ─── ─── ─ ─ CCITT Recommendation CCITT Recommendation T.30 Fax adaptor protocol T.30 β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ <----> <----> interactions interactions <--- interventions <---------> interventions ---> Figure 6/03.46: Communication model
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.1 Fax Adaptor Protocol
To cater for the appropriate facsimile transmission some protocol elements and their use (procedure) are defined. These protocol elements are exchanged between both fax adaptors. They are defined as follows and are structured as outlined in annexΒ A: ‑ BCS element: The BCS element is used to relay CCITT Recommendation T.30 BCS frames. It includes the possibility also to transmit parts of an entire BCS frame (segmentation). This will apply when the BCS frame content ‑ excluding the address and control fields of the BCS frame ‑ to be included exceeds a length of 20 octets (e.g. non standardized frames) which otherwise would cause unacceptable delays when relaying the BCS frame as a whole. For that purpose, the BCS frame element carries information on the integrity of a BCS frame element. To guarantee the overall integrity of the BCS frames each single element includes a sequence number which is set to zero within each first BCS element carrying either a BCS command or BCS response (i.e. triggered by the preamble). It is incremented by one with each successive element belonging to the same BCS command/response transmitted across the radio interface. The counting is carried out independently for each direction of the element transmission. The number of BCS elements which can be transmitted within one sequence (BCS command/response) is limited to 256. The fax adaptor receiving those elements checks the correct sequence of the numbers and, by this means, is able to detect loss of BCS elements and to act accordingly. ‑ BCS abort element: The BCS abort element is used to indicate to the remote fax adaptor that an error occurred during the BCS frame reception and the transmission of the related BCS frame is to be aborted. ‑ BCS transmit request element: The BCS transmit request element is used in two ways: a) to request initial transmission of a BCS command or response after the preamble element preceding each BCS element sequence carrying such a command/response has been recognized; b) to request retransmission of previously transmitted BCS elements in case of an error between both the fax adaptors. This applies e.g. if a sequence error has been recognized. The retransmission starts with the BCS element the number of which is indicated in the transmit request. ‑ Preamble element: The preamble element is transmitted once for each received preamble as soon as the preamble has been recognized. It is used to switch on the fax modem and to start transmitting the preamble at the remote side of the radio interface 300 ms after the preamble element reception. The duration of the preamble must be the minimum still permitted by CCITT RecommendationΒ T.30. ‑ Normal data element: The normal data element is used to relay buffered facsimile data which have been received and transcoded when not operating in error correction mode. ‑ Error correction data element: The error correction data element is used to relay buffered facsimile data frames received when operating in error correcting mode. It contains the entire respective data frame excluding the address and control fields of the frame. ‑ End of data element: The end of data element is used to indicate the end of the message transmission. Subsequently, a preamble element is to follow. ‑ TCF element: The TCF element TCF_OK or TCF_NOK is used to inform the opposite fax adaptor function about the result of the autonomously performed TCF phase.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.2 Interactions and interventions within the fax adaptors
Interactions and interventions within the fax adaptors are necessary: ‑ where protocol elements cannot be passed due to the differences between the PSTN and the GSM system; ‑ where the content of protocol elements has to be aligned with the capabilities of the supporting GSM PLMN; ‑ where BCS commands are repeated by the facsimile terminal after a time‑out due to transmission delay across the radio interface; ‑ where BCS commands must be repeated autonomously by the fax adaptor after a time‑out when no response has been received from the associated facsimile terminal; ‑ where the retransmission of BCS commands is requested by the associated facsimile terminal sending a CRP frame due to recognized transmission errors; ‑ where the retransmission of BCS element(s) is requested by any fax adaptor using the BCS transmit request; ‑ during the transmission of facsimile coded data where the document content is transcoded to save transmission capacity at the radio interface (however, this does not apply when using the CCITT Recommendation T.30 error correction mode). To perform the necessary interactions and interventions the fax adaptors both in the MS and in the MSC/IWF have to monitor the BCS frames and the facsimile coded data exchanged between the two facsimile terminals and to act as detailed below: ‑ reception of CCITT Recommendation T.30 BCS protocol elements from the associated facsimile terminal discarding BCS commands repetitively received due to time‑out in the facsimile terminal; ‑ transmission of CCITT Recommendation T.30 BCS protocol elements to the associated facsimile terminal autonomously repeating BCS commands towards the accepting facsimile terminal if necessary after time‑out or on request by CRP; ‑ control of the half duplex connections between the fax adaptor and the associated facsimile terminal; ‑ storage of BCS commands/responses completely received from the associated facsimile terminal; ‑ relay of the CCITT Recommendation T.30 protocol elements between the two facsimile terminals by using the appropriate FA protocol elements and mapping them onto the particular L2R protocol (L2RBOP) elements and vice versa as indicated below; ‑ changing information elements of the BCS frames indicating capabilities which cannot be supported by the PLMN; ‑ transmission/reception of the CCITT Recommendation T.30 training check frames (TCF) to/from the associated facsimile terminal; ‑ phasing/training with the associated facsimile terminal; ‑ transcoding of the normal facsimile coded data received from the facsimile terminal and writing them into a buffer in the fax adaptor associated with the transmitting facsimile terminal; ‑ reading of the facsimile coded data from the buffer for transmission across the radio interface using the appropriate FA protocol elements; ‑ writing of the facsimile coded data received across the radio interface into a buffer at the receiving end of the connection section between MS and MSC/IWF; ‑ reading and reverse transcoding of the buffered normal facsimile coded data and transmitting them to the associated facsimile terminal; ‑ control of a response transmission timer, to guarantee the reception of a response right in time (refer to subclauseΒ 7.2.1.1). The algorithm for mapping the CCITT Recommendation T.30 information onto the L2R protocol elements consists of three steps: ‑ generation of the appropriate FA protocol element including the CCITT Recommendation T.30 protocol element (BCS frames or facsimile coded data); ‑ generation of a single LAPB I‑frame including the FA protocol element in the information field; ‑ segmentation of a particular LAPB I‑frame into L2RBOP PDUs according to GSMΒ 07.03. To regenerate the original CCITT Recommendation T.30 protocol element the actions must be reversed at the remote fax adaptor. The support of guard tones by the fax adaptor in the MSC/IWF is an implementation option.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.3 Training Check
The training check sequence (TCF) as per CCITT Recommendation T.30 is exchanged only locally between the fax adaptor and the associated facsimile terminal. However, the subsequent exchange of CFR or FTT is, in principle, end‑to‑end. The training check sequence sent by the fax adaptor must have the minimum duration permitted (ref. to CCITT RecommendationΒ T.30). As a consequence of this local procedure, the fax adaptors have to check the received TCF whether the quality requirements are satisfied. Depending on the result of that check, the fax adaptor recognizing a bad line will eventually change the CFR to be a FTT, indicating a negative training result and transmits the TCF_element (TCF_OK or TCF_NOK). With the knowledge of the TCF check result of the opposite fax adaptor function and the received response frame (CFR or FTT) from the fax apparatus, the fax adaptor, which generated the TCF, is able to deduce the following phase. The message transfer phase in the receiving fax adaptor function is entered upon reception of TCF element TCF_OK and CFR. The modem training at transmission speed shall start after reception of the first facsimile coded data from the opposite fax adaptor function or autonomously 5.5s after reception of CFR. In the other cases, the transmitting fax adaptor function shall repeat the last DCS/TCF sequence 3s after reception of the response, if no new DCS frame from the opposite fax adaptor function is available. Only in case of a mobile to mobile call (refer to subclause 6.2.4/ GSMΒ 03.46) a TCF_NOK leads to transmission of an invalid TCF. If no TCF element was received, because of a RLP link reset, until a CFR is received from the fax apparatus, the message phase shall be entered autonomously 5.5s after reception of the CFR or the first facsimile coded data in the receiving adaptation function.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.4 Mobile to mobile calls
In this section, an interim solution is described. The final solution depends on the progress in the ITU‑T and is expected by the end of 1995. To get the information about the nature of the call, a GSM specific country code inside the NSF frame is used to identify an inter MSC call. The GSM country code (refer to CCITT Recommendation T.35) is coded as follows: bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 1 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ 1 β”‚ 1 β”‚ 1 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ In case no NSF has to be transmitted, the IWF shall insert a special NSF frame defined as follows: FCF FIF | | NSF, GSM country code, stuff byte (0) After reception of an NSF frame in the IWF with a GSM country code, the IWF shall enter a specific inter MSC procedure with the following interventions: ‑ Insertion of NSC respectively NSS with the above mentioned coding before sending of (CIG)DTC or (TSI)DCS. ‑ Discarding of received NSC and NSS frames which are generated by the opposite IWF. ‑ The transmission of TCF sequence is triggered by the reception of the TCF Discriminator. In case of TCF_NOK, an invalid TCF is transmitted to the opposite IWF. ‑ To save time and to check also the quality of link between the two MSCs, a BCS frame FTT is generated by the IWF and sent to the opposite IWF after reception of an invalid TCF. In this case the response CFR or FTT from the mobile side shall not be transferred to the other MSC. If an IWF receives an FTT from the opposite IWF the preceding DCS frame should not be automatically repeated after expiration of the command/response timer (T=3s, refer to CCITT RecommendationT.30). ‑ The response time supervision (Ts=1.6s, refer to subclause 7.2.1.1) within the IWFs is inactive, that means, a response shall be accepted as a valid frame by the receiving IWF when the BCS carrier is detected within 3s after transmission of the previous command. ‑ The message transfer phase is only entered after reception of the first facsimile coded data from the radio link. ‑ The facsimile coded data shall be transferred between the IWFs with minimum scan line transmission time equal to 0Β ms (refer to CCITT Recommendation T.4).
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.5 Facsimile Message Transfer
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.5.1 Message Transcoding
To save transmission capacity at the radio interface the content of the document shall be transcoded. This applies only, when using the normal facsimile data transfer, i.e. not with the error correction mode. The facsimile coded data received by the fax adaptor from the facsimile terminal is transcoded and transmitted to the corresponding fax adaptor across the radio interface, where it is transcoded in the reverse direction and transmitted to the receiving facsimile terminal. The transcoding is based on the minimum line length capability of the T.30 protocol for the normal facsimile data transfer. According to this the transmitting facsimile terminal has to fill up each coded scan line with FILL information to conform to this requirement (ref. CCITT Recommendation T.4). To take advantage from that, the fax adaptor associated with the transmitting facsimile terminal will force this to use (at least) the standard value of 20Β ms by replacing the applicable parameter value of the exchanged DIS/DTC messages. All FILL information of the facsimile coded data received from the facsimile terminal will be deleted prior to forwarding the data across the radio interface. The fax adaptor associated with the receiving facsimile terminal must recognize and store the originally requested minimum line length to be able to regenerate to correct line length. It should be noted that the CCITT Recommendation T.4 document coding may be 1‑dimensional or 2‑dimensional and, in addition, uncompressed. The fax adaptors have to take care of this when transcoding the document content.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.5.2 Generation of the normal data element
The normal facsimile coded data which have been transcoded and buffered as described in the present document is segmented for transmission across the radio interface into blocks of max. 936 bits (afterwards constituting a sequence of max. 5 L2RBOP PDUs). Each such block is contained in the information field of a normal data element of the FA protocol (see annex A). The facsimile message transfer is finalized by a trailing end of data element which allows the transmitting fax adaptor to switch off the message speed modem. It may be necessary to align the content of the normal data element to octet boundary at the end of the facsimile message transmission, i.e. after the RTC. This is done by appending '0's to the RTC. This fill information may be omitted by the remote fax adaptor.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.2.5.3 Generation of the error correction data element
The content of a FCD frame, if received correctly, is stored by the fax adaptor. Each such block is contained in the information field of a error correction data element of the FA protocol (see annex A). The facsimile message transfer is finalized by a trailing end of data element which allows the transmitting fax adaptor to switch off the message speed modem.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.3 Procedure interrupts
Procedure interrupts are only supported in Teleservices 61; in case of Teleservice 62 any attempt to invoke procedure interrupts by MMI on the MT (see subclause 6.4 below) will have no effect.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.4 Radio channel modification
This applies to Teleservice 61 only, if a change of the radio channel during the call swapping from speech to facsimile or vice versa is required. For this purpose the in‑call modification procedure (ICM) as detailed in GSMΒ 04.08 is carried out. The change from speech to facsimile is initiated by MMI at the MS as in other data services starting the ICM procedure via MODIFY signalling . As a basic requirement for this transition, circuit 108.2 (according to CCITT Recommendation V.24) towards the MT must be in the ON condition. Additionally the data call direction (DCD) must be known to both the FAs because of a correct tone handling. The DCD identifies the call direction from the calling to the called station according to CCITT Recommendation T.30 phase A tonal signals. The DCD is derived from the evaluation of the behaviour of the mobile fax machine. No later than 3 sec after connecting the fax apparatus to the line the FA/MT is able to determine the DCD. If a CNG tone or nothing is detected by the FA/MT the mobile fax station is the calling station, if a CED tone or a BCS signal is detected by the FA/MT the mobile fax station is the called station. The FA/MT indicates this towards the MT by means of CT105: CT105 in OFF condition indicates "mobile terminated", whereas CT105 ON indicates "mobile originated". The detection of the CT105 condition and subsequent triggering of the MODIFY message has to be done 3 sec after the reception of the ON condition of CT108.2. A reverse DCD compared with the initial call setup direction is indicated to the FA/IWF by means of the "Reverse Call Setup Direction (RCSD)" IE within the MODIFY message. If the MODIFY message has contained this IE, the same IE shall be included in the MODIFY COMPLETE (ACK) message. On the basis of RCSD and additional information about the initial call setup direction (e.g. transaction identifier flag ‑ ref.Β 04.07), the FA/IWF shall resolve the actual DCD. At DCD condition "mobile originated" the FA/IWF has to transmit a CNG tone if neither CED nor a BCS signal has been already received, otherwise nothing. At DCD condition "mobile terminated" the FA/IWF has to transmit a CED. At the moment when CT107 goes to ON condition the FA/MT has to generate CED if CT105 was in ON condition, otherwise nothing (see subclauses 8.2.1.1 and 8.2.2.1). If during the facsimile call the return to speech is necessary (T.30 procedure interrupt request), this must be initiated by the mobile fax machine as well as by the fixed network fax machine (ref. to the diagrams in figure II.14/15). Upon receipt of the alert operator tone the request will be accepted by manual intervention via MT (phone off‑hook) and is reflected to the FA by CT106 and CT109 going to OFF condition. Upon monitoring the transit of the necessary sequence of BCS signals specific for PRI the CT108.2 goes to OFF condition causing ICM from the fax data phase to the speech phase. In case of procedure interrupt request from the PSTN side a guard timer is necessary to protect against the possible loss of the response to the PRI‑Q(PIN/PIP) sent by the MS. After the execution of ICM (MODIFY message), CT107 is set to OFF condition finishing the fax data phase. Subsequent re‑selection of the data phase will be done by manual intervention via the MS causing CT108.2 going to ON condition initiating ICM. During the speech phase of a procedure interrupt, the phone off‑hook condition of the MT is reported via the FA R‑I/F (CT106/109 in OFF condition) to the fax apparatus which must remain functionally connected to the FA to maintain the connection. A subsequent reverse change to facsimile phase is also carried out by manual intervention at the MT causing ICM. This will be immediately reflected by circuit 107 going to OFF condition. The successful completion of ICM is indicated towards the fax adaptor by circuit 107 going to ON (provided circuitΒ 108/2 is still in the ON condition). During the speech phase of a procedure interrupt, the condition of the facsimile terminal of the MS is not reported across the CCITT Recommendation V.24 interface. It may remain functionally connected to the fax adaptor, but in a suspended state. The precise operation of the fax adaptor for the support of procedure interrupt is implementation dependent.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
6.5 Performance constraints
In order to perform the procedures described in the present document the MS and the IWF environment should be designed to be able to transmit and receive facsimile data continuously without any need to flow control the procedure by themselves. This applies specifically for the RLP, L2R, and the LAPB entities within the MT or the IWF, respectively, as well as for the fax adaptor itself. Furthermore, the RLP entity should be able to make error recovery by using the SREJ command/response. The parameters (timers, repetition counters, etc.) should be set to appropriate values using the negotiation capability of the RLP. The appropriate setting of parameter values applies also for the LAPB procedure. In addition it is strongly recommended to operate at an user access rate of 9Β 600Β bit/s, even if the facsimile terminal(s) are not able to work with 9Β 600Β bit/s message speed.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7 Use of terminal adaptation functions
According to the protocol model of the connection types (figure 5/03.46) there are two classes of TAFs to be considered.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.1 Standard TAFs for synchronous services
The TAFs are those described in GSMΒ 07.03 for synchronous bearer capabilities in the non‑transparent mode, i.e. presently for LAPB only. The rate adaptation functions shall comply with GSMΒ 04.21. The interchange signalling mapping is in accordance with GSMΒ 07.03.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2 Specific TAFs for facsimile service
Integral part of an end‑to‑end connection for this Teleservice is the fax adaptor function, located at both the PLMN ends and in charge of: ‑ establishment and maintenance of a LAPB link between the fax adaptation function and the standard synchronous terminal adaptation function according to GSMΒ 07.03, where applicable; ‑ establishment and maintenance of an L2RBOP link between the fax adaptors in the MS and in the MSC/IWF according to GSMΒ 07.03; ‑ transcoding of the document content to be transmitted across the radio interface as described in clause 6 of the present document; ‑ adaptation of the CCITT Recommendation T.30 protocol procedures to the GSM PLMN environment and generation of the fax adaptor protocol elements as described in clause 6 of the present document. The main features relevant to the CCITT Recommendation T.30 adaptation functions are detailed in the following. For better clarification only, in the following a double configuration will be referenced: ‑ transmitter adaptation function, established at the PLMN side where the terminal is located actually performing document transmission; ‑ receiver adaptation function, established at the PLMN side where the terminal is located actually receiving the facsimile document. The proper configuration is settled on both network sides by detecting DIS/DTC frame just at the beginning of the phase B in the CCITT Recommendation T.30 protocol procedure. The optional error correction mode, as defined in CCITT Recommendation T.4‑Annex A and CCITT Recommendation T.30‑Annex A may be fully supported, provided some specific features are included in the fax adaptor procedure. These features are relevant to: ‑ additional BCS frames to be detected; ‑ handling of the message phase. The overall framework as described in clause 6 of the present document applies, i.e. also the procedures of the error correction mode are, in principle, run end‑to‑end between the two facsimile terminals. The error correction mode is entered upon detection of the relevant bits in the DIS/DTC frame. The working principle of the present document is based on the detection, control, deletion, and generation of key messages in the end‑to‑end dialogue between the facsimile terminals. While in BCS phases, the following frames have to be detected: ‑ DIS/DTC, to monitor all operational parameters of the transmitting terminal; ‑ DCS, to realize the actual operational parameters, e.g. message transmission speed accepted by the sender terminal and the relevant message transfer direction (see table 2/CCITT Recommendation T.30); ‑ CFR and MCF, to trigger the message phase; ‑ CTC/EOR, fixing the retransmission strategy by the facsimile transmitting terminal (error correction mode); ‑ CTR/ERR, acting as confirmation message and so closing a BCS phase before a new message phase; ‑ PPR, as above, but after the fourth consecutive PPR request, the BCS phase continues with either CTC or EOR (error correction mode); ‑ DCN, to initiate the call release procedure. Furthermore, all BCS command messages have to be monitored to eliminate repeated command messages at the local fax adaptation function and to initiate a repetition of those command messages, if necessary, at the remote fax adaptation function. Additionally, all BCS response messages have to be monitored to be able to clear the former condition.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1 BCS phase
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1.1 BCS command/response procedures
The CCITT Recommendation T.30 procedure is segmented in sections of associated BCS commands and responses. Any command sent by a facsimile terminal must be answered by an appropriate BCS response (refer to Appendix III, CCITT Recommendation T.30). To guarantee that transmission and reception of responses take place right in time, a response transmission (including preamble) shall never be started by the fax adaptor function associated with the command sending terminal later than Ts (response time supervision =Β  1.6s) after reception of previous command. According to the command/response relationship, the fax adaptor receiving a BCS command from its associated facsimile terminal is further on designated as commanding fax adaptor. Similarly, the fax adaptor receiving a BCS response is called the responding fax adaptor. The procedure is as follows: Prior to receiving any BCS command/response the preceding preamble is recognized and the "preamble element" is transmitted to the remote fax adaptor. There it is used to start transmission of the preamble towards the associated facsimile terminal with a delay of 300 ms. The preamble preceding a BCS response must be sent with minimum duration permitted (ref. to CCITT Recommendation T.30). If necessary, a preamble must be "aborted" and restarted after an appropriate period as indicated in CCITT Recommendation T.30. In addition, the recognition of the "preamble element" is immediately confirmed to the other fax adaptor by sending a "BCS transmit request element" (with sequence number set to zero). As this confines a synchronization point, no further protocol transaction can take place except exchanging another "preamble element" until the "BCS transmit request element" has been recognized by the related fax adaptor. The commanding fax adaptor when receiving the initial "BCS transmit request element" as confirmation to the "preamble element" (condition 1), starts forwarding the received BCS command using "BCS elements" and applying segmentation, if necessary (ref. to subclause 6.2.1). A BCS command which has been received correctly from the associated facsimile terminal (condition 2), is stored within the commanding fax adaptor. If both conditions 1 and 2 apply, any forwarding of BCS commands repetitively received from the facsimile terminal is further on inhibited. Any "BCS transmit request element" received from the responding fax adaptor is answered accordingly, i.e. by the requested BCS element(s), if any. If an error occurs during the reception of the BCS command from the associated facsimile terminal, the commanding fax adaptor transmits a "BCS abort element" towards the responding fax adaptor and regards the whole BCS command as not received. Any "BCS transmit request element" is ignored at this stage. The inhibit status is cleared when either an appropriate BCS response is received and forwarded to the facsimile terminal or the connection is released. The responding fax adaptor receiving "BCS elements" checks their correct sequence (refer to subclauseΒ 6.2.1) and starts reassembling and transmitting the BCS command once either a complete BCS frame or at least the second element of a segmented BCS frame is received from the commanding fax adaptor and no sequence error has been detected. Any "BCS element" received after successful reception of a complete BCS command is ignored. If a BCS command consists of a sequence of BCS frames preceded by a single preamble each BCS frame is forwarded separately across the radio interface. The sequence has to be reconstituted at the responding fax adaptor when sending to the associated facsimile terminal. If necessary, flags are transmitted between the BCS frames. If during a transmission any required subsequent element is not available, the responding fax adaptor aborts the BCS command transmission to the facsimile terminal, and the rest of the BCS command is not transmitted. The same applies, if due to residual errors on the radio interface (e.g. RLP link reset) "BCS elements" are missing which can be detected by a wrong sequence number. In these cases, any "BCS element" following the error event (e.g. with a number out of sequence) is ignored. The responding fax adaptor may therefore need to use a "BCS transmit request element" in order to ask for (re)transmission of outstanding elements, if any. If a "BCS abort element" has been received by the responding fax adaptor and the transmission is aborted due to this fact, the complete BCS command including the preceding "preamble element" will be retransmitted autonomously by the commanding fax adaptor. Contiguously received parts of a BCS command received from the radio interface are stored in the responding fax adaptor. The stored BCS command when completed, is used for autonomous retransmissions towards the associated facsimile terminal which may start at the earliest possible time according to CCITT Recommendation T.30. No repetition counter is provided. The responding fax adaptor when receiving the initial "BCS transmit request element" as confirmation to the "preamble element" (condition 1), starts forwarding the received BCS response using "BCS elements" and applying segmentation, if necessary (ref. subclauseΒ 6.2.1). A BCS response which has been received correctly from the associated facsimile terminal (condition 2), is stored within the responding fax adaptor. Any "BCS transmit request element" received from the commanding fax adaptor is answered accordingly, i.e. by the requested BCS element(s), if any. If an error occurs during the reception of the BCS response from the associated facsimile terminal, the responding fax adaptor transmits a "BCS abort element" towards the commanding fax adaptor and regards the whole BCS response as not received. Any "BCS transmit request element" is ignored at this stage. The autonomous command repeat status is cleared when both conditions 1 and 2 apply. The commanding fax adaptor receiving "BCS elements" checks their correct sequence (refer to subclauseΒ 6.2.1) and starts reassembling and transmitting the BCS response once either a complete BCS frame or at least the second element of a segmented BCS frame is received from the responding fax adaptor and no sequence error has been detected. Any "BCS element" received after successful reception of a complete BCS response is ignored. If a BCS response consists of a sequence of BCS frames preceded by a single preamble each BCS frame is forwarded separately across the radio interface. The sequence has to be reconstituted at the commanding fax adaptor when sending to the associated facsimile terminal. If necessary, flags are transmitted between the BCS frames. If during a transmission any required subsequent element is not available, the commanding fax adaptor aborts the BCS frame transmission to the facsimile terminal, and the rest of the BCS frame is not transmitted. The same applies, if due to residual errors on the radio interface (e.g. RLP link reset) "BCS elements" are missing which can be detected by a wrong sequence number. In these cases, any "BCS element" following the error event (e.g. with a number out of sequence) is ignored. The commanding fax adaptor may therefore need to use a "BCS transmit request element" in order to ask for (re)transmission of outstanding elements, if any. If a "BCS abort element" has been received by the commanding fax adaptor and the transmission is aborted due to this fact, the complete BCS response including the preceding "preamble element" will be retransmitted autonomously by the responding fax adaptor. Contiguously received parts of a BCS response received from the radio interface are stored in the commanding fax adaptor. The stored BCS response when completed, is used for autonomous answering towards the associated facsimile terminal which may start at the earliest possible time according to CCITT RecommendationΒ T.30. After transmission of a response towards the fax apparatus by the fax adaptor function, after which the fax adaptor function waits for message data (CFR, CTR, MCF after MPS, PPS_MPS, PPS_NULL, ERR after EOR_MPS, EOR_NULL) a repeated BCS command shall be locally responded, without transferring a preamble element towards the radio link. The fax adaptors have to take care of the control of the local modem. The condition is derived from the reception of certain fax adaptor protocol elements. Additionally, there must be a control of the half duplex transmission path towards the associated facsimile terminal. For that purpose, the receiver signal is monitored and the transmitter is only activated, if no receive signal is active.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1.2 Compatibility checking
Some features cannot be supported in the GSM PLMN environment. The fax adaptor function is in charge of dealing with such compatibility checking which is carried out by monitoring certain BCS frames (DIS/DTC). ‑ GroupΒ 1 and groupΒ 2 equipments are not supported by the Teleservice as described in the present document. ‑ Error limiting mode cannot be supported. ‑ Only standard 300Β bit/s Binary Coded Signalling is supported. To this purpose the fax adaptor will ignore the 2400Β bit/s capability within the phase B of the CCITT Recommendation T.30 procedure by looking for DIS frames from CCITT Recommendation V.21 modem only. ‑ Only facsimile message speeds up to and including 9Β 600Β bit/s are supported. For this purpose the fax adaptors are responsible to carry out appropriate actions, e.g. to set the applicable fields in the DIS frame accordingly. ‑ It is not possible to support non‑standard facilities since some of these contain proprietary methods of changing the modem speed, invisible to the IWF and hence impossible to track. If an NSF frame occurs, the country code has to be exchanged in the IWF to the GSM specific country code, which is not supported by a standard fax group 3 apparatus and therefore no private procedure is entered (refer to subclauseΒ 6.2.4). However, non‑standard BCS frames may carry information which does not affect the correct operation within the PLMN, but is essential for the user (e.g. passwords). Those elements, if any, will be passed end‑to‑end by the fax adaptors unless an explicit deletion is required by the user (e.g. by specific input at the fax adaptor associated with the mobile station).
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1.3 Message speed checking
Although it is strongly recommended to use the maximum user rate of the MT2 (9Β 600Β bit/s), a particular user may signal a lower user rate. In this case the fax adaptors have to carry out the following additional procedures: ‑ max speed indicated in the call set‑up message is 4Β 800Β bit/s: ‑ if the fax adaptor receives a DIS or DTC indicating CCITT Recommendation V.29 only, the call shall be released; ‑ if CCITT Recommendation V.29 and V.27ter is indicated, this shall be changed to V.27ter; ‑ if other values are indicated, no action has to be taken; ‑ max speed indicated in the call set‑up message is 2Β 400Β bit/s: ‑ if the fax adaptor receives a DIS or DTC indicating CCITT Recommendation V.29 only, the call shall be released; ‑ if CCITT Recommendation V.29 and V.27ter or V.27ter only is indicated, this shall be changed to V.27ter fallback; ‑ if CCITT Recommendation V.27ter fallback is indicated, no action shall be taken.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1.4 Control of transmission rate
The controlling entity of the fax adaptor recognizes when a change of the transmission rate ‑ and in conjunction with this a change of the modem function ‑ has to commence. The transmission rate is then changed only locally, i.e. between the facsimile terminal and the fax adaptor at both the MSC/IWF and the MS ends. The actual message speed and the modem function are derived from the content of the related BCS frames (DIS/DTC, DCS, CTC).
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.1.5 Clocking
The fax adaptor or the GSM facsimile machine will acquire received data bit timing on circuit 115 (according to CCITT Recommendation V.24). The transmitter element timing circuit 114 shall be synchronized to circuit 115. The clock rate at the CCITT Recommendation V.24 interface will reflect the user rate of the MT2 as indicated in the set‑up message.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2 Message phase
During the message phase (phase C of CCITT Recommendation T.30) a single bit pattern has to be detected, the EOL character (see subclauseΒ 4.1.2/CCITT Recommendation T.4), a unique code word that can never be found within a valid line of facsimile coded data, and is used, as per CCITT Recommendation T.4: ‑ to identify the start of message phase; ‑ to control the buffer level; ‑ to mark the end of message phase (6 consecutive instances).
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2.1 Normal facsimile data
The message phase (see figure II.6/GSMΒ 03.46 and II.7/GSMΒ 03.46, respectively) at both the PLMN ends is triggered by the transit of a frame (either the CFR or the MCF) sent by the receiving terminal to confirm a previous frame from the transmitting terminal, and marking the end of a BCS phase. The terminal adaptation function associated with the receiving terminal after receiving facsimile coded data or autonomously 5.5s after detecting the trigger frame (CFR or MCF) will change the modem function to V.27ter or V.29 CCITT Recommendation and initiate the training at the applicable speed. Following the training segment, 0s bits will be stuffed towards the facsimile terminal (FILL sequence, see subclauseΒ 4.1.2 of CCITT Recommendation T.4), disregarding all information received from the radio interface, until a EOL character is detected, that will mark the beginning of the real phase C (see figureΒ 1/CCITT Recommendation T.4). If due to a preceding error the message phase cannot be entered, this training must be aborted when a new BCS element is received by the transmitting fax adaptor.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2.2 Error correction facsimile data
As these facsimile coded data between the fax adaptor and the facsimile terminal are structured in HDLC frames, the handling of this procedure segment will exploit such formatting. The content of such an HDLC frame is further on called a block. Each such block is included in the information field of a error correction data element of the FA protocol which is processed for transmission across the radio interface as outlined in clause 6. The message phase (see figure II.8/GSMΒ 03.46) at both the PLMN ends is triggered by the transit of a confirmation frame (CFR, MCF, PPR, CTR or ERR) sent by the receiving terminal and marking the end of the BCS phase. If four consecutive PPR are counted within the same "partial page", the BCS phase continues. The transmitter adaptation function will enter the message phase as per CCITT Recommendation T.30 standard procedure. The terminal adaptation function associated with the receiving terminal after receiving facsimile coded data or autonomously 5.5s after detecting the trigger frame will change the modem function to V.27ter or V.29 CCITT Recommendation and initiate the training at the applicable speed. Following the training segment, HDLC flags will be stuffed towards the facsimile terminal until a FCD frame is detected, that will mark the beginning of the real phase C. If due to a preceding error the message phase cannot be entered, this training must be aborted when a new BCS element is received by the transmitting fax adaptor.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2.3 Buffering of facsimile coded data
The following subclauses only apply, when using the normal facsimile data transfer, i.e. not with the error correction mode.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2.3.1 Transmitter adaptation function
In the transmitter adaptation function the facsimile coded data being received from the facsimile terminal are transcoded stripping of FILL information and written into the buffer. If there is enough information available, this data is read out from the buffer, and a FA protocol element is generated which is processed as described in clause 6 to be transferred to the receiver adaptation function using one of the standard TAFs referred to in subclauseΒ 7.1. For that purpose the data is segmented in blocks (see subclauseΒ 6.2.5.2). Due to the ARQ techniques of the RLP the throughput across the radio interface may be less than the message speed between the transmitting facsimile terminal and the transmitter adaptation function, i.e. the content of the buffer may increase. When a certain threshold is reached from which the fax adaptor can derive that the actual page cannot be transmitted successfully, the connection may be prematurely released. If the throughput at the radio interface is greater than the message speed between the transmitting facsimile terminal and the transmitter adaptation function (e.g. when the end‑to‑end speed is lower than 9Β 600Β bit/s), the buffer may be empty most of the time.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.2.3.2 Receiver adaptation function
In the receiver adaptation function FILL information is transmitted to the facsimile terminal at the beginning of each page, if necessary, to bridge the gap between the training sequence and the real facsimile coded data. In case of normal fax data the FILL 0's can be expanded up to 5s only and therefore after these up to two white scan lines should be inserted, if necessary. The facsimile coded data received across the radio interface are re‑generated from the LAPB, L2R and FA protocol elements, reversely transcoded according to the knowledge of the fax adaptor, and written into the buffer. The reverse transcoding consists of insertion of FILL information before the facsimile coded data is forwarded to the facsimile terminal to comply with the recognized minimum line length as defined in CCITT Recommendation T.4. At the beginning of each page the facsimile coded data to be sent to the facsimile terminal is not read out from the buffer until at least 2 instances of EOL or an RTC have been received or the following buffer size limit, depending on the end to end data transfer rate, has been exceeded: 2 kByte for 2,400 bit/s; 4 kByte for 4,800 bit/s; 6 kByte for 7,200 bit/s; 8 kByte for 9,600 bit/s. Once this procedure has been started, i.e. during the page transmission, the facsimile coded data is transmitted, however, the following EOL is delayed by inserting additional FILL information, if necessary, until the pre‑set threshold (2 EOLs or the buffer size limit) is reached again. If the actual coding line is going to exceed 5 s, the threshold is temporarily reduced, i.e. the following EOL is sent. However, the buffering algorithm shall try to reach the pre‑set threshold again as fast as possible (by inserting FILL also before following EOLs). If no EOL is available to be transmitted to the facsimile terminal for a period greater than 5Β s, the connection will be released by an ordinary receiving facsimile terminal (ref. CCITT Recommendation T.4).
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.3 Disconnect procedure
The transmitter adaptation function, upon detection of the DCN frame (see CCITT Recommendation T.30) sent by the local terminal to indicate the end of the facsimile transmission, initiates the disconnect procedure.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
7.2.4 Timeouts
The overall fax adaptation function is in principle bound to the timing constraints associated with the end‑to‑end CCITT Recommendation T.30 procedure. This means that, no matter of the reference configuration used at the mobile station, either the "standard" one (figure 2a/GSMΒ 03.46) or the "GSM facsimile machine" (figure 2d/GSMΒ 03.46), the progress of the call will be mainly subject to the CCITT Recommendation T.30 typical timing protections, settled externally. However, due to the specific conditions caused by the GSM PLMN system, there is the need for a special support with respect to BCS command repetitions as explained above. For that purpose, the fax adaptors will provide means for local time‑out. The timer will be started and stopped as described in the applicable clauses of the CCITT RecommendationΒ T.30.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8 Signalling aspects
GSMΒ 07.03 identifies the bearer capability requirements to be supported by the terminal adaptation function in the MT (see GSMΒ 07.01 for BC and HLC coding). The specific signalling requirements are those for "speech" and "facsimile groupΒ 3" or "facsimile groupΒ 3" only, respectively. The MT indicates in the call set up request the requirements, e.g. first speech, second facsimile by sending the bearer capability information element(s) in the appropriate order. For an "auto calling" facsimile request, the facsimile groupΒ 3 bearer capability is sent as the first or the only bearer capability for TeleserviceΒ 61 or 62, respectively. For interworking between Teleservice 61 and Teleservice 62 refer to GSMΒ 02.03 and 07.01.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.1 Handling of tonal signals
Because the CCITT defined service uses modems, there are some signals received from the analogue link at the MSC/IWF and (where used) the fax adaptor which do not have a direct binary representation. These signals cannot therefore be passed across the radio interface in the same way as the CCITT Recommendation T.30 and CCITT Recommendation T.4 information. These signals are the modem called (CED) and calling (CNG) tones sent at the start of each fax data phase of the call; they are generated locally by the FA/MT and/or FA/IWF, exploiting an end‑to‑end time alignment mechanism, triggered by appropriate messages on the GSM signalling channel. The procedure is detailed in the following.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2 Call establishment
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.1 Mobile terminated call
The PSTN facsimile groupΒ 3 terminal may be manually or automatically calling.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.1.1 Speech then facsimile
Refer to the diagram in figure II.1a/03.46 and II.1b/03.46. In both of the figures the initial call setup is mobile terminated. In figure I.1a/03.46 the DCD is also mobile terminated (MT), while the DCD in figureΒ I.1b/03.46 is mobile originated (MO). In order to make the transition from the speech phase to the facsimile phase, the MODIFY command must be initiated by MMI at the MS. In the case where a GSM facsimile machine is used, it will turn on circuitΒ 108/2 when it is connected to the line by manual intervention. In the case where a fax adaptor at MT is used, it will turn on circuit 108/2, when the mobile fax apparatus is connected to the line by manual intervention. After determination of the DCD and ICM (see subclause 6.4) and on completion of the synchronization process over the radio interface or the RLP establishment, CT107 shall be turned on by the MT; in case where a FA is used, on receipt of CT107 from MT, the FA will complete the tonal handshaking according to the rules in subclause 6.4. The analogue link at the FA/IWF side will be established in accordance with the T.30 rec.; provided the synchronization process is completed (CT108.2 ON condition), the appropriate tone according to the rules in subclause 6.4 shall be transmitted. In case of DCD mobile terminated the CED tone shall be transmitted after a silence of 1.8 to 2.5 sec (see T.30, 4.3.3.2) from the call being answered; during transmission of CED tone (2.6 sec minimum duration, followed by a delay period of 75 +/‑ 20 ms) the FA/IWF will process data received from the GSM‑TCH as usual, but relevant information (e.g. preamble of a BCS frame) shall be discarded without any buffering. Note that circuit 109 and circuit 106 (according CCITT Recommendation V.24) at the R interface of the MT must be turned on by the fax adaptor at the IWF before any further procedure can be carried out between the fax adaptors and consequently end‑to‑end. Once the connection is established, both circuit 106 and circuit 109 are clamped to the ON condition by the fax adaptor at the IWF, so fixing a full duplex mode throughout the whole facsimile phase of the call.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.1.2 Auto answer
Refer to diagram in figure II.2/GSMΒ 03.46. A call received from the PSTN will cause the MT to turn on circuit 125 (according to CCITT Recommendation V.24) at the R interface. In the case where a GSM facsimile machine is used, CCITT RecommendationΒ V.25bis auto answering process is handled directly by turning on circuit 108/2. In the case where a fax adaptor is used, circuit 125 will cause ring current to be sent to the mobile facsimile terminal. The fax adaptor will turn on circuit 108/2, when the mobile facsimile terminal answers the call. On receipt of circuit 108/2, the MT will answer the call and initiate the synchronization process and the establishment of the RLP across the radio interface. On completion of the synchronization process or RLP establishment, the modem at IWF will automatically be selected and send CED to PSTN facsimile terminal. Also circuit 107 shall be turned on by the MT. In the case where a fax adaptor is used, on receipt of circuit 107 from MT, the fax adaptor will initiate the tonal hand‑shake by sending CNG (mandatory). The analogue links at both the PSTN side and the mobile side (where a fax adaptor is used) will be established in accordance with the appropriate V. series recommendation. Note that circuit 109 and circuit 106 at the R interface of the MT must be turned on by the fax adaptor at the IWF before any further procedure can be carried out between the fax adaptors and consequently end‑to‑end. Once the connection is established, both circuit 106 and circuit 109 are clamped to the ON condition by the fax adaptor at the IWF, so fixing a full duplex mode throughout the whole facsimile phase of the call.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.2 Mobile originated calls
The PSTN facsimile groupΒ 3 terminal may be manually or automatically answered.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.2.1 Speech then facsimile
Refer to the diagram in figure II.3a/03.46 and figure II.3b/03.46. In both of the figures the initial call setup is mobile terminated. In figure II.3a/03.46 the DCD is also MO, while in figure II.3b/03.46 the DCD is MT. In order to make the transition from the speech phase to the facsimile phase, the MODIFY command must be initiated by MMI at the MS, which will result in an establishment of the RLP across the radio interface and connection to line of the FA/IWF. In the case where a fax adaptor is used, the mobile facsimile terminal must be connected to line by manual intervention at this stage, and will cause the fax adaptor to turn on circuit 108/2 (according to CCITT Recommendation V.24) towards the MT. In the case where a GSM facsimile machine is used, circuitΒ 108/2 shall be turned on when the GSM facsimile machine is connected to line by manual intervention. After determination of the DCD and ICM (see subclause 6.4) and on completion of the synchronization process across the radio interface or the establishment of RLP, the modem at the IWF will be automatically selected and send the appropriate modem tone according to the rules in subclause 6.4 to PSTN facsimile terminal. Also circuit 107 shall be turned on by the MT, whereupon the FA/MT will complete the tonal handshaking according to the rules in subclause 6.4. In the case where a fax adaptor is used, the receipt of circuit 107 shall cause the fax adaptor to connect to line. The analogue links at both the PSTN side and the mobile side (where a fax adaptor is used) will be established in accordance with the appropriate CCITT V. series recommendation. Note that circuit 109 and circuit 106 at the R interface of the MT must be turned on by the fax adaptor at the IWF before any further procedure can be carried out between the fax adaptors and consequently end‑to‑end. Once the connection is established, both circuit 106 and circuit 109 are clamped to the ON condition by the fax adaptor at the IWF, so fixing a full duplex mode throughout the whole facsimile phase of the call.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.2.2 Auto calling
Refer to diagram in figure II.4/GSMΒ 03.46. The auto calling procedure of CCITT Recommendation V.25bis is initiated at the CCITT Recommendation V.24 interface. This is done either directly from the GSM facsimile machine or, in the case where a fax adaptor is used, by loop disconnect or DTMF dialling information between the mobile facsimile terminal and the fax adaptor. When the call is answered, the synchronization process will be started and the RLP will be established across the radio interface. On completion of the synchronization process across the radio interface or RLP establishment, the modem at the IWF will be automatically selected and send CNG (mandatory) to PSTN facsimile terminal. Also CT107 shall be turned on by the MT. In the case where a fax adaptor is used, the receipt of circuit 107 shall cause the fax adaptor to connect to line. The analogue links at both the PSTN side and the mobile side (where a fax adaptor is used) will be established in accordance with the appropriate V. series recommendation. Note that circuit 109 and circuit 106 (according to CCITT Recommendation V.24) at the R interface of the MT must be turned on by the fax adaptor at the IWF before any further procedure can be carried out between the fax adaptors and consequently end‑to‑end. Once the connection is established, both circuit 106 and circuit 109 are clamped to the ON condition by the fax adaptor at the IWF, so fixing a full duplex mode throughout the whole facsimile phase of the call.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
8.2.2.3 Manual calling
Refer to diagram in figure II.5/GSMΒ 03.46. When the call is answered, the RLP will be established across the radio interface providing circuit 108/2 in ON condition. In the case where a fax adaptor is used, the mobile facsimile terminal must be connected to line by manual intervention at this stage, and will cause the fax adaptor to turn on circuit 108/2 (according to CCITT Recommendation V.24) towards the MT. In the case where a GSM facsimile machine is used, circuit 108/2 shall be turned on when the GSM facsimile machine is connected to line by manual intervention. On completion of the synchronization process across the radio interface or RLP establishment, the modem at the IWF will be automatically selected and send CNG (mandatory) to PSTN facsimile terminal. Also circuit 107 shall be turned on by the MT. In the case where a fax adaptor is used, the receipt of circuit 107 shall cause the fax adaptor to connect to line. The analogue links at both the PSTN side and the mobile side (where a fax adaptor is used) will be established in accordance with the appropriate CCITT V. series recommendation. Note that circuit 109 and circuit 106 at the R interface of the MT must be turned on by the fax adaptor at the IWF before any further procedure can be carried out between the fax adaptors and consequently end‑to‑end. Once the connection is established, both circuit 106 and circuit 109 are clamped to the ON condition by the fax adaptor at the IWF, so fixing a full duplex mode throughout the whole facsimile phase of the call.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
9 Interworking to fixed networks
PSTN and ISDN only are considered, both used as transit networks to complement the PLMN in the end‑to‑end connection between facsimile groupΒ 3 terminal, figure 7/GSMΒ 03.46. I W F β”Œ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ :β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” : :β”‚Protocolβ”‚β”‚ V.21 β”‚ : β”Œβ”€β”€β”€β”€β”€β” :β”‚Control β”‚β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”΄β”€β” : β”‚ β”‚ v v :β”‚Monitor.│└── V.27ter β”‚ : ╔══════════╗2-w ╔╧═════╧╗ ╔═════════════╗╔════╗│ │╔═════════╗:β”‚Trans- β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”΄β”€β”:───────────╒ PSTN β•Ÿβ”€β”€β”€ β•‘ TE2 β•Ÿβ”€β”€β•’ Fax adaptor β•Ÿβ•’ MT β•Ÿβ”˜ β””β•’ BSS/MSC β•Ÿ:β”‚coding β”‚ └── V.29 β”‚: β•šβ•β•β•β•β•β•β•β•β•β•β• β•šβ•β•β•β•β•β•β•β• β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•šβ•β•β•β•β• β•šβ•β•β•β•β•β•β•β•β•β•:β”‚Buffers β”‚ β”‚ Modem β”‚: / \ :β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜: β”Œβ”€β”€β”€β”€β”€β” ╔══════════╗ / \ :β”‚ β”‚ :──Codecβ”œβ”€β”Όβ”€β•’ ISDN β•Ÿβ”€β”€β”€ / \ :β”‚L2RBOP β”‚β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”: β””β”€β”€β”€β”€β”€β”˜ : β•šβ•β•β•β•β•β•β•β•β•β•β• / \ :β”‚Mapping β”‚β”‚Tone handlingβ”‚: 3.1kHz / \ :β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜: audio β”Œ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ β”” ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ β”˜ :β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”: :β”‚ V.21 β”‚ β”‚Protocolβ”‚: :β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”΄β”€β” β”‚Control β”‚: :└── V.27ter β”‚ β”‚Monitor.β”‚: : β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”΄β”€β”β”‚Trans- β”‚: 2-w: └── V.29 β”‚β”‚coding β”‚: ────: β”‚ Modem β”‚β”‚Buffers β”‚: : β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚LAPB- β”‚: : β”‚Handlingβ”‚: :β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚L2RBOP β”‚: :β”‚Tone handlingβ”‚β”‚Mapping β”‚: :β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜: β”” ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ β”˜ Figure 7/03.46: Network interworking
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
9.1 Interworking to PSTN
As the standard access of facsimile groupΒ 3 terminals for this Teleservice is a 2‑wire analogue interface, all the technical requirements for network interworking to PSTN are identical in principle to those encountered for the terminal connection to the MT. The key functional block is the fax adaptor described in clause 6 of the present document. As far as network interworking is concerned, the main function to be performed by such a block is the correct managing of a composite modem, in accordance with the requirements of CCITT Recommendation T.30: ‑ CCITT Recommendation V.21 synchronous mode, as standard facility for all BCS phases; ‑ CCITT Recommendation V.27ter for message speeds of 4 800 and 2 400Β bit/s; ‑ CCITT Recommendation V.29 for message speeds of 9 600 and 7 200Β bit/s. The mechanism for selecting the right modem is the following: ‑ the actual message speed is obtained by detecting the DCS frame (see table 2/CCITT Recommendation T.30) while in BCS phase; ‑ on entering the message phase, there is an interchange between the V.21 modem and the actual modem agreed upon between the terminals for message transmission; ‑ on exiting the message phase (RTC) the CCITT Recommendation V.21 modem is selected again. Times for settling the modem will be in accordance with the requirements of CCITT Recommendation T.30.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
9.2 Interworking to ISDN
The use of 3.1Β kHz audio bearer capability of ISDN allows for an interworking of PLMN very similar in practice to the scheme for PSTN, figure 7/GSMΒ 03.46. The fax adaptor function is in conformance with the description given in clause 4 and subclause 7.1 of the present document. Annex A (normative): Structure and contents of the fax adaptor protocol elements
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
1 Principle structure of an element
Each FA protocol element consists of the element discriminator (one single octet) and the optional information field (arbitrary length). The elements are transmitted with octet 0, bit 1 first. Received information is forwarded with the same bit sequence as received. octet: 0 1 ..... n β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Element β”‚ CCITT Recommendation T.30 Protocol Element β”‚ β”‚ Discriminator β”‚ (optional) β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚<-- 1 octet -->β”‚<--------------- n octets ----------------->β”‚ Figure A.1/03.46: Principle FA protocol element structure
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2 Element discriminator coding
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.1 BCS element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ X β”‚ 0 β”‚ y β”‚ y β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ β”‚ β””β”€β”€β”¬β”€β”€β”˜ β”‚ 0 1 = begin of a BCS frame β”‚ 1 0 = end of a BCS frame β”‚ 0 0 = middle of a BCS frame β”‚ 1 1 = entire BCS frame 0 = non-final frame 1 = final frame Figure A.2/03.46: Element discriminator of a BCS element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.2 BCS abort element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 1 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.3/03.46: Element discriminator of a BCS abort element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.3 BCS transmit request element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.4/03.46: Element discriminator of a BCS transmit request element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.4 Preamble element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.5/03.46: Element discriminator of a preamble element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.5 Normal fax data element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.6/03.46: Element discriminator of a normal fax data element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.6 Error correction fax data element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.7/03.46: Element discriminator of an error correction fax data element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.7 End of data element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.8/03.46: Element discriminator of an end of data element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.8 TCF element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 1 β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ Figure A.9/03.46: Element discriminator of a TCF element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3 Information field content
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.1 BCS element
CCITT Recommendation ╔════════════════════════╗ T.30 frame β•‘ FCF + [FIF] β•‘ β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• | | FA protocol ╔═══╀════╀════════════════════════╗ element β•‘ D β”‚ SN β”‚ β•‘ β•šβ•β•β•β•§β•β•β•β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• D = discriminator octet SN = sequence number (0 .. 255), bit 1 = LSB Figure A.10/03.46: Information field content of a BCS element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.2 BCS abort element
no information field available
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.3 BCS transmit request element
FA protocol ╔═══╀════╗ element β•‘ D β”‚ SN β•‘ β•šβ•β•β•β•§β•β•β•β•β• D = discriminator octet SN = sequence number (0 .. 255), bit 1 = LSB = Least significant bit
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.4 Preamble element
no information field available
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.5 Normal fax data element
transcoded ═╀═══════════════════════════════════════╀═ facsimile β”‚ max. 936 bits of facsimile coded data β”‚ data ═╧═══════════════════════════════════════╧═ β”‚ β”‚ FA protocol ╔═══╀═══════════════════════════════════════╗ element β•‘ D β”‚ β•‘ β•šβ•β•β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• D = discriminator octet Figure A.11/03.46: Information field content of a normal fax data element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.6 Error correction fax data element
CCITT Recommendation T.4 frame ╔════════════════════════╗ (FCD or RCP) β•‘ FCF + [FIF] β•‘ β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• | | FA protocol ╔═══╀════════════════════════╗ element β•‘ D β”‚ β•‘ β•šβ•β•β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• D = discriminator octet Figure A.12/03.46: Information field content of an error correction fax data element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.7 End of data element
no information field available
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3.8 TCF element
bit 8 7 6 5 4 3 2 1 β”Œβ”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β”¬β”€β”€β”€β” β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ 0 β”‚ X β”‚ β””β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”΄β”€β”€β”€β”˜ X = 0 : TCF_OK X = 1 : TCF_NOK Figure A.13/03.46: Information field content of a TCF element
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
4 Relationship of FA protocol elements with LAPB, L2RBOP and RLP
Refer also to GSMΒ 07.03 FA protocol ╔═╀════════════════════════╗ element β•‘Dβ”‚ optional information β•‘ β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• | | LAPB I-frame ╔═╀═╀══════════════════════════╀═══╗ information β•‘Aβ”‚Cβ”‚ β”‚FCSβ•‘ field β•šβ•β•§β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β•β•β• | | ╔══╀══════════════════════════╀══╀══╀═════════╗ L2RBOP PDU β•‘S1β”‚ β”‚S2β”‚S3β”‚arbitraryβ•‘ β•šβ•β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β•β•§β•β•β•§β•β•β•β•β•β•β•β•β•β• | | RLP ╔═╀═════════════════════════════════════════════╀═╗ block β•‘Hβ”‚ β”‚Fβ•‘ β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β• D = Discriminator octet, A = address field, C = control field, S1, S2, S3 = status octets, H = RLP header, F = RLP FCS Figure A.14/03.46: Mapping for a "short" FA protocol element FA protocol ╔═╀═══════════════════ ═════════╗ element β•‘Dβ”‚ information ... β•‘ β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• ═════════╝ | | LAPB I-frame ╔═╀═╀═════════════════════ ═════════╀═══╗ information β•‘Aβ”‚Cβ”‚ β”‚ β”‚ ... β”‚ β”‚FCSβ•‘ field β•šβ•β•§β•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β• ═════════╧═══╝ / / \ \ \ \ ╔══╀════════╗╔══╀════════╗ ╔══╀══════╀══╀══╗ L2RBOP PDUs β•‘S0β”‚ #1 β•‘β•‘S0β”‚ #2 β•‘ ... β•‘S1β”‚ #n β”‚S2β”‚S3β•‘ β•šβ•β•β•§β•β•β•β•β•β•β•β•β•β•šβ•β•β•§β•β•β•β•β•β•β•β•β• β•šβ•β•β•§β•β•β•β•β•β•β•§β•β•β•§β•β•β• / / \ \ \ \ RLP ╔═╀════════════╀═╗╔═╀════════════╀═╗ ╔═╀═════════════╀═╗ blocks β•‘Hβ”‚ β”‚Fβ•‘β•‘Hβ”‚ β”‚Fβ•‘.β•‘Hβ”‚ β”‚Fβ•‘ β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β•β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β• β•šβ•β•§β•β•β•β•β•β•β•β•β•β•β•β•β•β•§β•β• D = Discriminator octet, A = address field, C = control field, S0, S1, S2, S3 = status octets, H = RLP header, F = RLP FCS Figure A.15/03.46: Mapping for a "long" FA protocol element Appendix I (informative): Abbreviations from CCITT Recommendation T.30 and T.4 Table I.1/03.46: Abbreviations from CCITT Recommendation T.30 Abbre‑ Function Signal format T.30 T.30 viation standard err.corr. CED Called station identification 2100 Hz X X CFR Confirmation to receive X010 0001 X X CRP Command repeat X101 1000 X X CIG Calling subscriber identification 1000 1000 X X CNG Calling tone 1100 Hz X X CSI Called subscriber identification 0000 0010 X X CTC Continue to correct X100 1000 X CTR Response to continue to correct X010 0011 X DCN Disconnect X101 1111 X X DCS Digital command signal X100 0001 X X DIS Digital identification signal 0000 0001 X X DTC Digital transmit command 1000 0001 X X EOM End of message X111 0001 X EOP End of procedure X111 0100 X EOR End of retransmission X111 0011 X ERR Response to end of retransmission X011 1000 X FCD Facsimile coded data 0110 0000 X FCF Facsimile control field ‑‑‑ X X FCS Frame checking sequence 16 bits X X FIF Facsimile information field ‑‑‑ X X FTT Failure to train X010 0010 X X MCF Message confirmation X011 0001 X X MPS Multi‑page signal X111 0010 X NSC Non‑standard facilities command 1000 0100 X X NSF Non‑standard facilities 0000 0100 X X NSS Non‑standard set‑up X100 0100 X X PIN Procedural interrupt negative X011 0100 X X PIP Procedural interrupt positive X011 0101 X X PIS Procedure interrupt signal 462 Hz X X PPR Partial page request X011 1101 X PPS Partial page signal X111 1101 X PRI Procedure interrupt X111 XXXX X RCP Return to control for partial page 0110 0001 X RNR Receive not ready X011 0111 X RR Receive ready X111 0110 X RTN Retrain negative X011 0010 X X RTP Retrain positive X011 0011 X X TCF Training check frame 0... 1.5s X X TSI Transmitting subscriber identification X100 0010 X X Table I.2/03.46: Abbreviations from CCITT Recommendation T.4 Abbre‑ Function Signal format viation EOL End of line 0000 0000 0001 RTC Return to control 6 * EOL Appendix II (informative): Procedure examples 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) locally generated by the fax adaptor at IWF (4) optionally (5) triggered by delayed CT108.2 (3 sec) Figure II.1a/03.46: Mobile terminated call ‑ speech then facsimile DCD mobile terminated 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) locally generated by fax adaptor at IWF (4) optionally (5) triggered by delayed CT108.2 (3 sec) (6) transmitted only if neither CED nor BCS is already received Figure II.1b/03.46: Mobile terminated call ‑ speech then facsimile DCD mobile originated 106, 107, 108/2, 109, 125: circuits according to CCITT Recommendation V.24 (1) manual or automatic operation (2) mandatory (3) either after synchronization or RLP establishment (4) locally generated by fax adaptor at IWF Figure II.2/03.46: Mobile terminated call ‑ auto answer 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) locally generated by fax adaptor at IWF (4) optionally (5) triggered by delayed CT108.2 (3 sec) Figure II.3a/03.46: Mobile originated call ‑ speech then facsimile DCD mobile terminated 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) locally generated by fax adaptor at IWF (4) optionally (5) triggered by delayed CT108.2 (3 sec) (6) transmitted only if neither CED nor BCS is already received Figure II.3b/03.46: Mobile originated call ‑ speech then facsimile DCD mobile originated 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) PSTN fax terminal may be manually or automatically answered (4) either after synchronization or RLP establishment (5) locally generated by fax adaptor at IWF Figure II.4/03.46: Mobile originated call ‑ auto calling 106, 107, 108/2, 109: circuits according to CCITT Recommendation V.24 (1) manual intervention (2) mandatory (3) PSTN fax terminal may be manually or automatically answered (4) either after synchronization or RLP establishment (5) locally generated by fax adaptor at IWF Figure II.5/03.46: Mobile originated call ‑ manual calling Figure II.6/03.46: Mobile originated facsimile transmission Figure II.7/03.46: Mobile terminated facsimile transmission Figure II.8/03.46: Mobile originated facsimile transmission (error correction mode) Figure II.9/03.46: Mobile originated facsimile transmission ‑ error recovery (example) Figure II.10/03.46: Mobile terminated facsimile transmission ‑ error recovery (example) Figure II.11/03.46: Mobile originated facsimile transmission ‑ error recovery (example) Figure II.12/03.46: Mobile originated facsimile transmission ‑ error recovery (example) Figure II.13/03.46: Mobile originated facsimile transmission ‑ error recovery (example) Annex B (informative): Change Request History Change history SMG No. TDoc. No. CR. No. Section affected New version Subject/Comments SMG#11 4.1.2 ETSI Publication SMG#20 5.0.0 Release 1996 version SMG#27 6.0.0 Release 1997 version SMG#29 7.0.0 Release 1998version TSG#06 8.0.0 Agreed to be created as a version 8 for Release 1999 History Document history V7.0.0 August 1999 Publication V8.0.0 January 2000
8b410df87e6e8f32e6bbafe6636ff843
06.07
1 Scope
The present document specifies the digital test sequences for the GSM half rate speech codec. These sequences test for a bit exact implementation of the half rate speech transcoder (GSMΒ 06.20Β [2]), Voice Activity Detector (GSMΒ 06.42Β [6]), comfort noise (GSMΒ 06.22Β [4]) and the discontinuous transmission (GSMΒ 06.41Β [5]).
8b410df87e6e8f32e6bbafe6636ff843
06.07
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. β€’ References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. β€’ For a specific reference, subsequent revisions do not apply. β€’ For a non-specific reference, the latest version applies. β€’ A non-specific reference to an ETS shall also be taken to refer to later versions published as an EN with the same number. β€’ For this Release 1999 document, references to GSM documents are for Release 1999 versions (version 8.x.y). [1] GSMΒ 01.04: "Digital cellular telecommunications system (Phase 2+); Abbreviations and acronyms". [2] GSMΒ 06.20: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Half rate speech transcoding". [3] GSMΒ 06.21: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Substitution and muting of lost frame for half rate speech traffic channels". [4] GSMΒ 06.22: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Comfort noise aspects for half rate speech traffic channels". [5] GSMΒ 06.41: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Discontinuous Transmission (DTX) for half rate speech traffic channels". [6] GSMΒ 06.42: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Voice Activity Detector (VAD) for half rate speech traffic channels". [7] GSMΒ 06.06: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; ANSI‑C code for the GSM half rate speech codec". [8] GSMΒ 06.02: "Digital cellular telecommunications system (PhaseΒ 2+); Half rate speech; Half rate speech coding functions".
8b410df87e6e8f32e6bbafe6636ff843
06.07
3 Definitions and abbreviations
8b410df87e6e8f32e6bbafe6636ff843
06.07
3.1 Definitions
Definition of terms used in the present document can be found in GSMΒ 06.20Β [2], GSMΒ 06.21Β [3], GSMΒ 06.22 [4], GSMΒ 06.41Β [5] and GSMΒ 06.42Β [6].
8b410df87e6e8f32e6bbafe6636ff843
06.07
3.2 Abbreviations
For the purposes of the present document, the following abbreviations apply: ETS European Telecommunication Standard GSM Global System for Mobile communications For abbreviations not given in this clause, see GSMΒ 01.04Β [1].