Common Call Control Data Types
29.198-04-13GPPOpen Service Access (OSA) Application Programming Interface (API)Part 4: Call controlRelease 9Subpart 1: Call control common definitionsTS
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.
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.
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 |
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 sent 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. |
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 |
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 |
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). |
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. |
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 |
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 |
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 |
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.
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 |
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 |
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. This data type is identical to a TpInt32.
Name | Value | Description |
P_CALL_LOAD_CONTROL_ADMIT_NO_CALLS | 0 | Infinite interval (do not admit any calls) |
1 – 60000 | Duration in milliseconds |
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 |
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 |
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 |
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 |
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 |
TpCallServiceCodeSet
Defines a Numbered Set of Data Elements of TpCallServiceCode.
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. |
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. |
P_CALL_SUPERVISE_QOS_PARAM_CHANGE | 10h | The Quality of Service parameters were renegotiated during the active call. |
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 |
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 |
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 |
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) |
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 |
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 Common Call Control Data Types
The OMG IDL representation of this interface specification is contained in the text file common_cc_data.idl (contained in archive 2919804-1V800IDL.ZIP) which accompanies the present document.
Annex B (informative):
W3C WSDL Description of Common Call Control Data Types
The W3C WSDL representation of this interface specification is contained in zip file 2919804-1V800WSDL.ZIP, which accompanies the present document.
Annex C (informative):
Java API Description of the Call Control SCFs
The Java API realisation of this interface specification is produced in accordance with the Java Realisation rules defined in Part 1 of this specification. 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 interface specification is provided as Java Code, contained in archive 2919804-1V800J2SE.ZIP that accompanies the present document.
The J2EE representation of this interface specification is provided as Java Code, contained in archive 2919804-1V800J2EE.ZIP that accompanies the present document.
Annex D (informative):
Description of Call Control Sub-part 1: Call Control Common Definitions 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 specification.
The information given here is to be used by developers in 3GPP2 cdma2000 network architecture to interpret the 3GPP OSA specifications.