DID Object

This section outlines the DID object.

DID 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
attributes createupdate	array of objects	Additional attributes that can be set to modify a DID. Refer to the table below for a list of preset attributes.
countryCode read only	string	The country region of the DID. The format for this field is ISO 3166-1 alpha-2.
description createupdate	string	The description of the DID. If this field is not set, it will be hidden in the response.
didGroupId createupdate	integer	The ID of the DID group to which the DID belongs.
id read only	integer	The unique ID of a specific DID.
phoneNumber createupdate	string	The phone number in E.164 format.
state read only	integer	The state of the DID.

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 Object

{
    "attributes": [],
    "countryCode": "US",
    "description": "A test DID",
    "didGroupId": 219,
    "id": 220,
    "phoneNumber": "15162065319",
    "state": -1
}