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

    records

    object[]

  • Array [

  • affiliateMarketing Affiliatemarketingdeprecated

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

    This field is deprecated.

    ageGated Agegated

    Age gated content in campaign.

    autoRenewal Autorenewal

    Campaign subscription auto-renewal status.

    billedDate Billeddate

    Campaign recent billed date.

    brandId Brandidrequired

    Alphanumeric identifier of the brand associated with this campaign.

    campaignId Campaignidrequired

    Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.

    createDate Createdate

    Unix timestamp when campaign was created.

    cspId Cspidrequired

    Alphanumeric identifier of the CSP associated with this campaign.

    description Descriptionrequired

    Summary description of this campaign.

    directLending Directlending
    embeddedLink Embeddedlink

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

    embeddedPhone Embeddedphone

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

    helpKeywords Helpkeywords

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

    helpMessage Helpmessage

    Help message of the campaign.

    messageFlow Messageflow

    Message flow description.

    mock Mockrequired

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

    nextRenewalOrExpirationDate Nextrenewalorexpirationdate

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

    numberPool Numberpool

    Does campaign utilize pool of phone numbers?

    optinKeywords Optinkeywords

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

    optinMessage Optinmessage

    Subscriber opt-in message.

    optoutKeywords Optoutkeywords

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

    optoutMessage Optoutmessage

    Subscriber opt-out message.

    referenceId Referenceid

    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

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

    sample1 Sample1

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

    sample2 Sample2

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

    sample3 Sample3

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

    sample4 Sample4

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

    sample5 Sample5

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

    status Status

    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

    Does campaign responds to help keyword(s)?

    subscriberOptin Subscriberoptin

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

    subscriberOptout Subscriberoptout

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

    termsAndConditions Termsandconditionsrequired

    Is terms & conditions accepted?

    usecase Usecaserequired

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

    vertical Verticaldeprecated

    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

    Webhook to which campaign status updates are sent.

    webhookFailoverURL WebhookFailoverURL

    Failover webhook to which campaign status updates are sent.

    isTMobileRegistered IsTMobileRegistered

    Indicates whether the campaign is registered with T-Mobile.

    isTMobileSuspended isTMobileSuspended

    Indicates whether the campaign is suspended with T-Mobile.

  • ]

  • totalRecords Totalrecords

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...