CDR Usage Reports API

CDR Usage Reports API

CDR Sync Get

Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

SecuritybearerAuth
Request
query Parameters
start_date
string <date-time>
Example: start_date=2020-07-01T00:00:00-06:00
end_date
string <date-time>
Example: end_date=2020-07-01T00:00:00-06:00
aggregation_type
required
string
Enum: "NO_AGGREGATION" "CONNECTION" "TAG" "BILLING_GROUP"
Example: aggregation_type=no_aggregation
product_breakdown
required
string
Enum: "NO_BREAKDOWN" "DID_VS_TOLL_FREE" "COUNTRY" "DID_VS_TOLL_FREE_PER_COUNTRY"
Example: product_breakdown=no_breakdown
connections
Array of numbers
Example: connections=1234567890123
Responses
200

Successful

Response Schema: application/json
object (CdrUsageReportResponse)
aggregation_type
string
Enum: "NO_AGGREGATION" "CONNECTION" "TAG" "BILLING_GROUP"
connections
Array of integers <int64>
created_at
string <date-time>
end_time
string <date-time>
id
string <uuid>

Identifies the resource

product_breakdown
string
Enum: "NO_BREAKDOWN" "DID_VS_TOLL_FREE" "COUNTRY" "DID_VS_TOLL_FREE_PER_COUNTRY"
record_type
string
report_url
string
result
object
start_time
string <date-time>
status
string
Enum: "PENDING" "COMPLETE" "FAILED" "EXPIRED"
updated_at
string <date-time>
get/reports/cdr_usage_reports/sync
Request samples 
Response samples 
application/json
{
  • "data": {
    • "aggregation_type": "NO_AGGREGATION",
    • "connections": "[1234567890L, 9876543210L]",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "end_time": "2018-02-02T22:25:27.521Z",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "product_breakdown": "NO_BREAKDOWN",
    • "record_type": "cdr_usage_report",
    • "report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
    • "result": { },
    • "start_time": "2018-02-02T22:25:27.521Z",
    • "status": "PENDING",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}