Conference Call Flow Attributes

This section describes meeting attributes that can be applied at the following Conference levels: Meeting Room, DID, DID Group, Account, or Call Flow.

Attributes Hierarchy

The base call flow attributes are set at the Call Flow level and are available for reading only. The system will use the following priority order for the attributes:

  1. Meeting Room level (the highest priority)
  2. DID level
  3. DID Group level
  4. Account level
  5. Call Flow level (the lowest priority)

The system will take the attributes values at the base Call Flow level as defaults. Then it will check if any of these attributes are set at any of the higher levels. Each of the higher levels will override the attributes values of the levels with lower priority. For example, if found at the Meeting Room level, the attribute will override any of the instances of the same attribute at levels with lower priority—DID, DID Group, Account, Call Flow. If not, the system will go down the levels until it finds the required attribute at one of the levels.

If the system cannot find the attribute record at any of the levels, it will use its default value set at the Call Flow level.

For each of these levels, the meeting attributes will be passed as a value of the attributes object. This will look like the following format:

"attributes": {
    "conference_start_wait": "360"
}

Defining Access Levels

Some fields (e.g., call_announceparticipantcount) accept a string containing the first letter of the access level name. The three access levels are h (host), p (participant), or l (listener).

To enable a feature for all three access levels, enter the hpl string:

"attributes": {
    "call_announceparticipantcount": "hpl"
}

Alternatively, to enable the feature for one access level, enter the first letter of the word. For example, the participant is p:

"attributes": {
    "call_announceparticipantcount": "p"
}

DTMF Bindings

Most of the attributes actions have DTMF key combinations associated with them. Such attributes names have the _binding suffix in them, for example:

"attributes": {
    "call_participantsnumber_dtmf_binding": "*2"
}

In this example, the call_participantsnumber_dtmf_binding attribute defines the DTMF combination that triggers announcing the number of participants in the conference to the users. That is, when the callers successively press the star key and the numeric 2 key during the conference, they hear the system announce how many callers are present in the conference at the moment.

Values accepted for the attributes with the _dtmf_binding suffix are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,#, *, and the combinations of these characters.

Attributes List

The table below contains the list of all the meeting attributes available in CarrierX conference, and their default values for the secured, open, direct_host, and direct_participant call flows.

{
    "attributes": {
        "call_announceparticipantcount": "hpl",
        "call_instructions_dtmf_binding": "*4",
        "call_moh_dtmf_binding": "0",
        "call_moh_list": "legacy,beep,default,custom",
        "call_mute_dtmf_binding": "*6",
        "call_participantsnumber_dtmf_binding": "*2",
        "conference_drop_dtmf_binding": "92",
        "conference_entryexittones_dtmf_binding": "*8",
        "conference_entrytones": "on",
        "conference_exittones": "on",
        "conference_greeting_enabled": "on",
        "conference_hold_dtmf_binding": "*3",
        "conference_language": "EN",
        "conference_lock_dtmf_binding": "*7",
        "conference_moh": "default",
        "conference_moh_enabled": "on",
        "conference_mute_dtmf_binding": "*5",
        "conference_qa_dtmf_binding": "*1",
        "conference_rollcall": "off",
        "conference_rollcall_onenter": "off",
        "conference_rollcall_onexit": "off",
        "conference_singlemember": "off",
        "conference_start_how": "first",
        "conference_start_wait": "360",
        "conference_stop_how": "moderator",
        "conference_stop_wait": "180",
        "recording_addr": "15162065121@10.1.10.190",
        "recording_dtmf_binding": "*9",
        "recording_metadata": "custom",
        "recording_method": "remote",
        "recording_stop_how": "last"
    },
    "call_flow_sid": "665bd4c6-7f44-4c46-a467-1e4696f52968",
    "name": "secured"
}
Attribute Data Type Description Default Value
Call     open secured direct_host direct_participant
call_announceparticipantcount string Specifies the access levels for which the system announces the number of participants when they enter the meeting room. Values accepted in this field are h, p, l, and any combinations of these. hpl hpl hpl hpl
call_instructions_dtmf_binding string Specifies the DTMF sequence that triggers the help playback for the conference users. *4 *4 *4 *4
call_moh_dtmf_binding string Specifies the DTMF sequence that turns on the music-on-hold. 0 0 0 0
call_moh_list string Specifies the list of allowed on hold music tracks. Values accepted in this field are legacy, beep, default, and custom. legacy, beep, default, custom legacy, beep, default, custom legacy, beep, default, custom legacy, beep, default, custom
call_mute_dtmf_binding string Specifies the DTMF sequence that triggers self muting. *6 *6 *6 *6
call_participantsnumber_dtmf_binding string Specifies the DTMF sequence that triggers announcing the number of participants in the conference to the users. *2 *2 *2 *2
call_role string Specifies the role that the caller gains when entering the meeting. Values accepted in this field are: Host, Listener, and Participant. Host Participant
Conference     open secured direct_host direct_participant
conference_drop_dtmf_binding string Specifies the DTMF sequence that triggers the conference drop for the users. 92 92 92 92
conference_entryexittones_dtmf_binding string Specifies the DTMF sequence that is used to manage the entry and exit tones of the conference. *8 *8 *8 *8
conference_entrytones string Determines whether a sound is played when a new participant joins the conference. Values accepted in this field are on and off. on on on on
conference_exittones string Determines whether a sound is played when a participant exits the conference. Values accepted in this field are on and off. on on on on
conference_greeting_enabled string Determines whether to enable the custom greeting playback. Values accepted in this field are on and off. on on on on
conference_hold_dtmf_binding string Specifies the DTMF sequence that triggers putting a conference on hold by the conference users. *3 *3 *3 *3
conference_language string Specifies the language of the meeting. The default value is EN. Refer to the table below for the list of all of the currently supported languages. EN EN EN EN
conference_lock_dtmf_binding string Specifies the DTMF sequence that triggers locking a conference by the conference users. *7 *7 *7 *7
conference_moh string Specifies the name of the file that the system plays when the conference is on hold. default default default default
conference_moh_enabled string Determines whether to enable custom on-hold music. Values accepted in this field are on and off. on on on on
conference_mute_dtmf_binding string Specifies the DTMF sequence that triggers muting other participants by the conference users. *5 *5 *5 *5
conference_qa_dtmf_binding string Specifies the DTMF sequence that triggers starting a Q&A session by the conference users. *1 *1 *1 *1
conference_rollcall string Determines whether the participants are prompted to record their names upon entering the conference. Values accepted in this field are on and off. off off off off
conference_rollcall_onenter string Determines whether the system will playback the recordings of the participants saying their names when they enter the conference. Values accepted in this field are on and off. off off off off
conference_rollcall_onexit string Determines whether the system will playback the recordings of the participants saying their names when they exit the conference. Values accepted in this field are on and off. off off off off
conference_singlemember string Determines whether to enable a single member conference. Values accepted in this field are on and off. off off off off
conference_start_how string Determines when the conference begins. Values accepted in this field are:
  • explicit for the conference to begin when the host manually starts it.
  • first for the conference to begin when the first participant connects.
  • moderator for the conference to begin when the first host connects.
first first moderator first
conference_start_wait integer Specifies the number of seconds to wait for the moderator to enter the conference. If the host does not connect during this time, the conference will end and all the participants will be dropped. 360 360 360 360
conference_stop_how string Determines whether the meeting ends when the moderator exits, or when the last participant exits. Values accepted in this field are:
  • last for the conference to end when the last participant leaves the meeting.
  • moderator for the conference to end when the last host leaves the meeting.
moderator moderator moderator moderator
conference_stop_wait integer Specifies the number of seconds to wait before the conference stops after the host disconnects. 180 180 180 180
Recording     open secured direct_host direct_participant
recording_addr string Specifies the recording server address if either the remote or remote+pin values are set for the recording_method attribute. 15162065121@10.1.10.190 15162065121@10.1.10.190 15162065121@10.1.10.190 15162065067@10.222.2.132
recording_dtmf string Specifies the access levels which can start the recording. Values accepted in this field are h, p, l, and any combinations of these. h
recording_dtmf_binding string Specifies the DTMF sequence that triggers starting the recording of the meeting by the conference users. *9 *9 *9 *9
recording_metadata string Determines whether or not the recording module can send the parameters as SIP headers. Values accepted in this field are:
  • custom to allow sending parameters as SIP headers.
  • empty value to deny sending parameters as SIP headers.
custom custom custom custom
recording_method string Specifies the recording method. Values accepted in this field are:
  • local for the local server accessible without entering an access code.
  • local+pin for the local server protected by an access code.
  • remote for the remote server (specified in recording_addr) accessible without entering an access code.
  • remote+pin for the remote server (specified in recording_addr) protected by an access code.
remote remote remote remote
recording_stop_how string Defines when the recording stops. Values accepted in this field are:
  • last for the recording to stop when the last conference participant leaves the meeting.
  • moderator for the recording to stop when the host leaves the meeting.
last last last last

conference_language

Code Language
EN English (default)
AR Argentinian
DE German
EL Greek
ES Spanish (Spain)
ES-LATAM Spanish (Latin America)
FR French
GB British English
HE Vietnamese
IT Italy
JA Japanese
KO Korean
NL Dutch
PT Portuguese (Portugal)
PT-BR Portuguese (Brazil)
RU Russian
TR Turkish
UA Ukrainian
UK Ukrainian (Ukraine)
ZH Chinese