Skip to main content

​
Attributes

brand_idThe brand_id associated with the campaign.
campaign_idUnique identifier for the campaign created.
campaign_attributes

Tuple indicating status of the following attributes that were specified at the time of campaign creation:
affiliate_marketing
age_gated
direct_lending
embedded_link
embedded_phone
subscriber_help
subscriber_optin
subscriber_optout

descriptionA brief description of the campaign and how it’s relevant to your business.
registration_status

Indicates status of a campaign.

usecaseUse case used to create the campaign.
sub_usecasesSub-use cases used to create mixed campaigns.
sample1

Sample message indicated at campaign creation time. Campaign creation requires at least two sample messages.

sample2Sample message indicated at campaign creation time. Campaign creation requires at least two sample messages.
mno_metadataTuple 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_messageResponse to HELP keyword on this campaign’s numbers.
optin_messageMessage sent to subscribers to confirm their opt-in to the campaign.
optout_messageResponse to STOP keyword on this campaign’s numbers.
optin_keywordsOpt-in keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.
optout_keywordsOpt-out keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.
help_keywordsHelp keyword(s) associated with the campaign. If more than one, provide a comma-separated list with no special characters or embedded spaces.
campaign_sourceIndicates 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.

​
Example Object

{
    "api_id": "497b1284-3a49-11ed-a2ca-0242ac110004",
    "campaign": {
        "brand_id": "BHXDNDJ",
        "campaign_id": "CZISKSM",
        "mno_metadata": {
            "at&t": {
                "tpm": "4500",
                "brand_tier": null
            },
            "t-mobile": {
                "tpm": null,
                "brand_tier": "TOP"
            },
            "us cellular": {
                "tpm": "4500",
                "brand_tier": null
            },
            "verizon wireless": {
                "tpm": "4500",
                "brand_tier": null
            }
        },
        "reseller_id": "",
        "usecase": "MIXED",
        "sub_usecase": "CUSTOMER_CARE,2FA",
        "message_flow": "Message flow is a mandatory parameter, minimum 40 characters",
        "optin_keywords": "YES, SUBSCRIBE, TRUE",
        "optin_message": "Opt-in message should have a minimum of 20 characters",
        "optout_keywords": "NO, STOP",
        "optout_message": "Opt-out message should have a minimum of 20 characters",
        "help_keywords": "HELP, INFO, MORE",
        "help_message": "Help message is a mandatory parameter, minimum 20 characters"
    }
}