Campaign Object
The Campaign Object represents a registered 10DLC (10-Digit Long Code) messaging campaign used for sending A2P (Application-to-Person) messages over standard 10-digit phone numbers in the United States.
Each Campaign record corresponds to a registration approved through The Campaign Registry (TCR), which associates a business entity (partner) with one or more phone numbers authorized for messaging.
A Campaign Object includes key metadata such as internal and external identifiers, campaign name, and the associated partner. It is created when a partner registers a new campaign through CarrierX, and its data can be retrieved through the API once approved by TCR.
Campaigns are typically linked to phone numbers managed under the same partner account to ensure regulatory compliance and throughput control for SMS delivery.
Campaign 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 |
|---|---|---|
| campaign_sid read only | string | An internal secure ID of the 10DLC campaign. |
| external_id read only | string | The 10DLC campaign ID the Campaign Registry has assigned to your campaign upon its registration. |
| name read only | string | The internal name of the 10DLC Campaign. |
| partner_sid read only | string | The secure ID of the partner associated with the campaign |
Sample Campaign Object
{
"campaign_sid": "fef13cdd-2f65-4ed8-8272-de2a940d0cb5",
"external_id": "CVN1LXI",
"name": "My 10DLC Campaign",
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0"
}