Skip to main content
GET
/
detail_records
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 detailRecordListResponse of client.detailRecords.list()) {
  console.log(detailRecordListResponse);
}
{
  "data": [
    {
      "record_type": "message_detail_record",
      "uuid": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "user_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "completed_at": "2020-07-01T00:00:00Z",
      "created_at": "2020-07-01T00:00:00Z",
      "updated_at": "2020-07-01T00:00:00Z",
      "sent_at": "2020-07-01T00:00:00Z",
      "carrier": "T-Mobile USA",
      "carrier_fee": "0.003",
      "cld": "+1555123456",
      "cli": "+1555123456",
      "country_code": "US",
      "delivery_status": "success: webhook succeeded",
      "delivery_status_failover_url": "https://api.example.com/sms/telnyx/inbound",
      "delivery_status_webhook_url": "https://api.example.com/sms/telnyx/inbound",
      "direction": "outbound",
      "fteu": false,
      "mcc": "204",
      "mnc": "01",
      "message_type": "SMS",
      "on_net": true,
      "profile_id": "30ef55db-c4a2-4c4a-9804-a68077973d07",
      "profile_name": "My Messaging Profile",
      "source_country_code": "US",
      "status": "delivered",
      "tags": "tag1,tag2,tag3",
      "rate": "0.003",
      "currency": "USD",
      "cost": "0.003",
      "errors": [
        "40001"
      ],
      "parts": 2
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
filter
object

Filter records on a given record attribute and value.
Example: filter[status]=delivered.
Required: filter[record_type] must be specified.

​
sort
string[]

Specifies the sort order for results.
Example: sort=-created_at

​
page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful

​
data
(Message · object | Conference · object | Conference Participant · object | AMD · object | Verify 2FA · object | Sim Card Usage · object | Media Storage · object)[]

An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records

​
meta
object