campaignId | string | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |
accountId | string | ID of the account that created this Campaign. |
status | string | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. |
brandId | string | Alphanumeric identifier of the brand associated with this campaign. |
autoRenewal | boolean | Campaign subscription auto-renewal status. |
usecase | string | Campaign usecase. |
description | string | Summary description of this campaign. |
embeddedLink | boolean | Does message generated by the campaign include URL link in SMS? |
embeddedPhone | boolean | Does message generated by the campaign include phone number in SMS? |
affilieateMarketing | boolean | Does message content controlled by affiliate marketing other than the brand? |
numberPool | boolean | Does campaign utilize pool of phone nubers? |
ageGated | boolean | Age gated content in campaign. |
directLending | boolean | |
subscriberOptin | boolean | Does campaign require subscriber to opt-in before SMS is sent to subscriber? |
subscriberOptout | boolean | Does campaign support subscriber opt-out keyword(s)? |
subsriberHelp | boolean | Does campaign responds to help keyword(s)? |
sample1 | string | Message sample. Some campaign tiers require 1 or more message samples. |
sample2 | string | Message sample. Some campaign tiers require 2 or more message samples. |
sample3 | string | Message sample. Some campaign tiers require 3 or more message samples. |
sample4 | string | Message sample. Some campaign tiers require 4 or more message samples. |
sample5 | string | Message sample. Some campaign tiers require 5 or more message samples. |
messageFlow | string | Message flow description. |
helpMessage | string | Help message of the campaign. |
createDate | string | Date-String timestamp when campaign was created. |
phoneNumberAssignmentLimit | int | The max number of of PhoneNumbers that are able to be assigned to a campaign |
optinKeywords | string | Subscriber opt-in keywords. Multiple keywords are comma separated without space. |
optoutKeywords | string | Subscriber opt-out keywords. Multiple keywords are comma separated without space. |
helpKeywords | string | Subscriber help keywords. Multiple keywords are comma separated without space. |
optinMessage | string | Subscriber opt-in message. |
optoutMessage | string | Subscriber opt-out message. |
brand | object | See Brand Table Below |