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.

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"
}

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"
}

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"
}

did_language