Skip to content

Latest commit

 

History

History
88 lines (82 loc) · 5.1 KB

SMSTenDLCCampaign.md

File metadata and controls

88 lines (82 loc) · 5.1 KB

Freeclimb::SMSTenDLCCampaign

Properties

Name Type Description Notes
account_id String ID of the account that created this Queue. [optional]
campaign_id String Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.
csp_id String Alphanumeric identifier of the CSP associated with this campaign.
reseller_id String Alphanumeric identifier of the reseller that you want to associate with this campaign. [optional]
status SMSTenDLCCampaignStatus [optional]
create_date Time Unix timestamp when campaign was created. [optional]
auto_renewal Boolean Campaign subscription auto-renewal status. [optional]
billed_date Time Campaign recent billed date. [optional]
brand_id String Alphanumeric identifier of the brand associated with this campaign.
usecase String Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand.
sub_usecases Array<String> Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases
description String Summary description of this campaign.
embedded_link Boolean Does message generated by the campaign include URL link in SMS? [optional][default to false]
embedded_phone Boolean Does message generated by the campaign include phone number in SMS? [optional][default to false]
affiliate_marketing Boolean Does message content controlled by affiliate marketing other than the brand? [optional]
number_pool Boolean Does campaign utilize pool of phone nubers? [optional][default to false]
age_gated Boolean Age gated content in campaign. [optional]
direct_lending Boolean [optional]
subscriber_optin Boolean Does campaign require subscriber to opt-in before SMS is sent to subscriber? [optional][default to false]
subscriber_optout Boolean Does campaign support subscriber opt-out keyword(s)? [optional][default to false]
subscriber_help Boolean Does campaign responds to help keyword(s)? [optional][default to false]
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]
message_flow String Message flow description. [optional]
help_message String Help message of the campaign. [optional]
optin_keywords String Subscriber opt-in keywords. Multiple keywords are comma separated without space. [optional]
optout_keywords String Subscriber opt-out keywords. Multiple keywords are comma separated without space. [optional]
help_keywords String Subscriber help keywords. Multiple keywords are comma separated without space. [optional]
optin_message String Subscriber opt-in message. [optional]
optout_message String Subscriber opt-out message. [optional]
reference_id String Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. [optional]
mock Boolean Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.
next_renewal_or_expiration_date Date When the campaign would be due for its next renew/bill date. [optional]

Example

require 'freeclimb'

instance = Freeclimb::SMSTenDLCCampaign.new(
  account_id: null,
  campaign_id: null,
  csp_id: null,
  reseller_id: null,
  status: null,
  create_date: null,
  auto_renewal: null,
  billed_date: null,
  brand_id: null,
  usecase: null,
  sub_usecases: null,
  description: null,
  embedded_link: null,
  embedded_phone: null,
  affiliate_marketing: null,
  number_pool: null,
  age_gated: null,
  direct_lending: null,
  subscriber_optin: null,
  subscriber_optout: null,
  subscriber_help: null,
  sample1: null,
  sample2: null,
  sample3: null,
  sample4: null,
  sample5: null,
  message_flow: null,
  help_message: null,
  optin_keywords: null,
  optout_keywords: null,
  help_keywords: null,
  optin_message: null,
  optout_message: null,
  reference_id: null,
  mock: null,
  next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
)