Components Library
Conference Bridge
The Conference Bridge component allows multiple parties to dial in to a single call.
Configuration parameters:
- Conference ID
- Announcement message
- Hold music
- Settings
- Events
Options:
- Conference_name (required) Name of the conference bridge
- Announcement Message to be played when a dialer is added into the conference. Speak Text and Play Audio are the types of messages. In a Speak Text message, you can configure the message to speak, language, and voice. In a Play Audio message, you can specify a URL to an audio file or upload an audio file.
- Waiting callers You can play music to users waiting for a conference to start. You can specify a URL to an audio file or upload an audio file to be played until the moderator joins the conference.
- Miscellaneous You can play a beep or double beep to all callers in the conference when a new caller is added to or removed from the conference. Callers can be muted when joining a conference.
- Record Audio This option is used to decide how the calls are recorded. Calls can be recorded dynamically by passing these values:
Recording = True | Recording = False |
Any integer | 0 |
TrueCase insensitive | FalseCase insensitive |
Object, String | Empty |
Null |
States:
The Conference Bridge component is set to Completed state when there are no callers on the conference bridge. Itβs set to Failed state when an error occurs.
Variables:
- from Phone number or SIP endpoint from which the call is made
- direction Direction of the call can be set to
outbound
orinbound
- caller_name Name of the caller. Defaults to the from phone number or SIP endpoint
- to Phone number or SIP endpoint to which the call is made
- event Latest triggered event in the component. Can take the values ConferenceEnter, ConferenceExit, or Redirect.
- bill_rate Unit rate applicable for the call
- call_status Status of the call β set to
in-progress
- conference_name Name of the conference bridge
- call_uuid UUID of the incoming call
- conference_uuid UUID of the conference
- member_id ID of a member in a conference. A unique ID is assigned to each member in a conference.
- to_iso2 ISO alpha-2 code of the country to which the to phone number belongs
- from_iso2 ISO alpha-2 code of the country to which the from phone number belongs
- to_country Country to which the to phone number belongs
- from_country Country to which the from phone number belongs