Skip to main content

Search detail records

GET 
/detail_records

Search for any detail record across the Telnyx Platform

Request​

Query Parameters

    filter[record_type] stringrequired

    Possible values: [amd, conference, conference-participant, media_storage, messaging, verify, whatsapp, whatsapp-conversation, wireless]

    Filter by the given record type.

    Examples:

    Searches for messaging detail records

    Example: messaging

    filter[date_range] string

    Possible values: [yesterday, today, tomorrow, last_week, this_week, next_week, last_month, this_month, next_month]

    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.

    Examples:

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

    Example: today

    filter object

    Filter records on a given record attribute and value.
    Example: filter[status]=delivered

    Examples:

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

    Example: 2021-06-22

    page[number] int32

    Possible values: >= 1

    Default value: 1

    Page number

    page[size] int32

    Possible values: >= 1 and <= 50

    Default value: 20

    Page size

    sort string[]

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

    Examples:

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

    Example: created_at

Responses​

200: Successful

Schema

    data

    object[]

  • Array [

    • oneOf

    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

  • ]

    • meta

    object

    total_pages int32
    total_results int32
    page_number int32
    page_size int32
Loading...