Skip to main content
GET
/
messaging_tollfree
/
verification
/
requests
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 verificationRequestStatus of client.messagingTollfree.verification.requests.list({
  page: 1,
  page_size: 1,
})) {
  console.log(verificationRequestStatus.id);
}
{
  "records": [],
  "total_records": 0
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
required

Page number to retrieve (1-based).

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.
Required range: x >= 1
date_start
string<date-time>

Start of the date range filter (inclusive, ISO 8601).

date_end
string<date-time>

End of the date range filter (inclusive, ISO 8601).

status
enum<string>

Filter results by status. Tollfree verification status

Available options:
Verified,
Rejected,
Waiting For Vendor,
Waiting For Customer,
Waiting For Telnyx,
In Progress
phone_number
string

Filter results by phone number.

business_name
string

Filter verification requests by business name

Response

Successful Response

A paginated response

records
VerificationRequestStatus · object[]
required

The records yielded by this request

total_records
integer
default:0
required

The total amount of records for these query parameters