List phone number campaigns

GET /10dlc/phone_number_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 phoneNumberCampaign of client.messaging10dlc.phoneNumberCampaigns.list()) {
  console.log(phoneNumberCampaign.campaignId);
}

200

{
  "records": [
    {
      "phoneNumber": "[phone]",
      "campaignId": "<string>",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186",
      "brandId": "7ba705b7-22af-493f-addc-ac04b7ca071c",
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMPA1",
      "telnyxCampaignId": "3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba",
      "assignmentStatus": "ASSIGNED",
      "failureReasons": "<string>"
    }
  ],
  "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

recordsPerPage · integer · default: 20

page · integer · default: 1

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id], filter[tcr_brand_id]

Show child attributes

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: assignmentStatus, -assignmentStatus, createdAt, -createdAt, phoneNumber, -phoneNumber

Response

200

application/json

Successful Response

records · PhoneNumberCampaign · object[] · required

Show child attributes

page · integer · required

totalRecords · integer · required