9 Generic Call Control Data Definitions

29.198-04-23GPPOpen Service Access (OSA) Application Programming Interface (API)Part 4: Call controlRelease 9Subpart 2: Generic call control Service Capability Feature (SCF)TS

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 in the present document but not defined in this clause are defined either in the common call control data definitions in 3GPP TS 29.198-4-1 or in the common data definitions which may be found in 3GPP TS 29.198-2.

9.1 Generic Call Control Event Notification Data Definitions

9.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.

9.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.

9.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.

9.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

9.2 Generic Call Control Data Definitions

9.2.1 IpCall

Defines the address of an IpCall Interface.

9.2.2 IpCallRef

Defines a Reference to type IpCall.

9.2.3 IpAppCall

Defines the address of an IpAppCall Interface.

9.2.4 IpAppCallRef

Defines a Reference to type IpAppCall

9.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.

9.2.6 IpAppCallControlManager

Defines the address of an IpAppCallControlManager Interface.

9.2.7 IpAppCallControlManagerRef

Defines a Reference to type IpAppCallControlManager.

9.2.8 IpCallControlManager

Defines the address of an IpCallControlManager Interface.

9.2.9 IpCallControlManagerRef

Defines a Reference to type IpCallControlManager.

9.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

9.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

9.2.12 TpCallAppInfoSet

Defines a Numbered Set of Data Elements of TpCallAppInfo.

9.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.

9.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.

9.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.

9.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

9.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

9.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

9.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

9.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

9.2.21 TpCallReportRequestSet

Defines a Numbered Set of Data Elements of TpCallReportRequest.

9.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.

9.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

9.2.24 TpCallEventCriteriaResultSet

Defines a set of TpCallEventCriteriaResult.

9.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.

Annex A (normative):
OMG IDL Description of Generic Call Control SCF

The OMG IDL representation of this specification is contained in text files gcc_data.idl and gcc_interfaces.idl (contained in archive 291980402V800IDL.ZIP) which accompany the present document.

Annex B (informative):
W3C WSDL Description of Generic Call Control SCF

The W3C WSDL representation of this specification is contained in zip file 291980402V800WSDL.ZIP, which accompanies the present document.

Annex C (informative):
Java™ API Description of the Call Control SCFs

The Java™ API realisation of this specification is produced in accordance with the Java™ Realisation rules defined in Part 1 of this specification series. These rules aim to deliver for Java™, a developer API, provided as a realisation, supporting a Java™ API that represents the UML specifications. The rules support the production of both J2SE™ and J2EE™ versions of the API from the common UML specifications.

The J2SE™ representation of this specification is provided as Java™ Code, contained in archive 291980402V800J2SE.ZIP that accompanies the present document.

The J2EE™ representation of this specification is provided as Java™ Code, contained in archive 291980402V800J2EE.ZIP that accompanies the present document.

Annex D (informative):
Description of Call Control Sub-part 2: Generic call control SCF for 3GPP2 cdma2000 networks

This annex is intended to define the OSA API Stage 3 interface definitions and it provides the complete OSA specifications. It is an extension of OSA API specifications capabilities to enable operation in cdma2000 systems environment. They are in alignment with 3GPP2 Stage 1 requirements and Stage 2 architecture defined in:

[1] 3GPP2 P.S0001-B: "Wireless IP Network Standard", Version 1.0, September 2000.

[2] 3GPP2 S.R0037-0: "IP Network Architecture Model for cdma2000 Spread Spectrum Systems", Version 2.0, May 14, 2002.

[3] 3GPP2 X.S0013: "All-IP Core Network Multimedia Domain", December 2003.

These requirements are expressed as additions to and/or exclusions from the 3GPP Release 8 specification.
The information given here is to be used by developers in 3GPP2 cdma2000 network architecture to interpret the 3GPP OSA specifications.