Call Flow Object

In CarrierX API, the Call Flow objects describe all the available call flows with their default properties.

The system returns a Call Flow JSON object with the fields listed in the table below in response to one of the following successful requests:

• Get Call Flows
• Get Call Flow by SID

Call Flow Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
properties read only	object	The call flow base properties which are set at the call flow level. Refer to this section for more details on various conference v2 call flow properties.
call_flow_sid read only	string	The call flow secure ID.
name read only	string	The call flow name. This is a human-readable nickname for the call flow.

Sample Call Flow Object

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