Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 4.63 KB

SMSTenDLCPartnerCampaign.md

File metadata and controls

50 lines (42 loc) · 4.63 KB

freeclimb.Model.SMSTenDLCPartnerCampaign

Properties

Name Type Description Notes
AccountId string ID of the account that created this Queue. [optional]
CampaignId string Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.
Status SMSTenDLCPartnerCampaignStatus [optional]
CreateDate DateTime Unix timestamp when campaign was created. [optional]
BrandId 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.
Description string Summary description of this campaign.
EmbeddedLink bool Does message generated by the campaign include URL link in SMS? [optional] [default to false]
EmbeddedPhone bool Does message generated by the campaign include phone number in SMS? [optional] [default to false]
AffiliateMarketing bool Does message content controlled by affiliate marketing other than the brand? [optional]
NumberPool bool Does campaign utilize pool of phone nubers? [optional] [default to false]
AgeGated bool Age gated content in campaign. [optional]
DirectLending bool [optional]
SubscriberOptin bool Does campaign require subscriber to opt-in before SMS is sent to subscriber? [optional] [default to false]
SubscriberOptout bool Does campaign support subscriber opt-out keyword(s)? [optional] [default to false]
SubscriberHelp bool 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]
MessageFlow string Message flow description. [optional]
HelpMessage string Help message of the campaign. [optional]
OptinKeywords string Subscriber opt-in keywords. Multiple keywords are comma separated without space. [optional]
OptoutKeywords string Subscriber opt-out keywords. Multiple keywords are comma separated without space. [optional]
HelpKeywords string Subscriber help keywords. Multiple keywords are comma separated without space. [optional]
OptinMessage string Subscriber opt-in message. [optional]
OptoutMessage string Subscriber opt-out message. [optional]
Brand SMSTenDLCPartnerCampaignBrand [optional]

Example

using Newtonsoft.Json;
using freeclimb.Model;

string json = "{\"campaignId\":\"CX56XX4\",\"accountId\":\"AC0123456789abcdefABCDEF0123456789abcdef05\",\"brandId\":\"BX56XX4\",\"usecase\":\"2FA\",\"description\":\"mock campaign.\",\"sample1\":\"Your verification code from FreeClimb is 000000. It expires in 10 minutes.\",\"sample2\":null,\"sample3\":null,\"sample4\":null,\"sample5\":null,\"messageFlow\":null,\"helpMessage\":null,\"status\":\"EXPIRED\",\"embeddedLink\":false,\"embeddedPhone\":false,\"affiliateMarketing\":false,\"numberPool\":false,\"ageGated\":false,\"directLending\":false,\"subscriberOptin\":true,\"subscriberOptout\":false,\"subscriberHelp\":true,\"createDate\":\"2022-07-05T15:17:05Z\",\"optinKeywords\":\"START\",\"optoutKeywords\":\"STOP\",\"helpKeywords\":\"HELP\",\"optinMessage\":\"\",\"optoutMessage\":\"\",\"brand\":{\"optionalAttributes\":{},\"brandId\":\"BVCEBIJ\",\"firstName\":\"\",\"lastName\":\"\",\"displayName\":\"FreeClimb LLC(mock)\",\"companyName\":\"FreeClimb LLC\",\"phone\":\"+18475722071\",\"email\":\"bmabry@vailsys.com\",\"website\":\"https://www.freeclimb.com/\",\"evpVettingScore\":22}}";

// create an instance of SMSTenDLCPartnerCampaign from a JSON string
SMSTenDLCPartnerCampaign sMSTenDLCPartnerCampaign = JsonConvert.DeserializeObject<SMSTenDLCPartnerCampaign>(json);

[Back to Model list] [Back to API list] [Back to README]