Detail Records API

Detail Records operations API

Search detail records

Search for any detail record across the Telnyx Platform.

SecuritybearerAuth

Request

query Parameters

filter[record_type] required	string Filter by the given record type. Enum: "amd" "conference" "conference-participant" "media_storage" "messaging" "verify" "wireless" Examples: Searches for messaging detail records filter[record_type]=messaging Searches for verify detail records filter[record_type]=verify
filter[date_range]	string 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. Enum: "yesterday" "today" "tomorrow" "last_week" "this_week" "next_week" "last_month" "this_month" "next_month" Examples: Searches for records with timestamp starting at `00:00:00` on the first day of the month filter[date_range]=last_month Searches for records with timestamp starting at `00:00:00` of the current day filter[date_range]=today Searches for records with timestamp starting at `00:00:00` of yesterday filter[date_range]=yesterday
	object Filter records on a given record attribute and value. Example: filter[status]=delivered Examples: Searches for records which have the property `cld` containing the pattern `456` filter=456 Searches for records which have the property `cld` ending with the suffix `789` filter=789 Searches for records which have the property `cld` starting with the prefix `123` filter=123 Searches for records with `created_at` starting at `2021-06-22` filter=2021-06-22 Searches for records with `created_at` ending at `2021-06-22` filter=2021-06-23 Searches for records which have the property `direction` equal to `inbound` filter=inbound
page[number]	integer <int32> >= 1 Default: 1 Page number
page[size]	integer <int32> [ 1 .. 50 ] Default: 20 Page size
sort	Array of strings Specifies the sort order for results. Example: sort=-created_at Examples: Sorts search results using the `created_at` date-time in descending order sort=created_at Sorts search results using the `created_at` date-time in ascending order sort=created_at

Responses

200

Successful

Response Schema: application/json

	Array of objects (DetailRecord)
	object (PaginationMeta)

get/detail_records

Request samples

Response samples

application/json

{"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": 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"
}
],
"meta": {"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}