Skip to main content

List Campaigns

GET 
/campaign

Retrieve a list of campaigns associated with a supplied brandId.

Request​

Query Parameters

    brandId Brandidrequired
    page Page

    Default value: 1

    The 1-indexed page number to get. The default value is 1.

    recordsPerPage Recordsperpage

    Default value: 10

    The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

Responses​

200: Successful Response

Schema

    page Page (integer)

    records

    object[]

  • Array [

    • affiliateMarketing Affiliatemarketing (boolean)deprecated

    Does message content controlled by affiliate marketing other than the brand?

    This field is deprecated.

    ageGated Agegated (boolean)

    Age gated content in campaign.

    autoRenewal Autorenewal (boolean)

    Campaign subscription auto-renewal status.

    billedDate Billeddate (string)

    Campaign recent billed date.

    brandId Brandid (string)required

    Unique identifier assigned to the brand.

    campaignId Campaignid (string)required

    Unique identifier for a campaign.

    tcrBrandId TcrBrandid (string)

    Unique identifier assigned to the brand by the registry.

    tcrCampaignId TcrCampaignid (string)

    Unique identifier assigned to the campaign by the registry.

    createDate Createdate (string)

    Unix timestamp when campaign was created.

    cspId Cspid (string)required

    Alphanumeric identifier of the CSP associated with this campaign.

    description Description (string)required

    Summary description of this campaign.

    directLending Directlending (boolean)
    embeddedLink Embeddedlink (boolean)

    Does message generated by the campaign include URL link in SMS?

    embeddedPhone Embeddedphone (boolean)

    Does message generated by the campaign include phone number in SMS?

    helpKeywords Helpkeywords (string)

    Subscriber help keywords. Multiple keywords are comma separated without space.

    helpMessage Helpmessage (string)

    Help message of the campaign.

    messageFlow Messageflow (string)

    Message flow description.

    mock Mock (boolean)required

    Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.

    nextRenewalOrExpirationDate Nextrenewalorexpirationdate (string)

    When the campaign would be due for its next renew/bill date.

    numberPool Numberpool (boolean)

    Does campaign utilize pool of phone numbers?

    optinKeywords Optinkeywords (string)

    Subscriber opt-in keywords. Multiple keywords are comma separated without space.

    optinMessage Optinmessage (string)

    Subscriber opt-in message.

    optoutKeywords Optoutkeywords (string)

    Subscriber opt-out keywords. Multiple keywords are comma separated without space.

    optoutMessage Optoutmessage (string)

    Subscriber opt-out message.

    referenceId Referenceid (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.

    resellerId Resellerid (string)

    Alphanumeric identifier of the reseller that you want to associate with this campaign.

    sample1 Sample1 (string)

    Message sample. Some campaign tiers require 1 or more message samples.

    sample2 Sample2 (string)

    Message sample. Some campaign tiers require 2 or more message samples.

    sample3 Sample3 (string)

    Message sample. Some campaign tiers require 3 or more message samples.

    sample4 Sample4 (string)

    Message sample. Some campaign tiers require 4 or more message samples.

    sample5 Sample5 (string)

    Message sample. Some campaign tiers require 5 or more message samples.

    status Status (string)

    Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

    subUsecases string[]required

    Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases

    subscriberHelp Subscriberhelp (boolean)

    Does campaign responds to help keyword(s)?

    subscriberOptin Subscriberoptin (boolean)

    Does campaign require subscriber to opt-in before SMS is sent to subscriber?

    subscriberOptout Subscriberoptout (boolean)

    Does campaign support subscriber opt-out keyword(s)?

    termsAndConditions Termsandconditions (boolean)required

    Is terms & conditions accepted?

    usecase Usecase (string)required

    Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.

    vertical Vertical (string)deprecated

    Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.

    This field is deprecated.

    webhookURL WebhookURL (string)

    Webhook to which campaign status updates are sent.

    webhookFailoverURL WebhookFailoverURL (string)

    Failover webhook to which campaign status updates are sent.

    isTMobileRegistered IsTMobileRegistered (boolean)

    Indicates whether the campaign is registered with T-Mobile.

    isTMobileSuspended isTMobileSuspended (boolean)

    Indicates whether the campaign is suspended with T-Mobile.

    isTMobileNumberPoolingEnabled isTMobileNumberPoolingEnabled (boolean)

    Indicates whether the campaign has a T-Mobile number pool ID associated with it.

  • ]

    • totalRecords Totalrecords (integer)

422: Validation Error

Schema

    detail

    object[]

  • Array [

    • loc

    object[]

    required

  • Array [

    • anyOf

    string

  • ]

    • msg Message (string)required
    type Error Type (string)required

  • ]

Loading...