Skip to main content
POST
/
legacy
/
reporting
/
usage_reports
/
voice
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const voice = await client.legacy.reporting.usageReports.voice.create({
  end_time: '2024-02-01T00:00:00Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(voice.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_time": "2018-02-02T22:25:27.521Z",
    "end_time": "2018-02-02T22:25:27.521Z",
    "connections": [
      "1234567890",
      "9876543210"
    ],
    "aggregation_type": 123,
    "status": 123,
    "report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
    "result": {},
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "record_type": "cdr_usage_report",
    "product_breakdown": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

*/*

Cdr detail request data

Request object for CDR usage report

​
start_time
string<date-time>
required

Start time in ISO format

Example:

"2024-02-01T00:00:00Z"

​
end_time
string<date-time>
required

End time in ISO format

Example:

"2024-02-01T00:00:00Z"

​
aggregation_type
integer

Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3

Example:

0

​
connections
integer[]

List of connections to filter by

List of connections to filter by

Example:
[123, 456]
​
product_breakdown
integer

Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID vs Toll-free per Country = 3

Example:

0

​
managed_accounts
string<uuid>[]

List of managed accounts to include

Example:
[
  "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
​
select_all_managed_accounts
boolean

Whether to select all managed accounts

Example:

false

Response

V2 legacy CDR usage report request created successfully

​
data
object

Legacy V2 CDR usage report response