MDR Detail Reports

MDR Detail Reports API

MDR Get

Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records.

SecuritybearerAuth
Request
query Parameters
page[number]
integer <int32>
Default: 1

Page number

page[size]
integer <int32>
Default: 20

Size of the page

Responses
200

Successful

Response Schema: application/json
Array of objects (MdrDetailReportResponse)
object (PaginationMeta)
get/reports/batch_mdr_reports
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "connections": [
        • 0
        ],
      • "created_at": "2020-07-01T00:00:00-06:00",
      • "directions": [
        • "INBOUND"
        ],
      • "end_date": "2020-07-01T00:00:00-06:00",
      • "filters": [
        • {
          • "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
          • "cld": "+13129457420",
          • "cld_filter": "contains",
          • "cli": "+13129457420",
          • "cli_filter": "contains",
          • "filter_type": "and",
          • "tags_list": "tag1"
          }
        ],
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "profiles": "My profile",
      • "record_type": "mdr_report",
      • "record_types": [
        • "INCOMPLETE"
        ],
      • "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",
      • "status": "PENDING",
      • "updated_at": "2020-07-01T00:00:00-06:00"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
MDR Post
Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Mdr detail request data


connections
Array of integers <int64> 
 
directions
Array of strings
Items Enum: "INBOUND" "OUTBOUND"  
end_date
required
string <date-time> 
 
Array of objects (Filter) 
 
include_message_body
boolean
 
profiles
string
 
record_types
Array of strings
Items Enum: "INCOMPLETE" "COMPLETED" "ERRORS"  
report_name
string
 
start_date
required
string <date-time> 
 
Responses 
200
Successful


Response Schema: application/json
object (MdrDetailReportResponse) 
 
connections
Array of integers <int64> 
 
created_at
string <date-time> 
 
directions
Array of strings
Items Enum: "INBOUND" "OUTBOUND"  
end_date
string <date-time> 
 
Array of objects (Filter) 
 
id
string <uuid> 
Identifies the resource


 
profiles
string
 
record_type
string
 
record_types
Array of strings
Items Enum: "INCOMPLETE" "COMPLETED" "ERRORS"  
report_name
string
 
report_url
string
 
start_date
string <date-time> 
 
status
string
 Enum: "PENDING" "COMPLETE" "FAILED" "EXPIRED"  
updated_at
string <date-time> 
 
post/reports/batch_mdr_reports
Request samples 
application/json
{
  • "connections": [
    • 0
    ],
  • "directions": [
    • "INBOUND"
    ],
  • "end_date": "2020-07-01T00:00:00-06:00",
  • "filters": [
    • {
      • "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
      • "cld": "+13129457420",
      • "cld_filter": "contains",
      • "cli": "+13129457420",
      • "cli_filter": "contains",
      • "filter_type": "and",
      • "tags_list": "tag1"
      }
    ],
  • "include_message_body": true,
  • "profiles": "My profile",
  • "record_types": [
    • "INCOMPLETE"
    ],
  • "report_name": "string",
  • "start_date": "2020-07-01T00:00:00-06:00"
}
Response samples 
application/json
{
  • "data": {
    • "connections": [
      • 0
      ],
    • "created_at": "2020-07-01T00:00:00-06:00",
    • "directions": [
      • "INBOUND"
      ],
    • "end_date": "2020-07-01T00:00:00-06:00",
    • "filters": [
      • {
        • "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
        • "cld": "+13129457420",
        • "cld_filter": "contains",
        • "cli": "+13129457420",
        • "cli_filter": "contains",
        • "filter_type": "and",
        • "tags_list": "tag1"
        }
      ],
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "profiles": "My profile",
    • "record_type": "mdr_report",
    • "record_types": [
      • "INCOMPLETE"
      ],
    • "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",
    • "status": "PENDING",
    • "updated_at": "2020-07-01T00:00:00-06:00"
    }
}
MDR Delete
Delete generated messaging detail report by id


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
 
Responses 
200
Successful


Response Schema: application/json
object (MdrDetailReportResponse) 
 
connections
Array of integers <int64> 
 
created_at
string <date-time> 
 
directions
Array of strings
Items Enum: "INBOUND" "OUTBOUND"  
end_date
string <date-time> 
 
Array of objects (Filter) 
 
id
string <uuid> 
Identifies the resource


 
profiles
string
 
record_type
string
 
record_types
Array of strings
Items Enum: "INCOMPLETE" "COMPLETED" "ERRORS"  
report_name
string
 
report_url
string
 
start_date
string <date-time> 
 
status
string
 Enum: "PENDING" "COMPLETE" "FAILED" "EXPIRED"  
updated_at
string <date-time> 
 
delete/reports/batch_mdr_reports/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "connections": [
      • 0
      ],
    • "created_at": "2020-07-01T00:00:00-06:00",
    • "directions": [
      • "INBOUND"
      ],
    • "end_date": "2020-07-01T00:00:00-06:00",
    • "filters": [
      • {
        • "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
        • "cld": "+13129457420",
        • "cld_filter": "contains",
        • "cli": "+13129457420",
        • "cli_filter": "contains",
        • "filter_type": "and",
        • "tags_list": "tag1"
        }
      ],
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "profiles": "My profile",
    • "record_type": "mdr_report",
    • "record_types": [
      • "INCOMPLETE"
      ],
    • "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",
    • "status": "PENDING",
    • "updated_at": "2020-07-01T00:00:00-06:00"
    }
}
MDR Fetch
Fetch single messaging detail report by id.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
 
Responses 
200
Successful


Response Schema: application/json
object (MdrDetailReportResponse) 
 
connections
Array of integers <int64> 
 
created_at
string <date-time> 
 
directions
Array of strings
Items Enum: "INBOUND" "OUTBOUND"  
end_date
string <date-time> 
 
Array of objects (Filter) 
 
id
string <uuid> 
Identifies the resource


 
profiles
string
 
record_type
string
 
record_types
Array of strings
Items Enum: "INCOMPLETE" "COMPLETED" "ERRORS"  
report_name
string
 
report_url
string
 
start_date
string <date-time> 
 
status
string
 Enum: "PENDING" "COMPLETE" "FAILED" "EXPIRED"  
updated_at
string <date-time> 
 
get/reports/batch_mdr_reports/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "connections": [
      • 0
      ],
    • "created_at": "2020-07-01T00:00:00-06:00",
    • "directions": [
      • "INBOUND"
      ],
    • "end_date": "2020-07-01T00:00:00-06:00",
    • "filters": [
      • {
        • "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
        • "cld": "+13129457420",
        • "cld_filter": "contains",
        • "cli": "+13129457420",
        • "cli_filter": "contains",
        • "filter_type": "and",
        • "tags_list": "tag1"
        }
      ],
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "profiles": "My profile",
    • "record_type": "mdr_report",
    • "record_types": [
      • "INCOMPLETE"
      ],
    • "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",
    • "status": "PENDING",
    • "updated_at": "2020-07-01T00:00:00-06:00"
    }
}
MDR Get
Fetch all Mdr records 


SecuritybearerAuth 
Request 
query Parameters
start_date
string
Pagination start date


 
end_date
string
Pagination end date


 
id
string
Message uuid


 
 Example:  id=e093fbe0-5bde-11eb-ae93-0242ac130002
direction
string
Direction (inbound or outbound)


 Enum: "INBOUND" "OUTBOUND"  
 Example:  direction=INBOUND
profile
string
Name of the profile


 
 Example:  profile=My profile
cld
string
Destination number


 
 Example:  cld=+15551237654
cli
string
Origination number


 
 Example:  cli=+15551237654
status
string
Message status


 Enum: "GW_TIMEOUT" "DELIVERED" "DLR_UNCONFIRMED" "DLR_TIMEOUT" "RECEIVED" "GW_REJECT" "FAILED"  
 Example:  status=DELIVERED
message_type
string
Type of message


 Enum: "SMS" "MMS"  
 Example:  message_type=SMS
Responses 
200
Successful


Response Schema: application/json
Array of objects (MdrDetailResponse) 
 
object (PaginationMeta) 
 
get/reports/mdrs
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "cld": "+1555123456",
      • "cli": "+1555123456",
      • "cost": "0.1",
      • "created_at": "2020-07-01T00:00:00-06:00",
      • "currency": "USD",
      • "direction": "outbound",
      • "id": "99b637f3-07fd-45ac-b9ca-b87208c24650",
      • "message_type": "SMS",
      • "parts": 2,
      • "profile_name": "configured-profile-name",
      • "rate": "0.05",
      • "record_type": "mdr_report",
      • "status": "DELIVERED"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}