Tropo Scripting Development Guide

conference() method

This joins two or more calls together so they can communicate simultaneously. Conference only applies to the voice channel. Prior to utilizing conference, you will first need an initial say to introduce the callers to the conference; see the code examples at the bottom of this page for reference.

usage

conference( conferenceId: String, {
    choices: String,
    mute: True | False,
    onChoice: Function,
    onEvent: Function,
    playTones: True | False,
    recognizer: String,
    terminator: String } )

parameters

conferenceId	Data Type: String	Default: (none)	Required
	This is the unique ID number that identifies the conference and is used by the calls to connect into the same conference session.

map parameters

choices	Data Type: String	Default: none	Optional
	The choices field defines a simple grammar that will be active for the prompting of the user for input. For more information, review the Collecting Input section of the Scripting Guide and the Asking for Input Tutorial.
mute	Data Type: True \| False	Default: false	Optional
	If set to true, the user will be muted in the conference.
onChoice	Data Type: Function	Default: "" (undefined)	Optional
	This registers an event handler that fires when a valid response is provided by a user.
onEvent	Data Type: Function	Default: "" (undefined)	Optional
	This registers an event handler that fires as a catch all for all events. See the Events section of the Scripting Guide for more information on possible events.
playTones	Data Type: True \| False	Default: false	Optional
	Identifies whether or not conference members can hear the tone generated when a a key on the phone is pressed.
recognizer	Data Type: String	Default: en-us	Optional
	Recognizer tells Tropo what language to listen for; the available options are: 'de-de' for German 'en-gb' for British English 'en-us' for US English 'es-es' for Castilian Spanish 'es-mx' for Mexican Spanish 'fr-ca' for French Canadian 'fr-fr' for French 'it-it' for Italian 'pl-pl' for Polish 'nl-nl' for Dutch
terminator	Data Type: String	Default: (none)	Optional
	This is the touch-tone key (also known as "DTMF digit") used to exit the conference.

events

choice event

return values

none

code samples

Javascript example

say("Welcome to the conference")
event = conference("1234", {
    mute : false,
    playTones: true
});

Javascript example 2

say("Welcome to the geek single hotline!")
conference("1337", {
    terminator: "*"})
say("We hope you had fun, call back soon!");

Ruby example

say "Welcome to the geek single hotline!"
conference "1234", {
  :terminator => "*"}
say "We hope you had fun, call back soon!"

additional links

none

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page