Search detail records

gethttps://api.telnyx.com/v2/detail_records

Search for any detail record across the Telnyx Platform. Examples and additional information found here.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/detail_records?filter[record_type]=string&filter[date_range]=string"

Parameters

In Query
filter[record_type]
string
required
Filter by the given record type.
Options: [ "amd", "conference", "conference-participant", "media_storage", "messaging", "verify", "whatsapp", "whatsapp-conversation", "wireless" ]
filter[date_range]
string
optional
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.
Options: [ "yesterday", "today", "tomorrow", "last_week", "this_week", "next_week", "last_month", "this_month", "next_month" ]
filter
object
optional
Filter records on a given record attribute and value.
Example: filter[status]=delivered
page[number]
integer
(int32)
optional
Page number
Default:
1
page[size]
integer
(int32)
optional
Page size
Default:
20
sort
array of string
optional
Specifies the sort order for results.
Example: sort=-created_at

Responses

200
Successful

Success 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",
      "fteu": "boolean",
      "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
  }
}
Previous:
Debugging
Was this page helpful?