Telnyx

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);
}

{
  "records": [
    {
      "phoneNumber": "+18005550199",
      "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
}

GET

phone_number_campaigns

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);
}

{
  "records": [
    {
      "phoneNumber": "+18005550199",
      "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

filter[telnyx_campaign_id]

string<uuid>

Filter results by the Telnyx Campaign id

Example:

"f3575e15-32ce-400e-a4c0-dd78800c20b0"

filter[telnyx_brand_id]

string<uuid>

Filter results by the Telnyx Brand id

Example:

"f3575e15-32ce-400e-a4c0-dd78800c20b0"

filter[tcr_campaign_id]

string

Filter results by the TCR Campaign id

Example:

"CAMPID3"

filter[tcr_brand_id]

string

Filter results by the TCR Brand id

Example:

"BRANDID"

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

Successful Response

records

PhoneNumberCampaign · object[]

required

Show child attributes

records.phoneNumber

string

required

Example:

"+18005550199"

records.campaignId

string

required

For shared campaigns, this is the TCR campaign ID, otherwise it is the campaign ID

records.createdAt

string

required

Example:

"2021-03-08T17:57:48.801186"

records.updatedAt

string

required

Example:

"2021-03-08T17:57:48.801186"

records.brandId

string

Brand ID. Empty if the number is associated to a shared campaign.

Example:

"7ba705b7-22af-493f-addc-ac04b7ca071c"

records.tcrBrandId

string

TCR's alphanumeric ID for the brand.

Example:

"BBRAND1"

records.tcrCampaignId

string

TCR's alphanumeric ID for the campaign.

Example:

"CCAMPA1"

records.telnyxCampaignId

string

Campaign ID. Empty if the number is associated to a shared campaign.

Example:

"3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba"

records.assignmentStatus

enum<string>

The assignment status of the number.

Available options:

FAILED_ASSIGNMENT,

PENDING_ASSIGNMENT,

ASSIGNED,

PENDING_UNASSIGNMENT,

FAILED_UNASSIGNMENT

Example:

"ASSIGNED"

records.failureReasons

string

Extra info about a failure to assign/unassign a number. Relevant only if the assignmentStatus is either FAILED_ASSIGNMENT or FAILED_UNASSIGNMENT

page

integer

required

totalRecords

integer

required

List shared partner campaigns Create New Phone Number Campaign

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List phone number campaigns

Authorizations

Query Parameters

Response