Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const requests = await client.messagingTollfree.verification.requests.list({ page: 1, page_size: 1 }); console.log(requests.records);

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

required

Required range: x >= 1

page_size

integer

required

Request this many records per page

    This value is automatically clamped if the provided value is too large.
    

    Request this many records per page

    This value is automatically clamped if the provided value is too large.

Required range: x >= 1

date_start

string<date-time>

date_end

string<date-time>

status

enum<string>

Tollfree verification status

Available options:

Verified,

Rejected,

Waiting For Vendor,

Waiting For Customer,

Waiting For Telnyx,

In Progress

phone_number

string

Response

Successful Response

A paginated response

records

VerificationRequestStatus · object[]

The records yielded by this request

Show child attributes

records.businessName

string

required

Example:

"Telnyx LLC"

records.corporateWebsite

string

required

Example:

"http://example.com"

records.businessAddr1

string

required

Example:

"600 Congress Avenue"

records.businessCity

string

required

Example:

"Austin"

records.businessState

string

required

Example:

"Texas"

records.businessZip

string

required

Example:

"78701"

records.businessContactFirstName

string

required

Example:

"John"

records.businessContactLastName

string

required

Example:

"Doe"

records.businessContactEmail

string

required

Example:

"email@example.com"

records.businessContactPhone

string

required

Example:

"+18889809750"

records.messageVolume

enum<string>

required

One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+

Available options:

10,

100,

1,000,

10,000,

100,000,

250,000,

500,000,

750,000,

1,000,000,

5,000,000,

10,000,000+

Example:

"100,000"

records.phoneNumbers

PhoneNumber · object[]

required

Show child attributes

records.phoneNumbers.phoneNumber

string

required

Example:

[
  { "phoneNumber": "+18773554398" },
  { "phoneNumber": "+18773554399" }
]

records.useCase

enum<string>

required

Tollfree usecase categories

Available options:

2FA,

App Notifications,

Appointments,

Auctions,

Auto Repair Services,

Bank Transfers,

Billing,

Booking Confirmations,

Business Updates,

COVID-19 Alerts,

Career Training,

Chatbot,

Conversational / Alerts,

Courier Services & Deliveries,

Emergency Alerts,

Events & Planning,

Financial Services,

Fraud Alerts,

Fundraising,

General Marketing,

General School Updates,

HR / Staffing,

Healthcare Alerts,

Housing Community Updates,

Insurance Services,

Job Dispatch,

Legal Services,

Mixed,

Motivational Reminders,

Notary Notifications,

Order Notifications,

Political,

Public Works,

Real Estate Services,

Religious Services,

Repair and Diagnostics Alerts,

Rewards Program,

Surveys,

System Alerts,

Voting Reminders,

Waitlist Alerts,

Webinar Reminders,

Workshop Alerts

Example:

"2FA"

records.useCaseSummary

string

required

Example:

"This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal"

records.productionMessageContent

string

required

Example:

"Your Telnyx OTP is XXXX"

records.optInWorkflow

string

required

Example:

"User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset"

records.optInWorkflowImageURLs

Url · object[]

required

Show child attributes

records.optInWorkflowImageURLs.url

string<uri>

required

Required string length: 1 - 2083

Example:

[
  { "url": "https://telnyx.com/sign-up" },
  {
    "url": "https://telnyx.com/company/data-privacy"
  }
]

records.additionalInformation

string

required

Example:

"This is for security purposes, blah blah blah"

records.isvReseller

string

required

Example:

"Yes"

records.id

string<uuid>

required

Example:

"eaba9f52-164e-58e0-b002-4f668e18b7ed"

records.verificationStatus

enum<string>

required

Tollfree verification status

Available options:

Verified,

Rejected,

Waiting For Vendor,

Waiting For Customer,

Waiting For Telnyx,

In Progress

Example:

"Pending Customer Feedback"

records.businessAddr2

string

Example:

"14th Floor"

records.webhookUrl

string

Example:

"http://example-webhook.com"

records.businessRegistrationNumber

string

Example:

"12-3456789"

records.businessRegistrationType

string

Example:

"EIN"

records.businessRegistrationCountry

string

Example:

"US"

records.doingBusinessAs

string

Example:

"Acme Services"

records.entityType

enum<string>

Business entity classification

Available options:

SOLE_PROPRIETOR,

PRIVATE_PROFIT,

PUBLIC_PROFIT,

NON_PROFIT,

GOVERNMENT

Example:

"PRIVATE_PROFIT"

records.optInConfirmationResponse

string

Example:

"You have successfully opted in to receive messages from Acme Corp"

records.helpMessageResponse

string

Example:

"Reply HELP for assistance or STOP to unsubscribe. Contact: support@example.com"

records.privacyPolicyURL

string

Example:

"https://example.com/privacy"

records.termsAndConditionURL

string

Example:

"https://example.com/terms"

records.ageGatedContent

boolean

Example:

false

records.optInKeywords

string

Example:

"START, YES, SUBSCRIBE"

records.reason

string

Example:

"Unfortunately, we have to cancel this request as we do not support non tollfree US numbers."

records.createdAt

string<date-time>

Example:

"2024-01-23T18:10:02.574Z"

records.updatedAt

string<date-time>

Example:

"2024-01-23T18:10:02.574Z"

total_records

integer

default:0

The total amount of records for these query parameters

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