Sign in

v53

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB
MDR Detailed Reports

Create a new MDR detailed report request

Creates a new MDR detailed report request with the specified filters

post/legacy/reporting/batch_detail_records/messaging

Request body

connectionsinteger[]

List of connections to filter by

directionsinteger[]

List of directions to filter by (Inbound = 1, Outbound = 2)

end_timestring date-time required

End time in ISO format. Note: If end time includes the last 4 hours, some MDRs might not appear in this report, due to wait time for downstream message delivery confirmation

include_message_bodyboolean

Whether to include message body in the report

managed_accountsstring[]

List of managed accounts to include

profilesstring[]

List of messaging profile IDs to filter by

record_typesinteger[]

List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)

report_namestring

Name of the report

select_all_managed_accountsboolean

Whether to select all managed accounts

start_timestring date-time required

Start time in ISO format

timezonestring

Timezone for the report

Example request

{
  "connections": [
    123,
    456
  ],
  "directions": [
    1,
    2
  ],
  "end_time": "2024-02-12T23:59:59Z",
  "filters": [
    {
      "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
      "cld": "+13129457420",
      "cli": "+13129457420",
      "tags_list": "tag1"
    }
  ],
  "include_message_body": true,
  "managed_accounts": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "profiles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7d4e3f8a-9b2c-4e1d-8f5a-1a2b3c4d5e6f"
  ],
  "record_types": [
    1,
    2
  ],
  "report_name": "My MDR Report",
  "start_time": "2024-02-01T00:00:00Z",
  "timezone": "UTC"
}

Response

MDR detailed report request created successfully

Example response

{
  "data": {
    "created_at": "2020-07-01T00:00:00-06:00",
    "end_date": "2020-07-01T00:00:00-06:00",
    "filters": [
      {
        "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
        "cld": "+13129457420",
        "cli": "+13129457420",
        "tags_list": "tag1"
      }
    ],
    "profiles": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "7d4e3f8a-9b2c-4e1d-8f5a-1a2b3c4d5e6f"
    ],
    "record_type": "mdr_report",
    "report_name": "report_name_8hvb45Gu",
    "report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
    "start_date": "2020-07-01T00:00:00-06:00",
    "updated_at": "2020-07-01T00:00:00-06:00"
  }
}