Conference

Creates a conference bridge that other callers can join.

A host caller initiates a conference call (which generates a Conference ID). Subsequent callers may join the conference call using the JOIN action by providing the unique conference ID obtained in the original Conference action. For one possible method to communicate this ID to other call scripts, see the PUTVALUE action and the GETVALUE  action.

The Conference action is helpful for simple bridges of three or fewer callers.

To leave a conference call, use the Leave action.

Dependencies

  • The Conference action is not used in myAgent when conferencing other callers because there is a built-in conferencing tool.
  • The built-in conferencing tool in myAgent has the same limitations as the Callback action.

Supported Script Types

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

Phone

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

ConferenceIDVar

A variable that receives a unique conference identifier. Callers can use this ID to join a conference.

NumParticipants

When callers join the conference, the OnJoin interrupt event will trigger (if scripted). When this happens, the NumParticipants variable will be updated with the current number of conference participants.The current CXone implementation limits conference sizes to 3 parties.

ParticipantIDVar

When callers join the conference, the OnJoin interrupt event will trigger (if scripted). When this happens, the ParticipantID var will contain the contact IDClosed A unique numerical identifier assigned to each contact of the joining call.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

Default Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnJoin Path taken when a new participant joins the conference call. This type of branch condition is known as an Interrupt event since it will trigger "out of context". This means, if this condition is scripted, when a caller joins the conference, whatever the script was doing will be interrupted and the On Join branch condition will be followed.
OnLeave Path taken when a participant leaves the conference call either because they hung up or because the Leave action was executed. This type of branch condition is known as an Interrupt event since it will trigger "out of context". This means that if this branch condition is scripted, when a caller leaves the conference, whatever the script was doing will be interrupted and the On Leave branch condition will be followed.
Error Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Script Example

This is an example to show how this action can be used in scripts. It is not intended to be a complete script. Additional scripting may be required.

Because Conference is used so infrequently, the recommended best practice is to work with NICE CXone Professional Services if you want to use it in a script. As such, no sample scripts will be provided here.