DID Group Object

This section outlines the DID Group object.

DID Group Object 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
attributes createupdate	array of objects	Refer to the table below section for a comprehensive list of attributes.
callFlowId createupdate	integer	The ID of the call flow.
description createupdate	string	The description of the DID group.
dids read only	array of objects	An array of the DIDs belonging to the DID group. Each object in the array contains attributes, countryCode, didGroupId, id, phoneNumber, and state. Refer to the DID object for a description of these attributes.
id read only	integer	The ID of the DID group.
name createupdate	string	The name of the DID group.
state read only	integer	The state of the DID group.
subscriberSid read only	string	The secure ID of the subscriber associated with the DID group.

Attribute Object

This object is used in attributes.

Attribute	Data Type	Description
description update	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 update	string	The attribute value.

Sample DID Group Object

{
    "attributes": [],
    "callFlowId": 3,
    "description": "",
    "dids": [
        {
            "attributes": [],
            "countryCode": "US",
            "didGroupId": 219,
            "id": 221,
            "phoneNumber": "15162065319",
            "state": -1
        }
    ],
    "id": 219,
    "name": "sample_conference_008_didGroup",
    "state": -1,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}