Dial conferenceName

The dial conferenceName command can be used for starting a named conference call. Any name can be used for a conference. The name of a conference must be unique across all conference calls that you are currently running.

There are default conference properties, however all of these can be overridden should you choose to. Conference properties can be specified within a conferenceProperties element. Within the conferenceProperties element, the following can be specified:

  • beepsOnEnter - “0”, “1”, “2”, default “0”. Allows one or two beeps to be played when someone enters the conference

  • speakOnEnter - allows a speak command command to be specified, with the text spoken when a caller enters the conference

  • beepsOnExit - “0”, “1”, “2”, default “0”. Allows the one or two beeps to be played when someone exits the conference

  • speakOnExit - allows a speak command command to be specified, with the text spoken when the caller exits the conference.

  • playOnExit - allows a play command command to be specified, with the URL requested, i.e. audio played, when a caller exits the conference.

  • endOnExit - true/false, default false. If any member of the conference enters with this set to true, once they leave all other members of the conference are kicked out, and the conference ends.

JSON Examples

The following examples demonstrate how you can use the dial conferenceName command

  • Starting a conference with default conference properties, i.e. specifying no overridden values using the conferenceProperties element:
	{
	"commands": [
		{
	  	"dial": {
				"conferenceName": "myConference"
			}
		}
	    ]
	}

This will place the caller in the named conference call myConference. If the caller is the first person in the conference call they will hear music until a second person enters the conference If subsequent callers are added to myConference then all callers are added to the call and can participate when added. In this case all defaults are used for the conference properties as there has been no conferenceProperties element included

XML Examples

The same dial conferenceName JSON commands can be described in XML as follows

  • Starting a conference with default conference properties
	<?xml version="1.0" encoding="UTF-8"?>
	<tns:modifyCall xmlns:tns="http://api.bluevia.com/schemas/comms/v1" xmlns:tns1="http://api.bluevia.com/schemas/common/v2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.bluevia.com/schemas/comms/v1 api.bluevia.com_comms_v1_0.xsd ">
	  <tns:commands>
	    <tns:dial>
	    	<tns:conferenceName>myConference</tns:conferenceName>
	    </tns:dial>
	  </tns:commands>
	</tns:modifyCall>