External DID Messaging Enablement Object

The External DID Messaging Enablement Object represents the messaging enablement configuration and current operational status for an external DID (a third-party phone number not rented from CarrierX).

This object reflects whether SMS and MMS messaging are enabled for the external number, the enablement type (a2p or p2p), and the current processing state of the messaging configuration within the CarrierX network. Messaging for external DIDs is managed by CarrierX messaging enablement, and partners can enable or disable SMS/MMS for eligible external numbers.

The object also reports separate status values for SMS and MMS, allowing partners to track messaging activation progress and troubleshoot partial enablement scenarios.

To be able to send SMS/MMS from an external DID, messaging must be enabled for that DID.

note

Note that as soon as a DID becomes SMS/MMS-enabled, it becomes subject to a fixed monthly enablement fee (USD 0.03). This fee is charged for the whole month independent of the day of the month when SMS/MMS messaging was enabled. For example, if you have enabled SMS/MMS messaging on the first of the month, the amount charged from your account will be the same as if you have enabled it on the 15th of the month or on the 30th of the month. The first payment is charged upon SMS/MMS messaging enablement and all the subsequent payments are charged in advance on the first of each month.

External DID Messaging Enablement Object Attributes

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

Attribute	Data Type	Description
campaign_external_id read only	string	The external 10DLC campaign identifier assigned by the Campaign Registry. Returned only when the enablement type is a2p.
campaign_sid createupdate	string	The secure ID of the partner's 10DLC campaign that is used for SMS enablement on this external phone number. This attribute applies only if the DID enablement type is a2p.
did_sid read only	string	The external DID secure ID.
enabled createupdate	boolean	Whether SMS/MMS messaging is enabled or disabled for this external DID. If set to true, messaging is enabled. The default value is false.
p2p_nnid createupdate	string	The NetNumber ID identifying the provider that owns SMS routing for this telephone number. This attribute applies only if the DID enablement type is p2p.
status read only	string	Current status of SMS/MMS messaging for this DID. Values that returned in this field are: in_progress enabled disabled failed pending_port_in The default value is disabled.
type createupdate	string	Specifies the phone number enablement type, a2p (Application-to-Person) or p2p (Person-to-Person). Values accepted in this field are a2p and p2p. If this value is not specified, the phone number will use the partner/global default value. By default, partners are only enabled for a2p messaging. Please contact technical support at support@carrierx.com if you need the p2p messaging type to be enabled on your DIDs.

Sample DID Messaging Enablement Object

{
  "campaign_external_id": "CVN1LXI",
  "campaign_sid": "fef13cdd-2f65-4ed8-8272-de2a940d0cb5",
  "did_sid": "f3125c23-29dd-41b7-5dbc-89edba59230d",
  "enabled": true,
  "p2p_nnid": null,
  "status": "enabled",
  "type": "a2p"
}