Search detail records

GET 
/detail_records

Search for any detail record across the Telnyx Platform

Query Parameters

filter object

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

Examples:

• filter[record_type]=messaging
• filter[record_type]=verify
• filter[date_range]=today
• filter[date_range]=yesterday
• filter[date_range]=last_month
• filter[created_at][gte]=2021-06-22
• filter[created_at][lt]=2021-06-23
• filter[direction]=inbound
• filter[cld][contains]=456
• filter[cld][starts_with]=123
• filter[cld][ends_with]=789

Searches for messaging detail records

Example: messaging

Searches for verify detail records

Example: verify

Searches for records with timestamp starting at `00:00:00` of the current day

Example: today

Searches for records with timestamp starting at `00:00:00` of yesterday

Example: yesterday

Searches for records with timestamp starting at `00:00:00` on the first day of the month

Example: last_month

Searches for records with `created_at` starting at `2021-06-22`

Example: 2021-06-22

Searches for records with `created_at` ending at `2021-06-22`

Example: 2021-06-23

Searches for records which have the property `direction` equal to `inbound`

Example: inbound

Searches for records which have the property `cld` containing the pattern `456`

Example: 456

Searches for records which have the property `cld` starting with the prefix `123`

Example: 123

Searches for records which have the property `cld` ending with the suffix `789`

Example: 789

sort string[]

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

Examples:

• sort=created_at
• sort=-created_at

Sorts search results using the `created_at` date-time in ascending order

Example: created_at

Sorts search results using the `created_at` date-time in descending order

Example: created_at

page object

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

Examples:

• page[number]=1&page[size]=20
• page[number]=2&page[size]=20
• page[number]=1&page[size]=50

Default pagination with first page and 20 items per page

Example: {"number":1,"size":20}

Second page with 20 items per page

Example: {"number":2,"size":20}

First page with maximum 50 items per page

Example: {"number":1,"size":50}

200: Successful

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

oneOf

• Message
• Conference
• Conference Participant
• AMD
• Verify 2FA
• Sim Card Usage
• Media Storage

uuid string

Unique identifier of the message

user_id string

Identifier of the Telnyx account who owns the message

completed_at date-time

Message completion time

created_at date-time

Message creation time

updated_at date-time

Message updated time

sent_at date-time

Time when the message was sent

carrier string

Country-specific carrier used to send or receive the message

carrier_fee string

Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table

cld string

The recipient of the message (to parameter in the Messaging API)

cli string

The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value

country_code string

Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format

delivery_status string

Final webhook delivery status

delivery_status_failover_url string

Failover customer-provided URL which Telnyx posts delivery status webhooks to

delivery_status_webhook_url string

Primary customer-provided URL which Telnyx posts delivery status webhooks to

direction string

Possible values: [inbound, outbound]

Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise

fteu boolean

Indicates whether this is a Free-To-End-User (FTEU) short code message

mcc string

Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID

mnc string

Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID

message_type string

Possible values: [SMS, MMS, RCS]

Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS)

on_net boolean

Indicates whether both sender and recipient numbers are Telnyx-managed

profile_id string

Unique identifier of the Messaging Profile used to send or receive the message

profile_name string

Name of the Messaging Profile used to send or receive the message

source_country_code string

Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format

status string

Possible values: [gw_timeout, delivered, dlr_unconfirmed, dlr_timeout, received, gw_reject, failed]

Final status of the message after the delivery attempt

tags string

Comma-separated tags assigned to the Telnyx number associated with the message

rate string

Currency amount per billing unit used to calculate the Telnyx billing cost

currency string

Telnyx account currency used to describe monetary values, including billing cost

cost string

Amount, in the user currency, for the Telnyx billing cost

errors string[]

Telnyx API error codes returned by the Telnyx gateway

parts integer

Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters

record_type stringrequired

Default value: message_detail_record

Identifies the record schema

id string

Conference id

name string

Conference name

user_id string

User id

started_at date-time

Conference start time

ended_at date-time

Conference end time

expires_at date-time

Conference expiry time

region string

Region where the conference is hosted

call_leg_id string

Telnyx UUID that identifies the conference call leg

call_session_id string

Telnyx UUID that identifies with conference call session

connection_id string

Connection id

call_sec integer

Duration of the conference call in seconds

participant_count integer

Number of participants that joined the conference call

participant_call_sec integer

Sum of the conference call duration for all participants in seconds

is_telnyx_billable boolean

Indicates whether Telnyx billing charges might be applicable

record_type stringrequired

Default value: conference_detail_record

id string

Participant id

user_id string

User id

conference_id string

Conference id

joined_at date-time

Participant join time

left_at date-time

Participant leave time

destination_number string

Number called by the participant to join the conference

originating_number string

Participant origin number used in the conference call

call_leg_id string

Telnyx UUID that identifies the conference call leg

call_session_id string

Telnyx UUID that identifies with conference call session

call_sec integer

Duration of the conference call in seconds

billed_sec integer

Duration of the conference call for billing purposes

is_telnyx_billable boolean

Indicates whether Telnyx billing charges might be applicable

rate string

Currency amount per billing unit used to calculate the Telnyx billing cost

rate_measured_in string

Billing unit used to calculate the Telnyx billing cost

cost string

Currency amount for Telnyx billing cost

currency string

Telnyx account currency used to describe monetary values, including billing cost

record_type stringrequired

Default value: conference_participant_detail_record

id string

Feature invocation id

invoked_at date-time

Feature invocation time

feature string

Possible values: [PREMIUM]

Feature name

tags string

User-provided tags

billing_group_id string

Billing Group id

billing_group_name string

Name of the Billing Group specified in billing_group_id

connection_id string

Connection id

connection_name string

Connection name

call_leg_id string

Telnyx UUID that identifies the related call leg

call_session_id string

Telnyx UUID that identifies the related call session

is_telnyx_billable boolean

Indicates whether Telnyx billing charges might be applicable

rate string

Currency amount per billing unit used to calculate the Telnyx billing cost

rate_measured_in string

Billing unit used to calculate the Telnyx billing cost

cost string

Currency amount for Telnyx billing cost

currency string

Telnyx account currency used to describe monetary values, including billing cost

record_type stringrequired

Default value: amd_detail_record

id uuid

Unique ID of the verification

verify_profile_id uuid

delivery_status string

verification_status string

destination_phone_number string

E.164 formatted phone number

verify_channel_type string

Possible values: [sms, psd2, call, flashcall]

Depending on the type of verification, the verify_channel_id points to one of the following channel ids;

verify_channel_type | verify_channel_id ------------------- | ----------------- sms, psd2 | messaging_id call, flashcall | call_control_id

verify_channel_id uuid

created_at date-time

updated_at date-time

rate string

Currency amount per billing unit used to calculate the Telnyx billing costs

rate_measured_in string

Billing unit used to calculate the Telnyx billing costs

verify_usage_fee string

Currency amount for Verify Usage Fee

currency string

Telnyx account currency used to describe monetary values, including billing costs

record_type stringrequired

Default value: verification_detail_record

id uuid

Unique identifier for this SIM Card Usage

created_at date-time

Event creation time

closed_at date-time

Event close time

ip_address string

Ip address that generated the event

downlink_data number

Number of megabytes downloaded

imsi string

International Mobile Subscriber Identity

mcc string

Mobile country code

mnc string

Mobile network code

currency string

Telnyx account currency used to describe monetary values, including billing cost

data_unit string

Unit of wireless link consumption

data_rate string

Currency amount per billing unit used to calculate the Telnyx billing cost

sim_group_name string

Sim group name for sim card

sim_card_id string

Unique identifier for SIM card

sim_group_id string

Unique identifier for SIM group

sim_card_tags string

User-provided tags

phone_number string

Telephone number associated to SIM card

uplink_data number

Number of megabytes uploaded

data_cost number

Data cost

record_type stringrequired

Default value: sim_card_usage

id string

Unique identifier for the Media Storage Event

created_at date-time

Event creation time

asset_id string

Asset id

user_id string

User id

org_id string

Organization owner id

action_type string

Type of action performed against the Media Storage API

link_channel_type string

Link channel type

link_channel_id string

Link channel id

status string

Request status

webhook_id string

Webhook id

rate string

Currency amount per billing unit used to calculate the Telnyx billing cost

rate_measured_in string

Billing unit used to calculate the Telnyx billing cost

cost string

Currency amount for Telnyx billing cost

currency string

Telnyx account currency used to describe monetary values, including billing cost

record_type stringrequired

Default value: media_storage

]

meta

object

total_pages int32

total_results int32

page_number int32

page_size int32

{
  "data": [
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/detail_records' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "data": [
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}