Skip to main content

DID Messaging Enablement Object

This section outlines the DID Messaging Enablement object.

DID Messaging Enablement Object Attributes

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

AttributeData TypeDescription
campaign_external_id
read only
stringThe 10DLC campaign ID the Campaign Registry has assigned to the partner's messaging campaign upon its registration.
campaign_sidstringThe secure ID of the partner's 10DLC campaign that is used for SMS enablement on this phone number. This attribute applies only if the DID enablement type is a2p.
did_sid
read only
stringThe DID secure ID.
enabledbooleanWhether SMS/MMS messaging is enabled or disabled for this DID. If set to true, messaging is enabled. The default value is false.
p2p_nnidstringThe NetNumber ID associated with the phone number. This identifier represents the service provider that owns the SMS routing for this telephone number in the NetNumber registry. 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

The default value is disabled.

typestring

Sets the phone number enablement type, a2p or p2p. Values accepted in this field are a2p and p2p. If this value is not set, 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,
"status": "enabled",
"type": "a2p"
}

To be able to send SMS/MMS from a rented 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.