Open SidemenuAPI Reference
API Reference
Close Sidemenu

Detail Records

Search detail recordsDetailRecordsSearch

get https://api.telnyx.com/v2/detail_records

Search for any detail record across the Telnyx Platform

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]=&filter[date_range]="
Parameters
In query
filter[record_type]
string
required

Filter by the given record type

filter[date_range]
string
optional

Filter by the given user-friendly date range

filter
object
optional

Filter records

page[number]
integer (int32) (1)
optional

Page number

Default: 1
page[size]
integer (int32) (1 - 50)
optional

Page size

Default: 20
sort
array of string
optional

Specifies the sort order for results

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": [
        {}
      ],
      "fteu": false,
      "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"
    },
    {
      "call_leg_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "call_sec": 100,
      "call_session_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "connection_id": "1583941447772537867",
      "ended_at": "2020-07-01T00:00:00-06:00",
      "expires_at": "2020-07-01T00:00:00-06:00",
      "id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "is_telnyx_billable": false,
      "name": "My Conference",
      "participant_call_sec": 100,
      "participant_count": 5,
      "record_type": "conference_detail_record",
      "region": "ch1",
      "started_at": "2020-07-01T00:00:00-06:00",
      "user_id": "3ca7bd3d-7d82-4e07-9df4-009123068320"
    },
    {
      "billed_sec": 120,
      "call_leg_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "call_sec": 100,
      "call_session_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "conference_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "cost": "0.004",
      "currency": "USD",
      "destination_number": "+18005550199",
      "id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "is_telnyx_billable": true,
      "joined_at": "2020-07-01T00:00:00-06:00",
      "left_at": "2020-07-01T00:00:00-06:00",
      "originating_number": "+18005550199",
      "rate": "0.002",
      "rate_measured_in": "minutes",
      "record_type": "conference_participant_detail_record",
      "user_id": "3ca7bd3d-7d82-4e07-9df4-009123068320"
    },
    {
      "created_at": "2021-08-06T03:32:01.125Z",
      "currency": "USD",
      "direction": "inbound",
      "id": "gBOGyfgaqtrewgpRTGqKuHKaTRhP",
      "message_status": "delivered",
      "message_type": "session",
      "recipient_id": "18336512500",
      "recipient_region_code": "US",
      "record_type": "whatsapp_detail_record",
      "sender_id": "18336512500",
      "telnyx_fee": 0.003,
      "version": "v0.1.0",
      "webhook_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "webhook_received_at": "2021-08-06T03:32:01.125Z",
      "whatsapp_error_code": "490",
      "whatsapp_fee": 0.003
    },
    {
      "billing_group_id": "01977831-abdd-4894-84f3-244385621424",
      "billing_group_name": "Billing group name",
      "call_leg_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "call_session_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "connection_id": "1684947189014463919",
      "connection_name": "Name of the connection with id specified in connection_id field",
      "cost": "0.004",
      "currency": "USD",
      "feature": "PREMIUM",
      "id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "invoked_at": "2020-07-01T00:00:00Z",
      "is_telnyx_billable": true,
      "rate": "0.002",
      "rate_measured_in": "invocations",
      "record_type": "amd_detail_record",
      "tags": "tag1,tag2"
    },
    {
      "created_at": "2021-07-08T00:00:41.000000+00:00",
      "currency": "USD",
      "delivery_status": "pending",
      "destination_phone_number": "+13124515883",
      "id": "0add777f-1549-46f7-84e9-ad7350f6aa97",
      "rate": "0.002",
      "rate_measured_in": "number of occurrences",
      "record_type": "verification_detail_record",
      "updated_at": "2021-07-08T00:00:41.000000+00:00",
      "verification_status": "pending",
      "verify_channel_id": "5b7a8365-91f3-420a-befc-498d1efd6c20",
      "verify_channel_type": "sms",
      "verify_profile_id": "49000176-1ab2-8bc1-352e-4009f6c37f82",
      "verify_usage_fee": "0.002"
    },
    {
      "closed_at": "2020-07-01T00:00:00Z",
      "created_at": "2020-07-01T00:00:00Z",
      "currency": "USD",
      "data_cost": "0.0292830",
      "data_rate": "0.06000",
      "data_unit": "MB",
      "downlink_data": "0.1240",
      "id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "imsi": "311210393720093",
      "ip_address": "100.64.1.2",
      "mcc": "204",
      "mnc": "69",
      "phone_number": "+15188490209",
      "record_type": "sim_card_usage",
      "sim_card_id": "7aa66686-b39f-456d-8edc-5b6cffb1432a",
      "sim_card_tags": "mytag",
      "sim_group_id": "6c07e2e9-cbc0-49ba-ac0d-c59b59646bb1",
      "sim_group_name": "SIMBillingInfo test - otheraccount",
      "uplink_data": "0.7653"
    },
    {
      "action_type": "upload",
      "asset_id": "a46f4764-4ce4-4391-804c-02f00bc4ff9b",
      "cost": "0.004",
      "created_at": "2020-07-01T00:00:00Z",
      "currency": "USD",
      "id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "link_channel_id": "2065f482-64b9-4680-a3a9-c6d3142efdf7",
      "link_channel_type": "message",
      "org_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "rate": "0.0001",
      "rate_measured_in": "events",
      "record_type": "media_storage",
      "status": "failed",
      "user_id": "3ca7bd3d-7d82-4e07-9df4-009123068320",
      "webhook_id": "b46f4764-4ce4-4391-804c-02f00bc4ff9b"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}
Previous: Overview
Next: Webhooks

Was this section helpful?