<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Account Reports - Java

Installation

<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.89.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.89.0")

Setup

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import com.telnyx.sdk.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return a page. Use .autoPager() for automatic iteration: for (var item : page.autoPager()) { ... }. For manual control, use .hasNextPage() and .nextPage().

List call events

Filters call events by given filter parameters. Events are ordered by occurredat. If filter for legid or applicationsessionid is not present, it only filters events from the last 24 hours.

GET /call_events

import com.telnyx.sdk.models.callevents.CallEventListPage;
import com.telnyx.sdk.models.callevents.CallEventListParams;

CallEventListPage page = client.callEvents().list();

Returns: calllegid (string), callsessionid (string), eventtimestamp (string), metadata (object), name (string), recordtype (enum: call_event), type (enum: command, webhook)

Create a ledger billing group report

POST /ledgerbillinggroup_reports

Optional: month (integer), year (integer)

import com.telnyx.sdk.models.ledgerbillinggroupreports.LedgerBillingGroupReportCreateParams;
import com.telnyx.sdk.models.ledgerbillinggroupreports.LedgerBillingGroupReportCreateResponse;

LedgerBillingGroupReportCreateResponse ledgerBillingGroupReport = client.ledgerBillingGroupReports().create();

Returns: createdat (date-time), id (uuid), organizationid (uuid), recordtype (enum: ledgerbillinggroupreport), reporturl (uri), status (enum: pending, complete, failed, deleted), updatedat (date-time)

Get a ledger billing group report

GET /ledgerbillinggroup_reports/{id}

import com.telnyx.sdk.models.ledgerbillinggroupreports.LedgerBillingGroupReportRetrieveParams;
import com.telnyx.sdk.models.ledgerbillinggroupreports.LedgerBillingGroupReportRetrieveResponse;

LedgerBillingGroupReportRetrieveResponse ledgerBillingGroupReport = client.ledgerBillingGroupReports().retrieve("f5586561-8ff0-4291-a0ac-84fe544797bd");

Returns: createdat (date-time), id (uuid), organizationid (uuid), recordtype (enum: ledgerbillinggroupreport), reporturl (uri), status (enum: pending, complete, failed, deleted), updatedat (date-time)

Get all MDR detailed report requests

Retrieves all MDR detailed report requests for the authenticated user

GET /legacy/reporting/batchdetailrecords/messaging

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingListParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingListResponse;

MessagingListResponse messagings = client.legacy().reporting().batchDetailRecords().messaging().list();

Returns: connections (array[integer]), createdat (date-time), directions (array[string]), enddate (date-time), filters (array[object]), id (uuid), profiles (array[string]), recordtype (string), recordtypes (array[string]), reportname (string), reporturl (string), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Create a new MDR detailed report request

Creates a new MDR detailed report request with the specified filters

POST /legacy/reporting/batchdetailrecords/messaging — Required: starttime, endtime

Optional: connections (array[integer]), directions (array[integer]), filters (array[object]), includemessagebody (boolean), managedaccounts (array[string]), profiles (array[string]), recordtypes (array[integer]), reportname (string), selectallmanagedaccounts (boolean), timezone (string)

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingCreateParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingCreateResponse;
import java.time.OffsetDateTime;

MessagingCreateParams params = MessagingCreateParams.builder()
    .endTime(OffsetDateTime.parse("2024-02-12T23:59:59Z"))
    .startTime(OffsetDateTime.parse("2024-02-01T00:00:00Z"))
    .build();
MessagingCreateResponse messaging = client.legacy().reporting().batchDetailRecords().messaging().create(params);

Returns: connections (array[integer]), createdat (date-time), directions (array[string]), enddate (date-time), filters (array[object]), id (uuid), profiles (array[string]), recordtype (string), recordtypes (array[string]), reportname (string), reporturl (string), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Get a specific MDR detailed report request

Retrieves a specific MDR detailed report request by ID

GET /legacy/reporting/batchdetailrecords/messaging/{id}

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.legacy().reporting().batchDetailRecords().messaging().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: connections (array[integer]), createdat (date-time), directions (array[string]), enddate (date-time), filters (array[object]), id (uuid), profiles (array[string]), recordtype (string), recordtypes (array[string]), reportname (string), reporturl (string), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Delete a MDR detailed report request

Deletes a specific MDR detailed report request by ID

DELETE /legacy/reporting/batchdetailrecords/messaging/{id}

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingDeleteParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.messaging.MessagingDeleteResponse;

MessagingDeleteResponse messaging = client.legacy().reporting().batchDetailRecords().messaging().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: connections (array[integer]), createdat (date-time), directions (array[string]), enddate (date-time), filters (array[object]), id (uuid), profiles (array[string]), recordtype (string), recordtypes (array[string]), reportname (string), reporturl (string), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Get all CDR report requests

Retrieves all CDR report requests for the authenticated user

GET /legacy/reporting/batchdetailrecords/voice

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceListParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceListResponse;

VoiceListResponse voices = client.legacy().reporting().batchDetailRecords().voice().list();

Returns: calltypes (array[integer]), connections (array[integer]), createdat (string), endtime (string), filters (array[object]), id (string), managedaccounts (array[string]), recordtype (string), recordtypes (array[integer]), reportname (string), reporturl (string), retry (int32), source (string), starttime (string), status (int32), timezone (string), updatedat (string)

Create a new CDR report request

Creates a new CDR report request with the specified filters

POST /legacy/reporting/batchdetailrecords/voice — Required: starttime, endtime

Optional: calltypes (array[integer]), connections (array[integer]), fields (array[string]), filters (array[object]), includeallmetadata (boolean), managedaccounts (array[string]), recordtypes (array[integer]), reportname (string), selectallmanaged_accounts (boolean), source (string), timezone (string)

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceCreateParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceCreateResponse;
import java.time.OffsetDateTime;

VoiceCreateParams params = VoiceCreateParams.builder()
    .endTime(OffsetDateTime.parse("2024-02-12T23:59:59Z"))
    .startTime(OffsetDateTime.parse("2024-02-01T00:00:00Z"))
    .build();
VoiceCreateResponse voice = client.legacy().reporting().batchDetailRecords().voice().create(params);

Returns: calltypes (array[integer]), connections (array[integer]), createdat (string), endtime (string), filters (array[object]), id (string), managedaccounts (array[string]), recordtype (string), recordtypes (array[integer]), reportname (string), reporturl (string), retry (int32), source (string), starttime (string), status (int32), timezone (string), updatedat (string)

Get available CDR report fields

Retrieves all available fields that can be used in CDR reports

GET /legacy/reporting/batchdetailrecords/voice/fields

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceRetrieveFieldsParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceRetrieveFieldsResponse;

VoiceRetrieveFieldsResponse response = client.legacy().reporting().batchDetailRecords().voice().retrieveFields();

Returns: Billing (array[string]), Interaction Data (array[string]), Number Information (array[string]), Telephony Data (array[string])

Get a specific CDR report request

Retrieves a specific CDR report request by ID

GET /legacy/reporting/batchdetailrecords/voice/{id}

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceRetrieveResponse;

VoiceRetrieveResponse voice = client.legacy().reporting().batchDetailRecords().voice().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: calltypes (array[integer]), connections (array[integer]), createdat (string), endtime (string), filters (array[object]), id (string), managedaccounts (array[string]), recordtype (string), recordtypes (array[integer]), reportname (string), reporturl (string), retry (int32), source (string), starttime (string), status (int32), timezone (string), updatedat (string)

Delete a CDR report request

Deletes a specific CDR report request by ID

DELETE /legacy/reporting/batchdetailrecords/voice/{id}

import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceDeleteParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.voice.VoiceDeleteResponse;

VoiceDeleteResponse voice = client.legacy().reporting().batchDetailRecords().voice().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: calltypes (array[integer]), connections (array[integer]), createdat (string), endtime (string), filters (array[object]), id (string), managedaccounts (array[string]), recordtype (string), recordtypes (array[integer]), reportname (string), reporturl (string), retry (int32), source (string), starttime (string), status (int32), timezone (string), updatedat (string)

List MDR usage reports

Fetch all previous requests for MDR usage reports.

GET /legacy/reporting/usage_reports/messaging

import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingListPage;
import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingListParams;

MessagingListPage page = client.legacy().reporting().usageReports().messaging().list();

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), profiles (array[string]), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updated_at (date-time)

Create a new legacy usage V2 MDR report request

Creates a new legacy usage V2 MDR report request with the specified filters

POST /legacy/reporting/usage_reports/messaging

import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingCreateParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingCreateResponse;

MessagingCreateParams params = MessagingCreateParams.builder()
    .aggregationType(0)
    .build();
MessagingCreateResponse messaging = client.legacy().reporting().usageReports().messaging().create(params);

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), profiles (array[string]), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updated_at (date-time)

Get an MDR usage report

Fetch single MDR usage report by id.

GET /legacy/reporting/usage_reports/messaging/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.legacy().reporting().usageReports().messaging().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), profiles (array[string]), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updated_at (date-time)

Delete a V2 legacy usage MDR report request

Deletes a specific V2 legacy usage MDR report request by ID

DELETE /legacy/reporting/usage_reports/messaging/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingDeleteParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.messaging.MessagingDeleteResponse;

MessagingDeleteResponse messaging = client.legacy().reporting().usageReports().messaging().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), profiles (array[string]), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updated_at (date-time)

List telco data usage reports

Retrieve a paginated list of telco data usage reports

GET /legacy/reporting/usagereports/numberlookup

import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupListParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupListResponse;

NumberLookupListResponse numberLookups = client.legacy().reporting().usageReports().numberLookup().list();

Returns: aggregationtype (string), createdat (date-time), enddate (date), id (uuid), managedaccounts (array[string]), recordtype (string), reporturl (string), result (array[object]), startdate (date), status (string), updatedat (date-time)

Submit telco data usage report

Submit a new telco data usage report

POST /legacy/reporting/usagereports/numberlookup

import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupCreateParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupCreateResponse;

NumberLookupCreateResponse numberLookup = client.legacy().reporting().usageReports().numberLookup().create();

Returns: aggregationtype (string), createdat (date-time), enddate (date), id (uuid), managedaccounts (array[string]), recordtype (string), reporturl (string), result (array[object]), startdate (date), status (string), updatedat (date-time)

Get telco data usage report by ID

Retrieve a specific telco data usage report by its ID

GET /legacy/reporting/usagereports/numberlookup/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupRetrieveResponse;

NumberLookupRetrieveResponse numberLookup = client.legacy().reporting().usageReports().numberLookup().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns: aggregationtype (string), createdat (date-time), enddate (date), id (uuid), managedaccounts (array[string]), recordtype (string), reporturl (string), result (array[object]), startdate (date), status (string), updatedat (date-time)

Delete telco data usage report

Delete a specific telco data usage report by its ID

DELETE /legacy/reporting/usagereports/numberlookup/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupDeleteParams;

client.legacy().reporting().usageReports().numberLookup().delete("550e8400-e29b-41d4-a716-446655440000");

List CDR usage reports

Fetch all previous requests for cdr usage reports.

GET /legacy/reporting/usage_reports/voice

import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceListPage;
import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceListParams;

VoiceListPage page = client.legacy().reporting().usageReports().voice().list();

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), productbreakdown (int32), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updatedat (date-time)

Create a new legacy usage V2 CDR report request

Creates a new legacy usage V2 CDR report request with the specified filters

POST /legacy/reporting/usage_reports/voice

import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceCreateParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceCreateResponse;
import java.time.OffsetDateTime;

VoiceCreateParams params = VoiceCreateParams.builder()
    .endTime(OffsetDateTime.parse("2024-02-01T00:00:00Z"))
    .startTime(OffsetDateTime.parse("2024-02-01T00:00:00Z"))
    .build();
VoiceCreateResponse voice = client.legacy().reporting().usageReports().voice().create(params);

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), productbreakdown (int32), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updatedat (date-time)

Get a CDR usage report

Fetch single cdr usage report by id.

GET /legacy/reporting/usage_reports/voice/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceRetrieveResponse;

VoiceRetrieveResponse voice = client.legacy().reporting().usageReports().voice().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), productbreakdown (int32), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updatedat (date-time)

Delete a V2 legacy usage CDR report request

Deletes a specific V2 legacy usage CDR report request by ID

DELETE /legacy/reporting/usage_reports/voice/{id}

import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceDeleteParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.voice.VoiceDeleteResponse;

VoiceDeleteResponse voice = client.legacy().reporting().usageReports().voice().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (int32), connections (array[string]), createdat (date-time), endtime (date-time), id (uuid), productbreakdown (int32), recordtype (string), reporturl (string), result (object), starttime (date-time), status (int32), updatedat (date-time)

List CSV downloads

GET /phonenumbers/csvdownloads

import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadListPage;
import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadListParams;

CsvDownloadListPage page = client.phoneNumbers().csvDownloads().list();

Returns: id (string), record_type (string), status (enum: pending, complete, failed, expired), url (string)

Create a CSV download

POST /phonenumbers/csvdownloads

import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadCreateParams;
import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadCreateResponse;

CsvDownloadCreateResponse csvDownload = client.phoneNumbers().csvDownloads().create();

Returns: id (string), record_type (string), status (enum: pending, complete, failed, expired), url (string)

Retrieve a CSV download

GET /phonenumbers/csvdownloads/{id}

import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.csvdownloads.CsvDownloadRetrieveResponse;

CsvDownloadRetrieveResponse csvDownload = client.phoneNumbers().csvDownloads().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns: id (string), record_type (string), status (enum: pending, complete, failed, expired), url (string)

Generates and fetches CDR Usage Reports

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.

GET /reports/cdrusagereports/sync

import com.telnyx.sdk.models.reports.cdrusagereports.CdrUsageReportFetchSyncParams;
import com.telnyx.sdk.models.reports.cdrusagereports.CdrUsageReportFetchSyncResponse;

CdrUsageReportFetchSyncParams params = CdrUsageReportFetchSyncParams.builder()
    .aggregationType(CdrUsageReportFetchSyncParams.AggregationType.NO_AGGREGATION)
    .productBreakdown(CdrUsageReportFetchSyncParams.ProductBreakdown.NO_BREAKDOWN)
    .build();
CdrUsageReportFetchSyncResponse response = client.reports().cdrUsageReports().fetchSync(params);

Returns: aggregationtype (enum: NOAGGREGATION, CONNECTION, TAG, BILLINGGROUP), connections (array[integer]), createdat (date-time), endtime (date-time), id (uuid), productbreakdown (enum: NOBREAKDOWN, DIDVSTOLLFREE, COUNTRY, DIDVSTOLLFREEPERCOUNTRY), recordtype (string), reporturl (string), result (object), starttime (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updated_at (date-time)

Fetch all Messaging usage reports

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

GET /reports/mdrusagereports

import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportListPage;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportListParams;

MdrUsageReportListPage page = client.reports().mdrUsageReports().list();

Returns: aggregationtype (enum: NOAGGREGATION, PROFILE, TAGS), connections (array[integer]), createdat (date-time), enddate (date-time), id (uuid), profiles (string), recordtype (string), reporturl (string), result (array[object]), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Create MDR Usage Report

Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.

POST /reports/mdrusagereports

import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportCreateParams;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportCreateResponse;
import java.time.OffsetDateTime;

MdrUsageReportCreateParams params = MdrUsageReportCreateParams.builder()
    .aggregationType(MdrUsageReportCreateParams.AggregationType.NO_AGGREGATION)
    .endDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
    .startDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
    .build();
MdrUsageReportCreateResponse mdrUsageReport = client.reports().mdrUsageReports().create(params);

Returns: aggregationtype (enum: NOAGGREGATION, PROFILE, TAGS), connections (array[integer]), createdat (date-time), enddate (date-time), id (uuid), profiles (string), recordtype (string), reporturl (string), result (array[object]), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Generate and fetch MDR Usage Report

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

GET /reports/mdrusagereports/sync

import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportFetchSyncParams;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportFetchSyncResponse;

MdrUsageReportFetchSyncParams params = MdrUsageReportFetchSyncParams.builder()
    .aggregationType(MdrUsageReportFetchSyncParams.AggregationType.PROFILE)
    .build();
MdrUsageReportFetchSyncResponse response = client.reports().mdrUsageReports().fetchSync(params);

Returns: aggregationtype (enum: NOAGGREGATION, PROFILE, TAGS), connections (array[integer]), createdat (date-time), enddate (date-time), id (uuid), profiles (string), recordtype (string), reporturl (string), result (array[object]), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Retrieve messaging report

Fetch a single messaging usage report by id

GET /reports/mdrusagereports/{id}

import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportRetrieveParams;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportRetrieveResponse;

MdrUsageReportRetrieveResponse mdrUsageReport = client.reports().mdrUsageReports().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (enum: NOAGGREGATION, PROFILE, TAGS), connections (array[integer]), createdat (date-time), enddate (date-time), id (uuid), profiles (string), recordtype (string), reporturl (string), result (array[object]), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Delete MDR Usage Report

Delete messaging usage report by id

DELETE /reports/mdrusagereports/{id}

import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportDeleteParams;
import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportDeleteResponse;

MdrUsageReportDeleteResponse mdrUsageReport = client.reports().mdrUsageReports().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Returns: aggregationtype (enum: NOAGGREGATION, PROFILE, TAGS), connections (array[integer]), createdat (date-time), enddate (date-time), id (uuid), profiles (string), recordtype (string), reporturl (string), result (array[object]), startdate (date-time), status (enum: PENDING, COMPLETE, FAILED, EXPIRED), updatedat (date-time)

Fetch all Mdr records

GET /reports/mdrs

import com.telnyx.sdk.models.reports.ReportListMdrsParams;
import com.telnyx.sdk.models.reports.ReportListMdrsResponse;

ReportListMdrsResponse response = client.reports().listMdrs();

Returns: cld (string), cli (string), cost (string), createdat (date-time), currency (enum: AUD, CAD, EUR, GBP, USD), direction (string), id (string), messagetype (enum: SMS, MMS), parts (number), profilename (string), rate (string), recordtype (string), status (enum: GWTIMEOUT, DELIVERED, DLRUNCONFIRMED, DLRTIMEOUT, RECEIVED, GWREJECT, FAILED)

Fetches all Wdr records

Fetch all Wdr records

GET /reports/wdrs

import com.telnyx.sdk.models.reports.ReportListWdrsPage;
import com.telnyx.sdk.models.reports.ReportListWdrsParams;

ReportListWdrsPage page = client.reports().listWdrs();

Returns: cost (object), createdat (date-time), downlinkdata (object), durationseconds (number), id (string), imsi (string), mcc (string), mnc (string), phonenumber (string), rate (object), recordtype (string), simcardid (string), simgroupid (string), simgroupname (string), uplinkdata (object)

Get metadata overview

Returns all available record types and supported query parameters for session analysis.

GET /session_analysis/metadata

import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveParams;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveResponse;

MetadataRetrieveResponse metadata = client.sessionAnalysis().metadata().retrieve();

Returns: meta (object), queryparameters (object), recordtypes (array[object])

Get record type metadata

Returns detailed metadata for a specific record type, including relationships and examples.

GET /sessionanalysis/metadata/{recordtype}

import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveRecordTypeParams;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveRecordTypeResponse;

MetadataRetrieveRecordTypeResponse response = client.sessionAnalysis().metadata().retrieveRecordType("record_type");

Returns: aliases (array[string]), childrelationships (array[object]), event (string), examples (object), meta (object), parentrelationships (array[object]), product (string), record_type (string)

Get session analysis

Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages.

GET /sessionanalysis/{recordtype}/{event_id}

import com.telnyx.sdk.models.sessionanalysis.SessionAnalysisRetrieveParams;
import com.telnyx.sdk.models.sessionanalysis.SessionAnalysisRetrieveResponse;

SessionAnalysisRetrieveParams params = SessionAnalysisRetrieveParams.builder()
    .recordType("record_type")
    .eventId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .build();
SessionAnalysisRetrieveResponse sessionAnalysis = client.sessionAnalysis().retrieve(params);

Returns: cost (object), meta (object), root (object), session_id (string)

Get Telnyx product usage data (BETA)

Get Telnyx usage data by product, broken out by the specified dimensions

GET /usage_reports

import com.telnyx.sdk.models.usagereports.UsageReportListPage;
import com.telnyx.sdk.models.usagereports.UsageReportListParams;

UsageReportListParams params = UsageReportListParams.builder()
    .addDimension("string")
    .addMetric("string")
    .product("wireless")
    .build();
UsageReportListPage page = client.usageReports().list(params);

Returns: data (array[object]), meta (object)

Get Usage Reports query options (BETA)

Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions

GET /usage_reports/options

import com.telnyx.sdk.models.usagereports.UsageReportGetOptionsParams;
import com.telnyx.sdk.models.usagereports.UsageReportGetOptionsResponse;

UsageReportGetOptionsResponse response = client.usageReports().getOptions();

Returns: product (string), productdimensions (array[string]), productmetrics (array[string]), record_types (array[object])

Get all Wireless Detail Records (WDRs) Reports

Returns the WDR Reports that match the given parameters.

GET /wireless/detailrecordsreports

import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportListParams;
import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportListResponse;

DetailRecordsReportListResponse detailRecordsReports = client.wireless().detailRecordsReports().list();

Returns: createdat (string), endtime (string), id (uuid), recordtype (string), reporturl (string), starttime (string), status (enum: pending, complete, failed, deleted), updatedat (string)

Create a Wireless Detail Records (WDRs) Report

Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.

POST /wireless/detailrecordsreports

Optional: endtime (string), starttime (string)

import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportCreateParams;
import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportCreateResponse;

DetailRecordsReportCreateResponse detailRecordsReport = client.wireless().detailRecordsReports().create();

Returns: createdat (string), endtime (string), id (uuid), recordtype (string), reporturl (string), starttime (string), status (enum: pending, complete, failed, deleted), updatedat (string)

Get a Wireless Detail Record (WDR) Report

Returns one specific WDR report

GET /wireless/detailrecordsreports/{id}

import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportRetrieveParams;
import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportRetrieveResponse;

DetailRecordsReportRetrieveResponse detailRecordsReport = client.wireless().detailRecordsReports().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), endtime (string), id (uuid), recordtype (string), reporturl (string), starttime (string), status (enum: pending, complete, failed, deleted), updatedat (string)

Delete a Wireless Detail Record (WDR) Report

Deletes one specific WDR report.

DELETE /wireless/detailrecordsreports/{id}

import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportDeleteParams;
import com.telnyx.sdk.models.wireless.detailrecordsreports.DetailRecordsReportDeleteResponse;

DetailRecordsReportDeleteResponse detailRecordsReport = client.wireless().detailRecordsReports().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns: createdat (string), endtime (string), id (uuid), recordtype (string), reporturl (string), starttime (string), status (enum: pending, complete, failed, deleted), updatedat (string)