List Shared Campaigns

Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion.

This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.

GET /10dlc/partner_campaigns

JavaScript

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 telnyxDownstreamCampaign of client.messaging10dlc.partnerCampaigns.list()) {
  console.log(telnyxDownstreamCampaign.tcrBrandId);
}

200

{
  "records": [
    {
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMP1",
      "ageGated": true,
      "assignedPhoneNumbersCount": 3,
      "brandDisplayName": "ABC Mobile",
      "campaignStatus": "TCR_ACCEPTED",
      "description": "<string>",
      "directLending": true,
      "embeddedLink": true,
      "embeddedLinkSample": "<string>",
      "embeddedPhone": true,
      "failureReasons": "<string>",
      "helpKeywords": "<string>",
      "helpMessage": "<string>",
      "isNumberPoolingEnabled": true,
      "messageFlow": "<string>",
      "numberPool": true,
      "optinKeywords": "<string>",
      "optinMessage": "<string>",
      "optoutKeywords": "<string>",
      "optoutMessage": "<string>",
      "privacyPolicyLink": "<string>",
      "usecase": "<string>",
      "sample1": "<string>",
      "sample2": "<string>",
      "sample3": "<string>",
      "sample4": "<string>",
      "sample5": "<string>",
      "subUsecases": [
        "<string>"
      ],
      "subscriberOptin": true,
      "subscriberOptout": true,
      "termsAndConditions": true,
      "termsAndConditionsLink": "<string>",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186"
    }
  ],
  "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

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, brandDisplayName, -brandDisplayName, tcrBrandId, -tcrBrandId, tcrCampaignId, -tcrCampaignId, createdAt, -createdAt, campaignStatus, -campaignStatus

Response

200

application/json

Successful Response

records · TelnyxDownstreamCampaign · object[]

Show child attributes

page · integer

totalRecords · integer