Telnyx · Schema
DetailRecordsSearchResponse
CommunicationsCPaaSVoiceSMSIoTTelecommunicationsMessagingArtificial IntelligenceMCPVoice AIPhone NumbersInference
Properties
| Name | Type | Description |
|---|---|---|
| data | array | |
| meta | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-detail-records-search-response-schema.json",
"title": "DetailRecordsSearchResponse",
"x-generated": "2026-10-08",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/telnyx-detail-records-api-openapi.yml#/components/schemas/DetailRecordsSearchResponse",
"properties": {
"data": {
"items": {
"$ref": "#/$defs/DetailRecord"
},
"type": "array"
},
"meta": {
"$ref": "#/$defs/detail-records_PaginationMeta"
}
},
"type": "object",
"$defs": {
"AmdDetailRecord": {
"properties": {
"billing_group_id": {
"description": "Billing Group id",
"type": "string"
},
"billing_group_name": {
"description": "Name of the Billing Group specified in billing_group_id",
"type": "string"
},
"call_leg_id": {
"description": "Telnyx UUID that identifies the related call leg",
"type": "string"
},
"call_session_id": {
"description": "Telnyx UUID that identifies the related call session",
"type": "string"
},
"connection_id": {
"description": "Connection id",
"type": "string"
},
"connection_name": {
"description": "Connection name",
"type": "string"
},
"cost": {
"description": "Currency amount for Telnyx billing cost",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing cost",
"type": "string"
},
"feature": {
"description": "Feature name",
"enum": [
"PREMIUM"
],
"type": "string"
},
"id": {
"description": "Feature invocation id",
"type": "string"
},
"invoked_at": {
"description": "Feature invocation time",
"format": "date-time",
"type": "string"
},
"is_telnyx_billable": {
"description": "Indicates whether Telnyx billing charges might be applicable",
"type": "boolean"
},
"rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"rate_measured_in": {
"description": "Billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"record_type": {
"default": "amd_detail_record",
"type": "string"
},
"tags": {
"description": "User-provided tags",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"ConferenceDetailRecord": {
"properties": {
"call_leg_id": {
"description": "Telnyx UUID that identifies the conference call leg",
"type": "string"
},
"call_sec": {
"description": "Duration of the conference call in seconds",
"type": "integer"
},
"call_session_id": {
"description": "Telnyx UUID that identifies with conference call session",
"type": "string"
},
"connection_id": {
"description": "Connection id",
"type": "string"
},
"ended_at": {
"description": "Conference end time",
"format": "date-time",
"type": "string"
},
"expires_at": {
"description": "Conference expiry time",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Conference id",
"type": "string"
},
"is_telnyx_billable": {
"description": "Indicates whether Telnyx billing charges might be applicable",
"type": "boolean"
},
"name": {
"description": "Conference name",
"type": "string"
},
"participant_call_sec": {
"description": "Sum of the conference call duration for all participants in seconds",
"type": "integer"
},
"participant_count": {
"description": "Number of participants that joined the conference call",
"type": "integer"
},
"record_type": {
"default": "conference_detail_record",
"type": "string"
},
"region": {
"description": "Region where the conference is hosted",
"type": "string"
},
"started_at": {
"description": "Conference start time",
"format": "date-time",
"type": "string"
},
"user_id": {
"description": "User id",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"ConferenceParticipantDetailRecord": {
"properties": {
"billed_sec": {
"description": "Duration of the conference call for billing purposes",
"type": "integer"
},
"call_leg_id": {
"description": "Telnyx UUID that identifies the conference call leg",
"type": "string"
},
"call_sec": {
"description": "Duration of the conference call in seconds",
"type": "integer"
},
"call_session_id": {
"description": "Telnyx UUID that identifies with conference call session",
"type": "string"
},
"conference_id": {
"description": "Conference id",
"type": "string"
},
"cost": {
"description": "Currency amount for Telnyx billing cost",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing cost",
"type": "string"
},
"destination_number": {
"description": "Number called by the participant to join the conference",
"type": "string"
},
"id": {
"description": "Participant id",
"type": "string"
},
"is_telnyx_billable": {
"description": "Indicates whether Telnyx billing charges might be applicable",
"type": "boolean"
},
"joined_at": {
"description": "Participant join time",
"format": "date-time",
"type": "string"
},
"left_at": {
"description": "Participant leave time",
"format": "date-time",
"type": "string"
},
"originating_number": {
"description": "Participant origin number used in the conference call",
"type": "string"
},
"rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"rate_measured_in": {
"description": "Billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"record_type": {
"default": "conference_participant_detail_record",
"type": "string"
},
"user_id": {
"description": "User id",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"DetailRecord": {
"description": "An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records",
"oneOf": [
{
"$ref": "#/$defs/MessageDetailRecord",
"title": "Message"
},
{
"$ref": "#/$defs/ConferenceDetailRecord",
"title": "Conference"
},
{
"$ref": "#/$defs/ConferenceParticipantDetailRecord",
"title": "Conference Participant"
},
{
"$ref": "#/$defs/AmdDetailRecord",
"title": "AMD"
},
{
"$ref": "#/$defs/VerifyDetailRecord",
"title": "Verify 2FA"
},
{
"$ref": "#/$defs/SimCardUsageDetailRecord",
"title": "Sim Card Usage"
},
{
"$ref": "#/$defs/MediaStorageDetailRecord",
"title": "Media Storage"
}
],
"required": [
"record_type"
],
"type": "object"
},
"MediaStorageDetailRecord": {
"properties": {
"action_type": {
"description": "Type of action performed against the Media Storage API",
"type": "string"
},
"asset_id": {
"description": "Asset id",
"type": "string"
},
"cost": {
"description": "Currency amount for Telnyx billing cost",
"type": "string"
},
"created_at": {
"description": "Event creation time",
"format": "date-time",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing cost",
"type": "string"
},
"id": {
"description": "Unique identifier for the Media Storage Event",
"type": "string"
},
"link_channel_id": {
"description": "Link channel id",
"type": "string"
},
"link_channel_type": {
"description": "Link channel type",
"type": "string"
},
"org_id": {
"description": "Organization owner id",
"type": "string"
},
"rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"rate_measured_in": {
"description": "Billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"record_type": {
"default": "media_storage",
"type": "string"
},
"status": {
"description": "Request status",
"type": "string"
},
"user_id": {
"description": "User id",
"type": "string"
},
"webhook_id": {
"description": "Webhook id",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"MessageDetailRecord": {
"properties": {
"carrier": {
"description": "Country-specific carrier used to send or receive the message",
"type": "string"
},
"carrier_fee": {
"description": "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",
"type": "string"
},
"cld": {
"description": "The recipient of the message (to parameter in the Messaging API)",
"type": "string"
},
"cli": {
"description": "The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value",
"type": "string"
},
"completed_at": {
"description": "Message completion time",
"format": "date-time",
"type": "string"
},
"cost": {
"description": "Amount, in the user currency, for the Telnyx billing cost",
"type": "string"
},
"country_code": {
"description": "Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format",
"type": "string"
},
"created_at": {
"description": "Message creation time",
"format": "date-time",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing cost",
"type": "string"
},
"delivery_status": {
"description": "Final webhook delivery status",
"type": "string"
},
"delivery_status_failover_url": {
"description": "Failover customer-provided URL which Telnyx posts delivery status webhooks to",
"type": "string"
},
"delivery_status_webhook_url": {
"description": "Primary customer-provided URL which Telnyx posts delivery status webhooks to",
"type": "string"
},
"direction": {
"description": "Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise",
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"errors": {
"description": "Telnyx API error codes returned by the Telnyx gateway",
"items": {
"type": "string"
},
"type": "array"
},
"fteu": {
"description": "Indicates whether this is a Free-To-End-User (FTEU) short code message",
"type": "boolean"
},
"mcc": {
"description": "Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID",
"type": "string"
},
"message_type": {
"description": "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)",
"enum": [
"SMS",
"MMS",
"RCS"
],
"type": "string"
},
"mnc": {
"description": "Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID",
"type": "string"
},
"on_net": {
"description": "Indicates whether both sender and recipient numbers are Telnyx-managed",
"type": "boolean"
},
"parts": {
"description": "Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters",
"type": "integer"
},
"profile_id": {
"description": "Unique identifier of the Messaging Profile used to send or receive the message",
"type": "string"
},
"profile_name": {
"description": "Name of the Messaging Profile used to send or receive the message",
"type": "string"
},
"rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"record_type": {
"default": "message_detail_record",
"description": "Identifies the record schema",
"type": "string"
},
"sent_at": {
"description": "Time when the message was sent",
"format": "date-time",
"type": "string"
},
"source_country_code": {
"description": "Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format",
"type": "string"
},
"status": {
"description": "Final status of the message after the delivery attempt",
"enum": [
"gw_timeout",
"delivered",
"dlr_unconfirmed",
"dlr_timeout",
"received",
"gw_reject",
"failed"
],
"type": "string"
},
"tags": {
"description": "Comma-separated tags assigned to the Telnyx number associated with the message",
"type": "string"
},
"updated_at": {
"description": "Message updated time",
"format": "date-time",
"type": "string"
},
"user_id": {
"description": "Identifier of the Telnyx account who owns the message",
"type": "string"
},
"uuid": {
"description": "Unique identifier of the message",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"SimCardUsageDetailRecord": {
"properties": {
"closed_at": {
"description": "Event close time",
"format": "date-time",
"type": "string"
},
"created_at": {
"description": "Event creation time",
"format": "date-time",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing cost",
"type": "string"
},
"data_cost": {
"description": "Data cost",
"type": "number"
},
"data_rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing cost",
"type": "string"
},
"data_unit": {
"description": "Unit of wireless link consumption",
"type": "string"
},
"downlink_data": {
"description": "Number of megabytes downloaded",
"type": "number"
},
"id": {
"description": "Unique identifier for this SIM Card Usage",
"format": "uuid",
"type": "string"
},
"imsi": {
"description": "International Mobile Subscriber Identity",
"type": "string"
},
"ip_address": {
"description": "Ip address that generated the event",
"type": "string"
},
"mcc": {
"description": "Mobile country code",
"type": "string"
},
"mnc": {
"description": "Mobile network code",
"type": "string"
},
"phone_number": {
"description": "Telephone number associated to SIM card",
"type": "string"
},
"record_type": {
"default": "sim_card_usage",
"type": "string"
},
"sim_card_id": {
"description": "Unique identifier for SIM card",
"type": "string"
},
"sim_card_tags": {
"description": "User-provided tags",
"type": "string"
},
"sim_group_id": {
"description": "Unique identifier for SIM group",
"type": "string"
},
"sim_group_name": {
"description": "Sim group name for sim card",
"type": "string"
},
"uplink_data": {
"description": "Number of megabytes uploaded",
"type": "number"
}
},
"required": [
"record_type"
],
"type": "object"
},
"VerifyDetailRecord": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"currency": {
"description": "Telnyx account currency used to describe monetary values, including billing costs",
"type": "string"
},
"delivery_status": {
"type": "string"
},
"destination_phone_number": {
"description": "E.164 formatted phone number",
"type": "string"
},
"id": {
"description": "Unique ID of the verification",
"format": "uuid",
"type": "string"
},
"rate": {
"description": "Currency amount per billing unit used to calculate the Telnyx billing costs",
"type": "string"
},
"rate_measured_in": {
"description": "Billing unit used to calculate the Telnyx billing costs",
"type": "string"
},
"record_type": {
"default": "verification_detail_record",
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"verification_status": {
"type": "string"
},
"verify_channel_id": {
"format": "uuid",
"type": "string"
},
"verify_channel_type": {
"description": "Depending on the type of verification, the `verify_channel_id`\npoints to one of the following channel ids;\n---\nverify_channel_type | verify_channel_id\n------------------- | -----------------\nsms, psd2 | messaging_id\ncall, flashcall | call_control_id\n---\n",
"enum": [
"sms",
"psd2",
"call",
"flashcall"
],
"type": "string"
},
"verify_profile_id": {
"format": "uuid",
"type": "string"
},
"verify_usage_fee": {
"description": "Currency amount for Verify Usage Fee",
"type": "string"
}
},
"required": [
"record_type"
],
"type": "object"
},
"detail-records_PaginationMeta": {
"properties": {
"page_number": {
"format": "int32",
"type": "integer"
},
"page_size": {
"format": "int32",
"type": "integer"
},
"total_pages": {
"format": "int32",
"type": "integer"
},
"total_results": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/telnyx-detail-records-search-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.