SetupConference

SetupConference method sets up a conference call for the addition of the third party.

Function mCall.SetupConference(
NumParties As Long) As Boolean

Parameters

 

NumParties

The expected number of parties in the conference call. This number is passed to the service provider. The service provider is free to do as it pleases with this number: ignore it, use it as a hint to allocate the right size conference bridge inside the switch, and so on.

Return Values

If the function succeeds, the return TRUE, otherwise return FALSE. Use ErrCode property to get the error code if return FALSE.

 

Remarks

Use ITAPLine.ConfCall property to obtain the instance of ITAPICall dentifying the newly created conference call. The application is the initial sole owner of this call. The call state of ConfCall is not applicable.
Use ITAPILine.ConsultCall property return a new temporary call (consultation call) is automatically allocated. Initially, the application is the sole owner for this call.

The SetupConference method provides two ways to establish a new conference call, depending on whether a normal two-party call is required to pre-exist or not. When setting up a conference call from an existing two-party call, the mCall is a valid call that is initially added to the conference call by the SetupConference request;

The conference call typically transitions into the onHoldPendingConference state, the consultation call into the dialtone state, and the initial call (if there is one) into the conferenced state.

A conference call can also be set up by a CompleteTransfer that is resolved into a three-way conference. The application may be able to toggle between the consultation call and the conference call using SwapHold.

A consultation call can be canceled by invoking Drop on it. When dropping a consultation call, the existing conference call typically transitions back to the connected state. The application should observe the OnCallStateChange event to determine exactly what happens to the calls. For example, if the conference call reverts back to a regular two-party call, the conference call becomes idle and the original participant call can revert to connected.

If an application specifies the handle of the original call (mCall) in a call to the Unhold function, both the conference call and the consultation call typically go to idle.

 

See Also

CompleteTransfer , SwapHold, Drop ,Unhold