Skip Headers
Oracle® Communications Services Gatekeeper Communication Service Guide
Release 5.1

E37526-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

19 Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

This chapter describes the Parlay X 3.0 Third Party Call/Parlay 3.3 Multi-Party Call Control (MPCC) communication service in detail.

Overview of the Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC Communication Service

The Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service exposes the Parlay X 3.0 Third Party Call set of application interfaces.

The communication service acts as an Open Services Architecture (OSA) Parlay application to an internal Services Gatekeeper OSA/Parlay Gateway. It uses this gateway to access the MultiParty Call Control SCS. For information about the gateway, see "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper Oracle Communications Services Gatekeeper System Administrator's Guide.

For the exact version of the standards this communication service supports, see the appendix on standards and specifications in Oracle Communications Services Gatekeeper Concepts Guide.

Using the Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service, an application can:

  • Set up a uniquely identified call between one or more participants.

  • Add further participants to an established call.

  • Delete participants from an established call.

  • Transfer participants to other established calls.

  • Indicate charging information to be associated with the call session.

  • Indicate information on any media to be used in association with the call.

  • Interact with the functionality of other communication services, such as Audio Call to play audio to call participants or Call Notification to respond to previously established notifications.

  • Query Services Gatekeeper for the status of an established call or particular call participants.

  • Terminate an ongoing call it created.

How It Works

The Parlay X 3.0 Third Party Call communication service can be used by applications that need to set up calls to one or more participants, as, for example, in establishing a conference call. It can also be used to set up calls that also use the capabilities of other communication services (Audio Call or Call Notification).

The application first sets up the call session using the makeCallSession operation, passing in the address of at least one (the A-party) participant. In the most common case, the address of a second participant, the B-party, is also passed in.

Services Gatekeeper sends a request to establish the first call leg to the network and returns a unique identifier (callSessionIdentifier) to the application synchronously. This identifier allows the application to perform further administrative tasks on the call and provides any other communication services (Audio Call or Call Notification) access to the call at any point during the call session.

The call session identifier is returned to the application before the A-party goes off hook (answers). To receive information on the ongoing status of the call session, the application polls Services Gatekeeper, using the identifier and the getCallSessionInformation operation.

While the call is underway, the application can add additional parties, delete one or more parties, or transfer parties to and from other established call sessions, using the identifier returned during the call setup phase.

A call is terminated either by the application-facing interface or when the call participants hang up.

The Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service can use the same call session identifier to access the functionality of the Parlay X 3.0 Audio Call/Parlay 3.3 UI-MPCC communication service to play media to one or more call participants. It can access the functionality of the Parlay X 3.0 Call Notification/Parlay 3.3 MPCC communication service for third party call service, such as rerouting a "busy" address to a second predefined one.

Requests using the Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service flow only in one direction, from the application to the network. By itself this communication service supports only application-initiated functionality. Mobile-originated scenarios can be supported when this communication service is used in concert with Call Notification.

The Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service manages only the signalling, or controlling, aspect of a call. The call itself takes place in the underlying telecom network. Only parties residing on the same network can be controlled, unless:

  • The network plug-in connects to a media gateway controller.

  • One of the participants is connected to a signalling gateway so that, from a signalling point of view, all parties reside on the same network.

Application Interfaces

For information about the SOAP-based interface for the Parlay X 3.0 Third Party Call communication service, see the discussion of Parlay X 3.0 Interfaces in Oracle Communications Services Gatekeeper Application Developer's Guide.

Events and Statistics

The Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service generates Event Data Records (EDRs), Charging Data Records (CDRs), alarms, and statistics to assist system administrators and developers in monitoring the service.

For general information, see Appendix A, "Events, Alarms, and Charging."

Event Data Records

Table 19-1 listsIDs of the EDRs created by the Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC communication service. This does not include EDRs created when exceptions are thrown.

Table 19-1 Event Types Generated by Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

EDR ID Method Called

10000

addCallParticipant

10001

deleteCallParticipant

10002

endCallSession

10003

getCallParticipantInformation

10004

getCallSessionInformation

10005

makeCallSession

10006

transferCallParticipant

10007

eventReportRes

10008

eventReportErr

10009

callLegEnded

10010

callEnded

10011

createAndRouteCallLegErr

10012

getInfoRes

10013

getInfoErr


Charging Data Records

Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC-specific CDRs are generated under the following conditions:

  • After Services Gatekeeper has created the first call leg of a call session. This is not dependent on whether the participant has answered.

  • After a call participant has been added to a call session, deleted from a session, or transferred to or from another session.

  • When call information or call participant information has been successfully delivered to the application.

  • When the call is ended by the application.

Statistics

Table 19-2 maps methods invoked from either the application or the network to the transaction types collected by the Services Gatekeeper statistics counters.

Table 19-2 Methods and Transaction Types for Parlay X 3.0 Third Party Call /Parlay 3.3 MPCC

Method Transaction type

makeCallSession

TRANSACTION_TYPE_CALL_CONTROL_SERVICE_INITIATED

transferCallParticipant

TRANSACTION_TYPE_CALL_CONTROL_SERVICE_INITIATED

addCallParticipant

TRANSACTION_TYPE_CALL_CONTROL_SERVICE_INITIATED


Alarms

For the list of alarms, see Oracle Communications Services Gatekeeper Alarm Handling Guide.

Tunneled Parameters for Parlay X 3.0 Third Party Call / Parlay 3.3 MPCC

This section lists, by parameter key, the parameters that can be tunneled or defined in the <requestContext> element of an SLA.

tpc.parlay.makecallsession.first.party.anonymous

Description

Anonymous call flag.

Specifies whether the originating address is presented to the first participant in a call.

When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers a set of invocations of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the Presentation data element in the originatingAddress parameter on the first invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the Presentation data element is set to P_ADDRESS_PRESENTATION_RESTRICTED.

If false, the Presentation data element is set to P_ADDRESS_PRESENTATION_ALLOWED.

tpc.parlay.makecallsession.second.party.anonymous

Description

Anonymous call flag.

Specifies whether the originating address is presented to the second participant in a call.

When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers a set of invocations of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the Presentation data element in the originatingAddress parameter on the second invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the Presentation data element is set to P_ADDRESS_PRESENTATION_RESTRICTED.

If false, the Presentation data element is set to P_ADDRESS_PRESENTATION_ALLOWED.

tpc.parlay.addcallparticipant.anonymous

Description

Anonymous call flag.

Specifies whether the originating address is presented when a participant is added to an existing call.

When an application invokes the Parlay X 3.0 Third Party Call addCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the Presentation data element in the originatingAddress parameter on the invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the Presentation data element is set to P_ADDRESS_PRESENTATION_RESTRICTED.

If false, the Presentation data element is set to P_ADDRESS_PRESENTATION_ALLOWED.

tpc.parlay.transfercallparticipant.anonymous

Description

Anonymous call flag.

Specifies whether the originating address is presented when a participant is transferred from one call session to another.

When an application invokes the Parlay X 3.0 Third Party Call transferCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the Presentation data element in the originatingAddress parameter on the invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the Presentation data element is set to P_ADDRESS_PRESENTATION_RESTRICTED.

If false, the Presentation data element is set to P_ADDRESS_PRESENTATION_ALLOWED.

tpc.parlay.makecallsession.first.party.media.attach.explicitly

Description

Media attach flag.

Specifies whether the media is attached explicitly when a call is set up to the first participant.

When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers a set of invocations of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the connectionProperties parameter on the first invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the AttachMechanism data element is set to P_CALLLEG_ATTACH_EXPLICITLY. The attachMediaReq operation in the Parlay 3.3. MPCC interface IpCallLeg is also invoked.

If false, the AttachMechanism data element is set to P_CALLLEG_ATTACH_IMPLICITLY.

tpc.parlay.makecallsession.second.party.media.attach.explicitly

Description

Media attach flag.

Specifies whether the media is attached explicitly when a call is set up to the second participant.

When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers a set of invocations of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the connectionProperties parameter on the second invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the AttachMechanism data element is set to P_CALLLEG_ATTACH_EXPLICITLY. The attachMediaReq operation in the Parlay 3.3. MPCC interface IpCallLeg is also invoked.

If false, the AttachMechanism data element is set to P_CALLLEG_ATTACH_IMPLICITLY.

tpc.parlay.addcallparticipant.media.attach.explicitly

Description

Media attach flag.

Specifies whether the media is attached explicitly when a participant is added to an existing call.

When an application invokes the Parlay X 3.0 Third Party Call addCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the connectionProperties parameter on the second invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the AttachMechanism data element is set to P_CALLLEG_ATTACH_EXPLICITLY. The attachMediaReq operation in the Parlay 3.3. MPCC interface IpCallLeg is also invoked.

If false, the AttachMechanism data element is set to P_CALLLEG_ATTACH_IMPLICITLY.

tpc.parlay.transfercallparticipant.media.attach.explicitly

Description

Media attach flag.

Specifies whether the media is attached explicitly when a participant is transferred from one call session to another.

When an application invokes the Parlay X 3.0 Third Party Call transferCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.

This setting affects the value of the connectionProperties parameter on the second invocation of routeReq.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

Boolean

Value

If true, the AttachMechanism data element is set to P_CALLLEG_ATTACH_EXPLICITLY. The attachMediaReq operation in the Parlay 3.3. MPCC interface IpCallLeg is also invoked.

If false, the AttachMechanism data element is set to P_CALLLEG_ATTACH_IMPLICITLY.

tpc.parlay.maximum.duration

Description

Specifies the maximum duration of a call, in milliseconds.

Specifies whether the media is attached explicitly when a participant is transferred from one call session to another.

When a call has been in progress for the amount of time set by this parameter, the release operation in the Parlay 3.3. MPCC IpMultiPartyCall interface is invoked.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String with Long value

tpc.parlay.makecallsession.first.party.prefix

Description

Prefix to call participant address.

Adds this string as a prefix to the address specified as the first call participant when an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

Valid values are the digits 09.

tpc.parlay.makecallsession.second.party.prefix

Description

Prefix to call participant address.

Adds this string as a prefix to the address specified as the second call participant when an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

Valid values are the digits 09.

tpc.parlay.addcallparticipant.prefix

Description

Prefix to call participant address.

Adds this string as a prefix to the address specified as the call participant when an application invokes the Parlay X 3.0 Third Party Call addCallParticipant operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

Valid values are the digits 09.

tpc.parlay.transfercallparticipant.prefix

Description

Prefix to call participant address.

Adds this string as a prefix to the address specified as the call participant when an application invokes the Parlay X 3.0 Third Party Call transferCallParticipant operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

Valid values are the digits 09.

tpc.parlay.makecallsession.first.party.callappgenericinfo

Description

Call forwarding indicator.

Specifies the maximum number of allowed call forwarding hops for the address specified as the first call participant when an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation.When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.This setting affects the value of the P_CALL_APP_GENERIC_INFO element in the appInfo parameter of the routeReq operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

The string must be formatted as follows:

redirectionCounter = n

where n is the number of allowed call hops.Value range for n is 15.

Example

This example allows two hops:

redirectionCounter=2

tpc.parlay.makecallsession.second.party.callappgenericinfo

Description

Call forwarding indicator.

Specifies the maximum number of allowed call forwarding hops for the address specified as the second call participant when an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation.When an application invokes the Parlay X 3.0 Third Party Call makeCallSession operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.This setting affects the value of the P_CALL_APP_GENERIC_INFO element in the appInfo parameter of the routeReq operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

The string must be formatted as follows:

redirectionCounter = n

where n is the number of allowed call hops.Value range for n is 15.

Example

This example allows two hops:

redirectionCounter=2

tpc.parlay.addcallparticipant.callappgenericinfo

Description

Call forwarding indicator.

Specifies the maximum number of allowed call forwarding hops for the call participant when an application invokes the Parlay X 3.0 Third Party Call addCallParticipant operation.When an application invokes the Parlay X 3.0 Third Party Call addCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.This setting affects the value of the P_CALL_APP_GENERIC_INFO element in the appInfo parameter of the routeReq operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

The string must be formatted as follows:

redirectionCounter = n

where n is the number of allowed call hops.Value range for n is 15.

Example

This example allows two hops:

redirectionCounter=2

tpc.parlay.transfercallparticipant.callappgenericinfo

Description

Call forwarding indicator.

Specifies the maximum number of allowed call forwarding hops for the call participant when an application invokes the Parlay X 3.0 Third Party Call transferCallParticipant operation.When an application invokes the Parlay X 3.0 Third Party Call transferCallParticipant operation, this triggers an invocation of the routeReq operation in the Parlay 3.3. MPCC IpCallLeg interface.This setting affects the value of the P_CALL_APP_GENERIC_INFO element in the appInfo parameter of the routeReq operation.

Can be set using SLAs or parameter tunneling. An SLA setting overrides a tunneled parameter.

Format

String

Value

The string must be formatted as follows:

redirectionCounter = n

where n is the number of allowed call hops.Value range for n is 15.

Example

This example allows two hops:

redirectionCounter=2

Managing Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

This section describes the properties and workflow for the Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC plug-in instance.

This plug-in service is requires Orbacus, which is not installed by default. For information about installing Orbacus, see Oracle Communications Services Gatekeeper Installation Guide.

This plug-in service does not support multiple instantiation using the Plug-in Manager. There is a one-to-one mapping between plug-in service and plug-in instance. The plug-in instance is created when the plug-in service is started.

Properties for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

Table 19-3 lists the technical specifications for the communication service.

Table 19-3 Properties for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

Property Description

Managed object in Administration Console

domain_name > OCSG > server_name > Communication Services > Plugin_px30_third_party_call_parlay_mpcc

MBean

Domain=com.bea.wlcp.wlng

Name=wlng_nt

InstanceName=Plugin_px30_third_party_call_parlay_mpcc

Type=com.bea.wlcp.wlng.plugin.tpc.parlay.management.ThirdPartyCallMBean

Network protocol plug-in service ID

Plugin_px30_third_party_call_parlay_mpcc

Network protocol plug-in instance ID

Plugin_px30_third_party_call_parlay_mpcc

Supported Address Scheme

tel

Application-facing interface

com.bea.wlcp.wlng.px30.plugin.ThirdPartyCallPlugin

Service type

ThirdPartyCall

Exposes to the service communication layer a Java representation of:

Parlay X 3.0 Part 2: Third Party Call

Interfaces with the network nodes using:

Open Service Access (OSA); Application Programming Interface (API); Part 4: Call Control SCF; Subpart 7: MultiParty Call Control Service

Deployment artifacts

Plugin_px30_third_party_call_parlay_mpcc.jar, packaged in wlng_nt_third_party_call_px30.ear

px30_third_party_call.war, packaged in wlng_at_third_party_call_px30.ear


This plug-in service does not support multiple instantiation using the Plug-in Manager. There is a one-to-one mapping between the plug-in service and the plug-in instance. The plug-in instance is created when the plug-in service is started.

Configuration Workflow for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

Following is an outline for configuring the plug-in using the Administration Console or an MBean browser.

  1. Select the MBean detailed in "Properties for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC".

  2. Configure the attributes of the plug-in instance:

  3. Gather information about the OSA Gateway and configure the plug-in instance accordingly. The following information needs to be obtained from the OSA Gateway administrator and configured in the OSA Access service:

    • OSA/Parlay SCS type to be used in the lookup (service discovery) phase when requesting the service (OSA/Parlay SCS) from the OSA/Parlay Gateway. Typically this is P_MULTI_PARTY_CALL_CONTROL.

    • OSA/Parlay service properties to be used in the lookup (service discovery) phase when requesting a service (OSA/Parlay SCS) from the OSA/Parlay Gateway. This depends on the OSA Gateway implementation.

    • Authentication type used by the OSA/Parlay Framework.

    • Encryption method used for the connection with the OSA Gateway.

    • Signing algorithm used when signing the Service Level Agreement (SLA) with the OSA/Parlay Framework.

  4. Set up the OSA Client and the OSA Client Mappings. See "Creating an OSA Client" and "Mapping the OSA client to an OSA Gateway and an OSA/Parlay SCS" in "Managing OSA/Parlay Gateway Connections using Parlay_Access" in Oracle Communications Services Gatekeeper System Administrator's Guide.

  5. Set up the routing rules to the plug-in instance. See "Managing and Configuring the Plug-in Manager" in Oracle Communications Services Gatekeeper System Administrator's Guide. Use the plug-in instance ID and address schemes detailed in the "Properties for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC" section.

  6. If required, create and load a node SLA. For details see "Defining Global Node and Service Provider Group Node SLAs" and "Managing SLAs" in the Oracle Communications Services Gatekeeper Accounts and SLAs Guide.

  7. Provision the service provider accounts and application accounts. For information, see Oracle Communications Services Gatekeeper Accounts and SLAs Guide.

Management Operations for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

The following operations are related to management:

Reference: Attributes and Operations for Parlay X 3.0 Third Party Call/Parlay 3.3 MPCC

This section describes the attributes and operations for configuration and maintenance:

Attribute: CallGetInfoReqConfig (read-only)

Scope: Cluster

Unit: Not applicable

Format: String

Indicates the current configuration for the getInfoReq operation in the IpMultiPartyCall interface. The information includes:

  • Supported: Boolean that indicates if the operation is supported.

  • PCallInfoTimes: Boolean that indicates if the P_CALL_INFO_TIMES tag is present in the operation.

  • PCallInfoReleaseCause: Boolean that indicates if the P_CALL_INFO_RELEASE_CAUSE tag is present in the operation.

Use "Operation: configCallGetInfoReq" to change these settings.

Attribute: CallingParticipantNameMandantory

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies if the callingParticipantName parameter in the makeCallSession operation should be used as the original address.

If callingParticipantName is required, it must be in the form of a string that can be translated to a URI; for example: tel:123456.

Enter:

  • true if callingParticipantName should be used as the originating address.

  • false otherwise.

Attribute: ChangeMediaAllowed

Scope: Server

Unit: Not applicable

Format: Boolean

Specifies if an end user (a call participant) is allowed to change the media used in the call.

  • true if an end user is allowed to change media for an existing call session.

    For an end user to change the media type for a given call session the following conditions are required:

    • This attribute must be true.

    • The application must have allowed the end user to change media when the call session was established by the makeCallSession operation.

    • "Attribute: MultiMediaSupported" must also be true.

  • false if an end user is not allowed to change media for an existing call session.

Attribute: ChargingAllowed

Scope: Server

Unit: Not applicable

Format: Boolean

Specifies whether charging is allowed.

  • true if an application is allowed to specify charging information when creating a call session by the makeCallSession operation.

  • false otherwise.

Attribute: LegGetInfoReqConfig (read-only)

Scope: Cluster

Unit: Not applicable

Format: String

Indicates the current configuration for the getInfoReq operation in the IpCallLeg interface. The information includes:

  • Supported: Boolean that indicates if the operation is supported.

  • PCallLegInfoTimes: Boolean that indicates if the P_CALL_LEG_INFO_TIMES tag is present in the operation.

  • PCallLegInfoReleaseCause: Boolean that indicates if the P_CALL_LEG_INFO_RELEASE_CAUSE tag is present in the operation.

  • PCallLegInfoAddress: Boolean that indicates if the P_CALL_LEG_INFO_ADDRESS tag is present in the operation.

  • PCallLegInfoAppInfo: Boolean that indicates if the P_CALL_LEG_INFO_APPINFO tag is present in the operation.

Use "Operation: configLegGetInfoReq" to change these settings.

Attribute: MaximumDurationEnforced

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies if a call whose duration exceeds the maximum value will be terminated.

Enter:

  • true to terminate the call.

  • false to allow the call to continue.

Attribute: MultiMediaSupported

Scope: Cluster

Unit: Not applicable

Format: Boolean

Indicates if multimedia is supported.

  • true if multimedia is supported.

  • false if multimedia is not supported.

Attribute: MaximumParticipants

Scope: Server

Unit: Not applicable

Format: Integer

Specifies the maximum number of participants in a call.

Valid values are 265535.

Attribute: StatusRetentionTime

Scope: Server

Unit: Seconds

Format: Integer

Specifies the length of time information about a call is stored after the call is terminated.

Valid values are 065535.

Operation: configCallGetInfoReq

Scope: Cluster

Configures the parameters in the getInfoReq operation in the IpMultiPartyCall interface.

Signature:

configCallGetInfoReq(Supported: Boolean, PCallInfoTimes: Boolean, PCallInfoReleaseCause: Boolean)

Table 19-4 configCallGetInfoReq Parameters

Parameter Description

Supported

Specifies if the operation is supported by the OSA/Parlay Gateway.

PCallInfoTimes

Specifies if the P_CALL_INFO_TIMES tag should be present in TpCallInfoType.

Use:

  • true to add it to TpCallInfoType.

  • false otherwise.

PCallInfoReleaseCause

Specifies if the P_CALL_INFO_RELEASE_CAUSE tag should be present in TpCallInfoType.

Use:

  • true to add it to TpCallInfoType.

  • false otherwise.


Operation: configLegGetInfoReq

Scope: Cluster

Configures the parameters in the getInfoReq operation in the IpCallLeg interface.

Signature:

configLegGetInfoReq(Supported : Boolean, PCallLegInfoTimes : Boolean, PCallLegInfoReleaseCause : Boolean, PCallLegInfoAddress : Boolean, PCallLegInfoAppInfo : Boolean)

Table 19-5 configLegGetInfoReq Parameters

Parameter Description

Supported

Specifies if the operation is supported by the OSA/Parlay Gateway.

PCallLegInfoTimes

Specifies if the P_CALL_LEG_INFO_TIMES tag should be present in TpCallLegInfoType.

Use:

  • true to add it to TpCallLegInfoType.

  • false otherwise.

PCallLegInfoReleaseCause

Specifies if the P_CALL_LEG_INFO_RELEASE_CAUSE tag should be present in TpCallLegInfoType.

Use:

  • true to add it to TpCallLegInfoType.

  • false otherwise.

PCallLegInfoAddress

Specifies if the P_CALL_LEG_INFO_ADDRESS tag should be present in TpCallLegInfoType.

Use:

  • true to add it to TpCallLegInfoTyp.e

  • false otherwise.

PCallLegInfoAppInfo

Specifies if the P_CALL_LEG_INFO_APPINFO tag should be present in TpCallLegInfoType.

Use:

  • true to add it to TpCallLegInfoType.

  • false otherwise.


Operation: getCallLegs

Scope: Cluster

Displays a list of IDs for all call legs in a call session.

Signature:

getCallLegs(CallSessionId: String)

Table 19-6 getCallLegs Parameters

Parameter Description

CallSessionId

ID of the call session to list call legs for


Operation: getCallSessionInfo

Scope: Cluster

Displays information about a call session. This includes:

  • callSessionId: The ID of the call session.

  • callStatus: The current status of the call. The status is one of:

    • Established, during call duration.

    • Terminated, when the call has terminated but information is still present in the internal storage: see "Attribute: StatusRetentionTime" for more information.

    • Expired, when the call is terminated and information is no longer available.

  • originalAddress: The originator (a-party) of the call.

  • appInstGrpId: The application instance ID associated with the application that created the call session.

  • callRef: The CORBA reference to the call object in the Parlay Gateway (IpMultiPartyCall).

  • srcPlugin: the type of plug-in instance that initiated the call. The type is one of:

    • ThirdPartyCall

    • CallNotification

    • CallDirection

Signature:

getCallSessionInfo(CallSessionId: String)

Table 19-7 getCallSessionInfo Parameters

Parameter Description

CallSessionId

ID of the call session to get information about.


Operation: getCallLegSessionInfo

Scope: Cluster

Displays information about a call leg in a call session.

  • id: The CORBA reference to the call leg object in the Parlay Gateway (IpCallLeg).

  • callSessionId: The ID of the call session.

  • callParticipantIdentifier: The URI identifying the terminal associated with the call leg.

  • callParticipantStatus: The status of the call participant. The status is one of:

    • Initial, during call setup.

    • Connected, during call duration.

    • Terminated, the participant has left the call.

  • callParticipantStartTime: The time the call participant was connected to the call.

  • callParticipantEndTime: The time the call participant was disconnected from the call.

  • callParticipantDuration: The duration of the call for the participant. Given in seconds.

  • callParticipantTerminationCause: The cause of the participant leaving the call. One of:

    • Noanswer, no answer from the participant.

    • Busy, the participant was busy (off-hook)

    • Hangup, the participant went on-hook.

    • Notreachable, could not reach the participant.

    • Aborted, the call was terminated for a reason other than Hangup.

  • appInstGrpId: the application instance associated with the application that created the call session.

  • callRef: The CORBA reference to the call object in the Parlay Gateway (IpMultiPartyCall).

  • srcPlugin: The type of plug-in instance that initiated the call. The type is one of:

    • ThirdPartyCall

    • CallNotification

    • CallDirection

Signature:

getCallLegSessionInfo(CallLegSessionId: String)

Table 19-8 getCallLegSessionInfo Parameters

Parameter Description

CallLegSessionId

ID of the call leg session to get information about.


Operation: listCallSessionIds

Scope: Cluster

Displays a list of IDs for ongoing call sessions. These are the Parlay X 3.0 call session IDs.

Signature:

listCallSessionIds()

Operation: countPendingCallSession

Scope: Server

Displays the number of ongoing call sessions for this plug-in instance.

Signature:

countPendingCallSession()