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.

Since Tropo is synchronous, conference is a blocking method. This means no other method can run until the conference is complete.

Any conference ID you use in production will be shared among all your production applications; likewise any development app conference IDs are shared among all your development apps. These IDs are not shared with other accounts, so if you have conference ID 1234, you won't conflict if another Tropo user is also using 1234.

Each conference can hold up to 100 people at one time - if you need more, let us know and we can help. Note that the maximum session time with Tropo is 2 hours, so any conference call will also have a maximum uptime of 2 hours before sessions will begin to disconnect.

Check out this example for more information.

usage

conference( conferenceId: String, {
    allowSignals: String or Array,
    interdigitTimeout: Integer,
    mute: Boolean,
    onChoice: Function,
    onSignal: Function,
    playTones: Boolean,
    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

allowSignals	Data Type: String or Array	Default: * (any signal)	Optional
	This parameter allows you to assign a signal to this function. Events from the Tropo REST API with a matching signal name will "interrupt" the function (i.e., stop it from running). If it already ran and completed, your interrupt request will be ignored. If the function has not run yet, the interrupt will be queued until it does run. By default, allowSignals will accept any signal as valid; if you define allowSignals as "", it defines the function as "uninterruptible". You can also use an array - the function will stop if it receives an interrupt signal matching any of the names in the array.
interdigitTimeout	Data Type: Integer	Default: "" (undefined)	Optional
	For conference, record and transfer, interdigitTimeout defines how long the user needs to wait - in seconds - before Tropo will recognize another key press. Essentially, this means if a user presses the wrong key to terminate the session (say * instead of #), how long do you want Tropo to wait before letting them try again.
mute	Data Type: Boolean	Default: false	Optional
	If set to true, the user will be muted in the conference. If using Python, make sure to use True and False instead of true and false.
onChoice	Data Type: Function	Default: "" (undefined)	Optional
	This registers an event handler that fires if the terminator is used to disconnect instead of hanging up.
onSignal	Data Type: Function	Default: (none)	Optional
	This specifies a callback function to run if the function is interrupted by a signal. Review documentation on sending interrupts here.
playTones	Data Type: Boolean	Default: false	Optional
	Identifies whether or not conference members can hear the tone generated when a a key on the phone is pressed. If using Python, make sure to use True and False instead of true and false.
terminator	Data Type: String	Default: (none)	Optional
	This is the touch-tone key (also known as "DTMF digit") used to exit the conference.

events

event

return values

none

code samples

JavaScript example

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

Ruby example

say "Welcome to the geek single hotline!"
conference "1337", {
  :terminator => "*",
  :playTones => true,
  :onChoice => lambda { |event| 
        say("Disconnecting")    
   }}
say "We hope you had fun, call back soon!"

PHP example

<?php

say("Welcome to the geek singles hotline!");
conference("1337", array(
   "terminator"=>"*",
   "playTones" => true,
    "onChoice" => "choiceFCN"
    )
);
function choiceFCN($event) {
    say("Disconnecting");
    }
say("We hope you had fun, call back soon!");

?>

Python example

say("Welcome to the geek singles hotline!")
conference("1337", {
    "terminator":"*",
    "playTones":True,
    "onChoice": lambda event : say("Disconnecting")
})
say("We hope you had fun, call back soon!")

Groovy sample

say("Welcome to the geek singles hotline!")
conference("1337", [
    terminator: "*",
    playTones : true,
    onChoice: { event->
        say "Disconnecting"}
])
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