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

{
  "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
}

GET

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

{
  "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,

-tcrBranId,

tcrCampaignId,

-tcrCampaignId,

createdAt,

-createdAt,

campaignStatus,

-campaignStatus

Response

Successful Response

records

TelnyxDownstreamCampaign · object[]

Show child attributes

records.tcrBrandId

string

required

Unique identifier assigned to the brand by the registry.

Example:

"BBRAND1"

records.tcrCampaignId

string

required

Unique identifier assigned to the campaign by the registry.

Example:

"CCAMP1"

records.ageGated

boolean

Age gated content in campaign.

records.assignedPhoneNumbersCount

number

Number of phone numbers associated with the campaign

Example:

3

records.brandDisplayName

string

Display or marketing name of the brand.

Example:

"ABC Mobile"

records.campaignStatus

enum<string>

Campaign status

Available options:

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

Example:

"TCR_ACCEPTED"

records.description

string

Summary description of this campaign.

records.directLending

boolean

Direct lending or loan arrangement.

records.embeddedLink

boolean

Does message generated by the campaign include URL link in SMS?

records.embeddedLinkSample

string

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

records.embeddedPhone

boolean

Does message generated by the campaign include phone number in SMS?

records.failureReasons

string

Failure reasons if campaign submission failed

records.helpKeywords

string

Subscriber help keywords. Multiple keywords are comma separated without space.

records.helpMessage

string

Help message of the campaign.

records.isNumberPoolingEnabled

boolean

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

records.messageFlow

string

Message flow description.

records.numberPool

boolean

Does campaign utilize pool of phone numbers?

records.optinKeywords

string

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

records.optinMessage

string

Subscriber opt-in message.

records.optoutKeywords

string

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

records.optoutMessage

string

Subscriber opt-out message.

records.privacyPolicyLink

string

Link to the campaign's privacy policy.

records.usecase

string

Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.

records.sample1

string

Message sample. Some campaign tiers require 1 or more message samples.

records.sample2

string

Message sample. Some campaign tiers require 2 or more message samples.

records.sample3

string

Message sample. Some campaign tiers require 3 or more message samples.

records.sample4

string

Message sample. Some campaign tiers require 4 or more message samples.

records.sample5

string

Message sample. Some campaign tiers require 5 or more message samples.

records.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

records.subscriberOptin

boolean

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

records.subscriberOptout

boolean

Does campaign support subscriber opt-out keyword(s)?

records.termsAndConditions

boolean

Is terms & conditions accepted?

records.termsAndConditionsLink

string

Link to the campaign's terms and conditions.

records.webhookURL

string

Webhook to which campaign status updates are sent.

Example:

"https://example.com/webhook"

records.webhookFailoverURL

string

Failover webhook to which campaign status updates are sent.

Example:

"https://example.com/failover-webhook"

records.createdAt

string

Date and time that the brand was created at.

Example:

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

records.updatedAt

string

Date and time that the brand was last updated at.

Example:

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

page

integer

totalRecords

integer

Qualify By Usecase Get Single Shared Campaign

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List Shared Campaigns

Authorizations

Query Parameters

Response