DID Object
The DID (Direct Inward Dialing) object represents a phone number and all of its associated data within the CarrierX platform. Each DID includes identifying information, provisioning details, capabilities, and ownership metadata.
DIDs can be queried, rented, updated, and managed through the API. Their configuration defines how the number behaves for voice and messaging, what partner it belongs to, and what carrier and trunk group handle its routing.
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 |
|---|---|---|
| active_capabilities read only | integer | The phone number enabled (activated) capabilities. Criteria are similar to the capabilities attribute below. Note that this attribute is fully managed by the system and its status depends on whether SMS/MMS is enabled for a DID. To activate the SMS/MMS capabilities of your rented DIDs, you need to enable them. See also SMS/MMS enablement. |
| attributes | object | Custom DID attributes. Can be used for various additional purposes. |
| callback_url | string | The callback URL to receive events for SMS. |
| campaign_sid read only | string | The secure ID of the 10DLC campaign associated with the DID. |
| capabilities read only | integer | The phone number supported capabilities. Capabilities represent what this DID is potentially capable of: receiving, sending SMS, MMS, voice calls, etc. This field accepts numerical values. To enable more than one capability, add the corresponding integers together. The following are the numerical values for each capability:
To enable receiving SMS and voice, add |
| classification_sid read only | string | The phone number classification secure ID, which can be set to one of the DID Classification object secure IDs. |
| country_code read only | string | The ISO 3166-1 alpha-3 code of this DID. This field is assigned automatically. |
| did_group_sid | string | The DID group secure ID. |
| 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. |
| lata read only | string | LATA: Local Access and Transport Area, a geographic code representing the location of the call origination. |
| locality read only | string | The locality or city of the DID. |
| lrn_sid read only | string | The secure ID of the Location Routing Number assigned to this DID. |
| name | string | The DID name. By default, it is set to the local-format version of the phone number (e.g., (808) 384-2079). |
| ocn read only | string | The operating company number used with this DID. |
| partner read only | object | The Partner object associated with the DID. This field is displayed if with_related is set to true when performing the GET queries. |
| partner_sid read only | string | The secure ID of the partner associated with the DID. |
| pending_port_in read only | string | A 4-character string representing the expected new OCN (Operating Company Number) for a new phone number that is being ported to a new carrier. The system polls the database every 10 minutes to check if porting has finished. Once the number's OCN matches the expected value, the system automatically clears the pending_port_in field and proceeds with messaging enablement. When this field is not null, it means that messaging enablement request is acknowledged, but completion is blocked until the number has finished porting. |
| phonenumber | string | The phone number for the DID in the E.164 format. |
| porting_pin | string | A random 6-digit PIN code automatically assigned to a DID when it is rented. The porting PIN is used to verify requests for DID porting. The PIN code can be changed at any time. |
| price read only | number | The price of the DID. |
| state read only | string | The state or province of the DID. |
| status read only | string | The current DID status. Values accepted in this field are:
|
| string_key_1 | string | A user-defined string key. |
| string_key_2 | string | A user-defined string key. |
| transformations | array of objects | The transformations that are applied to the DID. Refer to the transformations section for more information. |
| trunk_group_sid | string | The secure ID of the trunk group associated with the DID. |
| underlying_carrier_sid read only | string | The Carrier ID referencing the underlying carrier that owns this DID while in the inventory. |
Sample DID Object
{
"active_capabilities": 4,
"attributes": {},
"callback_url": null,
"campaign_sid": null,
"capabilities": 7,
"classification_sid": "17f4d954-d635-4cda-912b-c2a2fa3a6860",
"country_code": "USA",
"did_group_sid": null,
"did_sid": "f448e2c3-88c1-4cd1-8cf2-3567c16e0794",
"in_country_format": "(516) 206-5575",
"international_format": "+1 516-206-5575",
"lata": null,
"locality": "NEW YORK",
"lrn_sid": null,
"name": "(516) 206-5575",
"ocn": "251F",
"partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
"pending_port_in": null,
"phonenumber": "15162065575",
"porting_pin": null,
"price": "0.6",
"state": "NY",
"status": "assigned",
"string_key_1": null,
"string_key_2": null,
"transformations": [],
"trunk_group_sid": null,
"underlying_carrier_sid": "40a8c9cf-8b08-4c21-a3e3-952c65ee892d"
}