Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 2.87 KB

Campaign.md

File metadata and controls

40 lines (32 loc) · 2.87 KB

Campaign

Properties

Name Type Description Notes
campaignId String Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. [optional]
cspId String Alphanumeric identifier of the CSP associated with this campaign. [optional]
resellerId String Alphanumeric identifier of the reseller that you want to associate with this campaign. [optional]
status Status Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. [optional]
createDate OffsetDateTime Unix timestamp when campaign was created. [optional]
autoRenewal Boolean Campaign subscription auto-renewal status. [optional]
billedDate OffsetDateTime Campaign recent billed date. [optional]
brandId String Alphanumeric identifier of the brand associated with this campaign.
vertical Vertical
usecase Usecase
subUsecases Usecase [optional]
description String Summary description of this campaign.
embeddedLink Boolean Does message generated by the campaign include URL link in SMS? [optional]
embeddedPhone Boolean Does message generated by the campaign include phone number in SMS? [optional]
affiliateMarketing Boolean Does message content controlled by affiliate marketing other than the brand? [optional]
numberPool Boolean Does campaign utilize pool of phone nubers? [optional]
ageGated Boolean Age gated content in campaign. [optional]
directLending Boolean [optional]
subscriberOptin Boolean Does campaign require subscriber to opt-in before SMS is sent to subscriber? [optional]
subscriberOptout Boolean Does campaign support subscriber opt-out keyword(s)? [optional]
subscriberHelp Boolean Does campaign responds to help keyword(s)? [optional]
sample1 String Message sample. Some campaign tiers require 1 or more message samples. [optional]
sample2 String Message sample. Some campaign tiers require 2 or more message samples. [optional]
sample3 String Message sample. Some campaign tiers require 3 or more message samples. [optional]
sample4 String Message sample. Some campaign tiers require 4 or more message samples. [optional]
sample5 String Message sample. Some campaign tiers require 5 or more message samples. [optional]
messageFlow String Message flow description. [optional]
helpMessage String Help message of the campaign. [optional]