List Verification Requests

Get a list of previously-submitted tollfree verification requests

GET /messaging_tollfree/verification/requests

JavaScript

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

200

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

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>

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

business_name · string

Filter verification requests by business name

Response

200

application/json

Successful Response

A paginated response

records · VerificationRequestStatus · object[] · required

The records yielded by this request

Show child attributes

total_records · integer · default: 0 · required

The total amount of records for these query parameters