Telnyx

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

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

Show child attributes

filter[record_type]

enum<string>

required

Filter by the given record type.

Available options:

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

filter[date_range]

enum<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.

Available options:

yesterday,

today,

tomorrow,

last_week,

this_week,

next_week,

last_month,

this_month,

next_month

sort

string[]

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

page

object

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

Show child attributes

page[number]

integer<int32>

default:1

Page number

Required range: x >= 1

page[size]

integer<int32>

default:20

Page size

Required range: 1 <= x <= 50

Response

Successful

data

An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records

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

Show child attributes

data.record_type

string

default:message_detail_record

required

Identifies the record schema

Example:

"message_detail_record"

data.uuid

string

Unique identifier of the message

Example:

"3ca7bd3d-7d82-4e07-9df4-009123068320"

data.user_id

string

Identifier of the Telnyx account who owns the message

Example:

"3ca7bd3d-7d82-4e07-9df4-009123068320"

data.completed_at

string<date-time>

Message completion time

Example:

"2020-07-01T00:00:00Z"

data.created_at

string<date-time>

Message creation time

Example:

"2020-07-01T00:00:00Z"

data.updated_at

string<date-time>

Message updated time

Example:

"2020-07-01T00:00:00Z"

data.sent_at

string<date-time>

Time when the message was sent

Example:

"2020-07-01T00:00:00Z"

data.carrier

string

Country-specific carrier used to send or receive the message

Example:

"T-Mobile USA"

data.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

Example:

"0.003"

data.cld

string

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

Example:

"+1555123456"

data.cli

string

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

Example:

"+1555123456"

data.country_code

string

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

Example:

"US"

data.delivery_status

string

Final webhook delivery status

Example:

"success: webhook succeeded"

data.delivery_status_failover_url

string

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

Example:

"https://api.example.com/sms/telnyx/inbound"

data.delivery_status_webhook_url

string

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

Example:

"https://api.example.com/sms/telnyx/inbound"

data.direction

enum<string>

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

Available options:

inbound,

outbound

Example:

"outbound"

data.fteu

boolean

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

Example:

false

data.mcc

string

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

Example:

"204"

data.mnc

string

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

Example:

"01"

data.message_type

enum<string>

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)

Available options:

SMS,

MMS,

RCS

Example:

"SMS"

data.on_net

boolean

Indicates whether both sender and recipient numbers are Telnyx-managed

Example:

true

data.profile_id

string

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

Example:

"30ef55db-c4a2-4c4a-9804-a68077973d07"

data.profile_name

string

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

Example:

"My Messaging Profile"

data.source_country_code

string

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

Example:

"US"

data.status

enum<string>

Final status of the message after the delivery attempt

Available options:

gw_timeout,

delivered,

dlr_unconfirmed,

dlr_timeout,

received,

gw_reject,

failed

Example:

"delivered"

data.tags

string

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

Example:

"tag1,tag2,tag3"

data.rate

string

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

Example:

"0.003"

data.currency

string

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

Example:

"USD"

data.cost

string

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

Example:

"0.003"

data.errors

string[]

Telnyx API error codes returned by the Telnyx gateway

data.parts

integer

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

Example:

2

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup