Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Detail Records

Search detail records

Search for any detail record across the Telnyx Platform

get/detail_records

Query parameters

date_range'yesterday' | 'today' | 'tomorrow' | 'last_week' | 'this_week' | 'next_week' | 'last_month' | 'this_month' | 'next_month'

Filter by the given user-friendly date range. You can specify one of the following enum values, or a dynamic one using this format: last_N_days.

record_type'ai-voice-assistant' | 'amd' | 'call-control' | 'conference' | 'conference-participant' | 'embedding' | 'fax' | 'inference' | 'inference-speech-to-text' | 'media_storage' | 'media-streaming' | 'messaging' | 'noise-suppression' | 'recording' | 'sip-trunking' | 'siprec-client' | 'stt' | 'tts' | 'verify' | 'webrtc' | 'wireless' required

Filter by the given record type.

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

sortstring[]

Specifies the sort order for results. <br/>Example: sort=-created_at

numberinteger

Page number

sizeinteger

Page size

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

Response

Successful

Example response

{
  "data": [
    {
      "carrier": "T-Mobile USA",
      "carrier_fee": "0.003",
      "cld": "+1555123456",
      "cli": "+1555123456",
      "completed_at": "2020-07-01T00:00:00Z",
      "cost": "0.003",
      "country_code": "US",
      "created_at": "2020-07-01T00:00:00Z",
      "currency": "USD",
      "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",
      "errors": [
        "40001"
      ],
      "mcc": "204",
      "message_type": "SMS",
      "mnc": "01",
      "on_net": true,
      "parts": 2,
      "profile_id": "30ef55db-c4a2-4c4a-9804-a68077973d07",
      "profile_name": "My Messaging Profile",
      "rate": "0.003",
      "record_type": "message_detail_record",
      "sent_at": "2020-07-01T00:00:00Z",
      "source_country_code": "US",
      "status": "delivered",
      "tags": "tag1,tag2,tag3",
      "updated_at": "2020-07-01T00:00:00Z",
      "user_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "uuid": "3ca7bd3d-7d82-4e07-9df4-009123068320"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}