Skip to main content
GET
/
10dlc
/
campaign
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const campaignListResponse of client.messaging10dlc.campaign.list({ brandId: 'brandId' })) {
  console.log(campaignListResponse.ageGated);
}
{
  "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>",
      "vertical": "<string>",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "isTMobileRegistered": true,
      "isTMobileSuspended": true,
      "isTMobileNumberPoolingEnabled": true,
      "failureReasons": "<string>",
      "submissionStatus": "CREATED",
      "campaignStatus": "TCR_ACCEPTED",
      "privacyPolicyLink": "<string>",
      "termsAndConditionsLink": "<string>",
      "embeddedLinkSample": "<string>",
      "assignedPhoneNumbersCount": 3
    }
  ],
  "page": 123,
  "totalRecords": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
brandId
string
required
​
page
integer
default:1

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

​
recordsPerPage
integer
default:10

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

​
sort
enum<string>
default:-createdAt

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

Available options:
assignedPhoneNumbersCount,
-assignedPhoneNumbersCount,
campaignId,
-campaignId,
createdAt,
-createdAt,
status,
-status,
tcrCampaignId,
-tcrCampaignId

Response

Successful Response

​
records
TelnyxCampaignWithAssignedCount_CSP · object[]
​
page
integer
​
totalRecords
integer