DID Object

In CarrierX API, the DID objects describe all the rented phone numbers associated with the Conference endpoint.

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

• Get DIDs
• Get DID by SID
• Update DID

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
account_sid read only	string	The secure ID of the account associated with the DID.
properties update	object	The call flow properties which will be overriden at the DID level. Refer to this section for more details on various conference v2 call flow properties.
call_flow_sid update	string	The secure ID of the call flow associated with the DID.
country_code read only	string	The ISO 3166-1 alpha-3 code of this DID. This field is assigned automatically.
did_group_sid update	string	The secure ID of the DID group associated with the DID.
did_sid read only	string	The DID secure ID.
in_country_format read only	string	The DID in a national format.
international_format read only	string	The DID in an international format.
phonenumber read only	string	The phone number for the DID in E.164 format.

Sample DID Object

{
    "account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
    "properties": {},
    "call_flow_sid": "fb2b69b1-6998-4cdc-b04c-a267c585f767",
    "country_code": "USA",
    "did_group_sid": "ea1d0f8d-4f2d-4437-a627-694a23a2d568",
    "did_sid": "022aa786-2c40-484f-9a36-2a51e84579d6",
    "in_country_format": "(516) 206-5919",
    "international_format": "+1 516-206-5919",
    "phonenumber": "15162065919"
}