Tropo is part of CiscoLearn More

conference

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 four hours, so any conference call will also have a maximum uptime of four hours before sessions will begin to disconnect.

Parameters

conferenceId

String
(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

String or Array
Default: 
* (any signal)

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 an empty string (""), 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

Integer

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.

joinPrompt

Boolean or Hash
Default: 
false

Defines a prompt that plays to all participants of a conference when someone joins the conference. If set to true, the default beep is played, however it's possible to define either TTS or an audio URL using additional attributes value and voice

  • value is used to play simple TTS and/or an audio URL, and supports SSML
  • voice is used to define which of the available voices should be used for TTS; if voice is left undefined, the default voice will be used

leavePrompt

Boolean or Hash
Default: 
false

Defines a prompt that plays to all participants of a conference when someone leaves the conference. If set to true, the default beep is played, however it's possible to define either TTS or an audio URL using additional attributes value and voice

  • value is used to play simple TTS and/or an audio URL, and supports SSML
  • voice is used to define which of the available voices should be used for TTS; if voice is left undefined, the default voice will be used

mute

Boolean
Default: 
false

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

Function

This registers an event handler that fires if the terminator is used to disconnect instead of hanging up.

onError

Function
Default: 
none

Fires if there is a system error while joining the conference.

onHangup

Function
Default: 
none

This registers an event handler that fires when the user disconnects or hangs up.

onSignal

Function

This specifies a callback function to run if the function is interrupted by a signal. Review documentation on sending interrupts here.

playTones

Boolean
Default: 
false

Identifies whether or not conference members can hear the tone generated when a key on the phone is pressed. If using Python, make sure to use True and False instead of true and false.

terminator

String
Default: 
#

This is the touch-tone key (also known as "DTMF digit") used to exit the conference.

promptLogSecurity

String
Default: 
none

Controls whether Tropo logs the text to speech string used by the method. Possible values are "none" (the default) and "suppress", which disables output logging for this method. See Log Suppression for complete details and examples.

Examples

  conference("1337", {
    terminator: "*",
    playTones: true,
    joinPrompt: {
      value: "Someone has joined the conference",
      voice: "Zoe"
    },
    leavePrompt: {
      value: "http://example.com/leave.wav"
    }
    onChoice: function(event) {
        say("Disconnecting");
        }
    });
say("We hope you had fun, call back soon!");  
say "Welcome to the geek single hotline!"
conference "1337", {
  :terminator => "*",
  :playTones => true,
  :onChoice => lambda { |event| 
        say("Disconnecting")    
   }},
  :joinPrompt => {
    :value => "Someone has joined the conference",
    :voice => 'Zoe'
  },
  :leavePrompt => {
    :value => "http://example.com/leave.wav"
  }
say "We hope you had fun, call back soon!"
<?php
 
say("Welcome to the geek singles hotline!");
conference("1337", array(
   "terminator"=>"*",
   "joinPrompt" => array(
      "value" => "Someone has joined the conference",
      "voice" => 'Zoe'
    ),
    "leavePrompt" => array(
      "value" => "http://example.com/leave.wav"
    ),
   "playTones" => true,
    "onChoice" => "choiceFCN"
    )
);
function choiceFCN($event) {
    say("Disconnecting");
    }
say("We hope you had fun, call back soon!");
 
?>
say("Welcome to the geek singles hotline!")
conference("1337", {
    "terminator":"*",
    "playTones":True,
    "joinPrompt" : {
      "value" : "Someone has joined the conference",
      "voice" : 'Zoe'
    },
    "leavePrompt" : {
      "value" : "http://example.com/leave.wav"
    },
    "onChoice": lambda event : say("Disconnecting")
})
say("We hope you had fun, call back soon!")
say("Welcome to the geek singles hotline!")
conference("1337", [
    terminator: "*",
    playTones : true,
    joinPrompt : [
      value : "Someone has joined the conference",
      voice : 'Zoe'
    ],
    leavePrompt : [
      value : "http://example.com/leave.wav"
    ],
    onChoice: { event->
        say "Disconnecting"}
])
say("We hope you had fun, call back soon!")