DID Group Object

The DID Group Object represents a logical grouping of DIDs (phone numbers) that share common configuration or ownership attributes. It includes identifying information such as the group's secure ID, display name, and the associated partner account.

This object may also define a callback URL used to receive real-time SMS event notifications for all DIDs within the group, providing an efficient way to manage event handling and grouping at scale.

DID Group Object Attributes

These fields and values make up the JSON response that gets returned when a request is successful.

Attribute	Data Type	Description
callback_url createupdate	string	The callback URL to receive events for SMS.
did_group_sid read only	string	The DID group secure ID.
name createupdate	string	The name of the DID group.
partner read only	object	The Partner object associated with the DID group. 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 group.

Sample DID Group Object

{
    "callback_url": null,
    "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
}

note

When determining the callback URL, the system will use the first non-empty value from:

1. the callback_url field of the DID object;
2. the callback_url field of the DID Group object;
3. the callbacks.sms field of the Partner object.