Telnyx

{ "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. 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. 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[]

Show child attributes

records.ageGated

boolean

Age gated content in campaign.

records.autoRenewal

boolean

Campaign subscription auto-renewal status.

records.billedDate

string

Campaign recent billed date.

records.brandId

string

Unique identifier assigned to the brand.

Example:

"d2ca9d69-641b-4131-83fa-5d0744f4c8a9"

records.brandDisplayName

string

Display or marketing name of the brand.

Example:

"ABC Mobile"

records.campaignId

string

Unique identifier for a campaign.

Example:

"823d6b1a-6ed6-41a3-9c50-c8ff41b682ba"

records.tcrBrandId

string

Unique identifier assigned to the brand by the registry.

Example:

"BBRAND1"

records.tcrCampaignId

string

Unique identifier assigned to the campaign by the registry.

Example:

"CCAMP1"

records.createDate

string

Unix timestamp when campaign was created.

records.cspId

string

Alphanumeric identifier of the CSP associated with this campaign.

records.description

string

Summary description of this campaign.

records.directLending

boolean

records.embeddedLink

boolean

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

records.embeddedPhone

boolean

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

records.helpKeywords

string

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

records.helpMessage

string

Help message of the campaign.

records.messageFlow

string

Message flow description.

records.mock

boolean

Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.

records.nextRenewalOrExpirationDate

string

When the campaign would be due for its next renew/bill date.

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

string

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

records.resellerId

string

Alphanumeric identifier of the reseller that you want to associate with this campaign.

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

string

Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

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

boolean

Does campaign responds to help keyword(s)?

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

string

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

records.vertical

string

deprecated

Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.

This field is deprecated.

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

boolean

Indicates whether the campaign is registered with T-Mobile.

records.isTMobileSuspended

boolean

Indicates whether the campaign is suspended with T-Mobile.

records.isTMobileNumberPoolingEnabled

boolean

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

records.failureReasons

string

Failure reasons if campaign submission failed

records.submissionStatus

enum<string>

Campaign submission status

Available options:

CREATED,

FAILED,

PENDING

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

string

Link to the campaign's privacy policy.

records.termsAndConditionsLink

string

Link to the campaign's terms and conditions.

records.embeddedLinkSample

string

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

records.assignedPhoneNumbersCount

number

Number of phone numbers associated with the campaign

Example:

3

page

integer

totalRecords

integer

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup