Conference v2 Call Flow Properties

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

note

Refer to the Call Flows section for more details about the call flows used with CarrierX conferences.

Properties Hierarchy

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

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 properties values at the base Call Flow level as defaults. Then it will check if any of these properties are set at any of the higher levels. Each of the higher levels will override the properties values of the levels with lower priority. For example, if found at the Meeting Room level, the property will override any of the instances of the same property 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 property at one of the levels.

If the system cannot find the property 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 properties will be passed as a value of the properties object. This will look like the following format:

"properties": {
    "conference_start_wait": "360"
}

note

You cannot adjust the properties values at the Call Flow level. They are set by the CarrierX team and are available for reading only.

Defining Access Levels

Some fields (e.g., conference_announceparticipantcount_policy) accept a string containing the first letter of the access level name. The three access levels are h (host), p (participant), or l (listener). Such properties names have the bpolicy suffix in them.

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

"properties": {
    "conference_announceparticipantcount_policy": "hpl"
}

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

"properties": {
    "conference_announceparticipantcount_policy": "p"
}

info

The letter order---hpl, plh, etc.---is not important. You can use the order you are most convenient with. The - (dash symbol) value means that no one is allowed to access.

DTMF Bindings

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

"properties": {
    "conference_recording_dtmf_binding": "*9"
}

In this example, the conference_recording_dtmf_binding property defines the DTMF sequence that triggers starting the recording of the meeting by the conference users. That is, when a caller successively presses the star key and the numeric 9 key during the conference, the conference will be recorded.

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

Properties List

The table below contains the list of all the meeting properties currently available in CarrierX conference.

{
    "properties": {
        "call_mute_dtmf_binding": "*6",
        "call_rolepin_dtmf_binding": "99",
        "conference_announceparticipantcount_policy": "hpl",
        "conference_entrytones_enabled": "on",
        "conference_exittones_enabled": "on",
        "conference_hold_dtmf_binding": "*3",
        "conference_lock_dtmf_binding": "*7",
        "conference_moh": "default",
        "conference_moh_enabled": "on",
        "conference_mute_dtmf_binding": "*5",
        "conference_mute_menu_dtmf_binding": "95",
        "conference_mute_policy": "l",
        "conference_recording_dtmf_binding": "*9",
        "conference_recording_enabled": "on",
        "conference_start_how": "first",
        "conference_start_wait": "360",
        "conference_stop_how": "last",
        "conference_stop_wait": "180",
        "conference_welcomeprompt": "default",
        "conference_welcomeprompt_enabled": "on",
        "did_language": "en_US",
        "did_prompt_serial": "001",
        "did_welcomeprompt": "default"
    },
    "call_flow_sid": "665bd4c6-7f44-4c46-a467-1e4696f52968",
    "name": "secured"
}

Property	Data Type	Description	Default Value
call_mute_dtmf_binding	string	Specifies the DTMF sequence that triggers self-muting.	*6
call_rolepin_dtmf_binding	string	Specifies the DTMF sequence that activates the host PIN menu. As soon as the host PIN menu is activated any participant can enter a PIN code delegated by the host and become the host instead.	99
conference_announceparticipantcount_policy	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: hpl, and any combinations of these letters - (dash symbol) means that no one has access.	hpl
conference_entrytones_enabled	string	Determines whether a sound is played when a new participant joins the conference. Values accepted in this field are on and off.	on
conference_exittones_enabled	string	Determines whether a sound is played when a participant exits the conference. Values accepted in this field are on and off.	on
conference_hold_dtmf_binding	string	Specifies the DTMF sequence that triggers putting a conference on hold by the conference users.	*3
conference_lock_dtmf_binding	string	Specifies the DTMF sequence that triggers locking a conference by the conference users.	*7
conference_moh	string	Specifies the name of the file that the system plays when the conference is on hold. Values accepted in this field are: default, beep and silence.	default
conference_moh_enabled	string	Determines whether to enable custom on-hold music. Values accepted in this field are on and off.	on
conference_mute_dtmf_binding	string	Specifies the DTMF sequence that cycles through the mute modes in the conference (relaxed/strict/open).	*5
conference_mute_menu_dtmf_binding	integer	Specifies the DTMF sequence that triggers the mute menu (as opposed to the conference_mute_dtmf_binding above, the host can immediately select the desired mute mode).	95
conference_mute_policy	string	Determines the initially muted conference participants.	l
conference_recording_dtmf_binding	string	Specifies the DTMF sequence that triggers starting the recording of the meeting by the conference users.	*9
conference_recording_enabled	string	Determines whether the conference can be recorded. Values accepted in this field are: on allows the conference recording. off disables the conference recording auto starts the conference recording immediately.	on
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
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
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
conference_stop_wait	integer	Specifies the number of seconds to wait before the conference stops after the host disconnects.	180
conference_welcomeprompt	string	A short greeting that is played when a participant has connected to a meeting successfully (by entering a correct access code). The URL of an audio file (mp3/wav) can be used as the value.	default
conference_welcomeprompt_enabled	string	Determines whether to enable the custom greeting playback. Values accepted in this field are on and off.	on
did_language	string	Specifies the language of the meeting. The default value is en_US. Refer to the table below for the list of all of the currently supported languages.	en_US
did_prompt_base_url	string	The URL of the CarrierX or third-party storage container containing voice prompts to be used in call flows.	-
did_prompt_serial	string	The current version of the voice prompts. If changed to a higher value, the cache of prompts pulled earlier from the CarrierX or third-party storage container will be updated, i.e. the bridge will re-pull the prompts.	001
did_welcomeprompt	string	A short greeting that is played when a subscriber has connected to a phone line successfully. The URL of the audio file (mp3/wav) can be used as the value.	default

did_language

Code	Language
en_US	US English (default)
de_DE	German
es_ES	Spanish (Spain)
it_IT	Italian