Campaign
The Campaign object
Attributes
brand_id | The brand_id associated with the campaign. |
campaign_id | Unique identifier for the campaign created. |
campaign_attributes | Tuple indicating status of the following attributes that were specified at the time of campaign creation: |
description | A brief description of the campaign and how it’s relevant to your business. |
registration_status | Indicates status of a campaign. |
usecase | Use case used to create the campaign. |
sub_usecases | Sub-use cases used to create mixed campaigns. |
sample1 | Sample message indicated at campaign creation time. Campaign creation requires at least two sample messages. |
sample2 | Sample message indicated at campaign creation time. Campaign creation requires at least two sample messages. |
mno_metadata | Tuple containing allowed transactions per minute (TPM) and brand_tier (specific to T-Mobile transactions per day (TPD)). |
message_flow | A brief description of how a customer opts in to the campaign and provides consent to the sender to receive their messages. |
help_message | Response to HELP keyword on this campaign’s numbers. |
optin_message | Message sent to subscribers to confirm their opt-in to the campaign. |
optout_message | Response to STOP keyword on this campaign’s numbers. |
optin_keywords | Opt-in keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces. |
optout_keywords | Opt-out keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces. |
help_keywords | Help keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces. |
campaign_source | Indicates how a campaign has been created. If you have created this campaign on Plivo, campaign_source will be plivo . If you have created a campaign directly on TCR and imported to Plivo, campaign_source will be shared . |