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.

    sort Sort

    Possible values: [assignedPhoneNumbersCount, -assignedPhoneNumbersCount, campaignId, -campaignId, createdAt, -createdAt, status, -status, tcrCampaignId, -tcrCampaignId]

    Default value: -createdAt

    Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.

    Example: -assignedPhoneNumbersCount

Responses ​

200: Successful Response

Schema

    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)

    Unique identifier assigned to the brand.

    brandDisplayName Branddisplayname

    Display or marketing name of the brand.

    campaignId Campaignid (string)

    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)

    Alphanumeric identifier of the CSP associated with this campaign.

    description Description (string)

    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)

    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[]

    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)

    Is terms & conditions accepted?

    usecase Usecase (string)

    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.

    failureReasons failureReasons

    Failure reasons if campaign submission failed

    submissionStatus submissionStatus

    Possible values: [CREATED, FAILED, PENDING]

    Campaign submission status

    campaignStatus campaignStatus

    Possible values: [TCR_PENDING, TCR_SUSPENDED, TCR_EXPIRED, TCR_ACCEPTED, TCR_FAILED, TELNYX_ACCEPTED, TELNYX_FAILED, MNO_PENDING, MNO_ACCEPTED, MNO_REJECTED, MNO_PROVISIONED, MNO_PROVISIONING_FAILED]

    Campaign status

    privacyPolicyLink PrivacyPolicyLink (string)

    Link to the campaign's privacy policy.

    termsAndConditionsLink TermsAndConditionsLink (string)

    Link to the campaign's terms and conditions.

    embeddedLinkSample EmbeddedLinkSample (string)

    Sample of an embedded link that will be sent to subscribers.

    assignedPhoneNumbersCount AssignedPhoneNumbersCount (number)

    Number of phone numbers associated with the campaign

  • ]

    • page Page (integer)
    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

  • ]

Request samples

curl -L 'https://api.telnyx.com/10dlc/campaign' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "records": [
    {
      "ageGated": true,
      "autoRenewal": true,
      "billedDate": "string",
      "brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
      "brandDisplayName": "ABC Mobile",
      "campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMP1",
      "createDate": "string",
      "cspId": "string",
      "description": "string",
      "directLending": true,
      "embeddedLink": true,
      "embeddedPhone": true,
      "helpKeywords": "string",
      "helpMessage": "string",
      "messageFlow": "string",
      "mock": true,
      "nextRenewalOrExpirationDate": "string",
      "numberPool": true,
      "optinKeywords": "string",
      "optinMessage": "string",
      "optoutKeywords": "string",
      "optoutMessage": "string",
      "referenceId": "string",
      "resellerId": "string",
      "sample1": "string",
      "sample2": "string",
      "sample3": "string",
      "sample4": "string",
      "sample5": "string",
      "status": "string",
      "subUsecases": [
        "string"
      ],
      "subscriberHelp": true,
      "subscriberOptin": true,
      "subscriberOptout": true,
      "termsAndConditions": true,
      "usecase": "string",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "isTMobileRegistered": true,
      "isTMobileSuspended": true,
      "isTMobileNumberPoolingEnabled": true,
      "campaignStatus": "TCR_ACCEPTED",
      "privacyPolicyLink": "string",
      "termsAndConditionsLink": "string",
      "embeddedLinkSample": "string",
      "assignedPhoneNumbersCount": 3
    }
  ],
  "page": 0,
  "totalRecords": 0
}