Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide
10-12
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 10 Call Object
Methods
Conference
The Conference method either begins a new conference call or adds an additional call to an existing
conference call. When it begins a new conference call, it combines an original two-party call with a
two-party consult call (where the two calls have a common party) into a single three party call. Only the
common party (which is called the “Conference Controller”) can call this method to make the new
conference call. This method may be called on either of the Conference Controller’s calls.
conference call. When it begins a new conference call, it combines an original two-party call with a
two-party consult call (where the two calls have a common party) into a single three party call. Only the
common party (which is called the “Conference Controller”) can call this method to make the new
conference call. This method may be called on either of the Conference Controller’s calls.
Syntax
C++:
int Conference();
int Conference(Arguments& optional_args)
COM:
HRESULT Conference ( /*[in, optional]*/ IArguments *optional_args, (/*[out,
retval]*/ int * errorcode )
VB:
Conference([optional_args As IArguments]) As Long
Java:
int Conference(Arguments optional_args)
.NET:
CilError Conference(Arguments optional_args)
Parameters
optional_args
An optional input parameter, which is a pointer or reference to an Arguments array that contains a
member with the string value that is the UniqueObjectID of the call to which this call should be
conferenced. If this argument is used, it should be added to the Arguments parameter with the
keyword of “CallReferenceObjectID”. This would only be necessary in an environment where there
are multiple held calls and the request is being made through the talking call. If the request is being
made through a specific held call in this scenario, or if there are only two calls at the device, this
parameter is unnecessary.
member with the string value that is the UniqueObjectID of the call to which this call should be
conferenced. If this argument is used, it should be added to the Arguments parameter with the
keyword of “CallReferenceObjectID”. This would only be necessary in an environment where there
are multiple held calls and the request is being made through the talking call. If the request is being
made through a specific held call in this scenario, or if there are only two calls at the device, this
parameter is unnecessary.
errorcode
An output parameter (return parameter in VB) that contains an error code from
Return Value
Default CTI OS return values. See
Remarks
Before making this request, it is necessary for the original call to be in the held state and the consult call
to be in the talking state or the request will fail. Therefore, if the calls are alternated (see Alternate), they
must be alternated again to return the two calls to their appropriate states.
to be in the talking state or the request will fail. Therefore, if the calls are alternated (see Alternate), they
must be alternated again to return the two calls to their appropriate states.
If there are only two calls at the device, this method may be called using either the current or held call.
For switches which allow more than two calls at a device (for example G3), make this request through
the desired held call to avoid the ambiguity caused by multiple held calls at the device. Otherwise,
indicate the desired held call using the optional parameter.
For switches which allow more than two calls at a device (for example G3), make this request through
the desired held call to avoid the ambiguity caused by multiple held calls at the device. Otherwise,
indicate the desired held call using the optional parameter.
The Conference request must be made via a call whose call status is LCS_CONNECT or LCS_HELD
or it will fail.
or it will fail.
On certain switches (notably Unified CCE), only the Conference Controller (the party that first initiated
the conference call) may add additional parties to an existing conference call.
the conference call) may add additional parties to an existing conference call.