Call Flow

This section outlines the Call Flow object.

Call Flow Attributes

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

Attribute	Data Type	Description
attributeTemplates read only	array of objects	The attributes belonging to the call flow. Refer to the table below for a comprehensive list of the format of attributes. For a list of the attributes themselves, refer to the Meeting Attributes section.
id read only	integer	The call flow ID. Note that this ID may differ for each user.
name read only	string	The call flow name.
path read only	string	This field is for internal use only.

Attribute Object

This object is used in attributeTemplates.

Attribute	Data Type	Description
description read only	string	The description of the attribute.
enumValues read only	string	If the type value is 5, this attribute will be automatically populated with possible values.
group read only	integer	Defines the levels at which the call flow attribute value can be overridden. Integer values denote that the call flow attribute can be overridden at the following object levels: 1 (0 bit) for Call Flow and DID Group 2 (1 bit) for DID 4 (2 bit) for Meeting Room The combinations of the values can also be used: 3 (1 + 2) for Call Flow, DID Group, and DID 5 (1 + 4) for Call Flow, DID Group, and Meeting Room 6 (2 + 4) for DID and Meeting Room 7 (1 + 2 + 4) for Call Flow, DID Group, DID, and Meeting Room
name read only	string	The attribute name.
type read only	integer	The attribute type. Values accepted in this field are: 0 for TYPE_STRING 2 for TYPE_INT 3 for TYPE_DTMF 4 for TYPE_ROLE 5 for TYPE_CHOICE 6 for TYPE_DB_REFERENCE 7 for TYPE_UPLOAD * for any
value read only	string	The attribute value.

Sample Call Flow Object

{
    "attributeTemplates": [
        {
            "description": "Announce participant count on enter",
            "enumValues": "",
            "group": 5,
            "name": "call_announceparticipantcount",
            "type": 4,
            "value": "hpl"
        }
    ],
    "id": 3,
    "name": "CONF",
    "path": "/usr/local/DNCA/callflows/CONF"
}