{"conference":} object

This object allows multiple lines in separate sessions to be conferenced together so that the parties on each line can talk to each other simultaneously. This is a voice channel only feature.

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.

Fields

id
Data Type: 
String
Default: 
undefined
Required

This defines the id/name of the conference room to create.

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: (none) 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.

joinPrompt
Data Type: 
Boolean or Hash
Default: 
false
Optional

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
Data Type: 
Boolean or Hash
Default: 
false
Optional

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
Data Type: 
Boolean
Default: 
false
Optional

Adds the user to the conference room with their audio muted.

name
Data Type: 
String
Default: (none) Required

This is the key used to identify the result of an operation, so you can differentiate between multiple results. As an example, if you asked the user for their favorite color, you could set the name value as 'color' while the returned value might be 'blue'. Not particularly useful if there's only one result returned, but if there are multiple results it helps to determine which result belonged to which operation.

playTones
Data Type: 
Boolean
Default: 
false
Optional

This defines whether to send touch tone phone input to the conference or block the audio.

required
Data Type: 
Boolean
Default: 
true
Optional

This determines whether Tropo should move on to the next verb; if required is set to 'true', Tropo will only move on to the next verb if the current operation completely successfully.

terminator
Data Type: 
String
Default: (none) Optional

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

Examples

Example

{    
    "tropo": [
        {
            "conference": {
                "playTones":true,
                "name": "foo",
                "terminator": "#",
                "id": "1234",
                "mute": false
            }
        }
    ]
}