telnyx-account-reports-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Account Reports - Java ## Installation ```text // See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup ``` ## Setup ```java 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. ## Get all MDR detailed report requests Retrieves all MDR detailed report requests for the authenticated user `GET /legacy_reporting/batch_detail_records/messaging` ```java 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(); ``` ## 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` — Required: `start_time`, `end_time` ```java 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); ``` ## Get a specific MDR detailed report request Retrieves a specific MDR detailed report request by ID `GET /legacy_reporting/batch_detail_records/messaging/{id}` ```java 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"); ``` ## Delete a MDR detailed report request Deletes a specific MDR detailed report request by ID `DELETE /legacy_reporting/batch_detail_records/messaging/{id}` ```java 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"); ``` ## Get all CDR report requests Retrieves all CDR report requests for the authenticated user `GET /legacy_reporting/batch_detail_records/voice` ```java 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(); ``` ## Create a new CDR report request Creates a new CDR report request with the specified filters `POST /legacy_reporting/batch_detail_records/voice` — Required: `start_time`, `end_time` ```java 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); ``` ## Get a specific CDR report request Retrieves a specific CDR report request by ID `GET /legacy_reporting/batch_detail_records/voice/{id}` ```java 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"); ``` ## Delete a CDR report request Deletes a specific CDR report request by ID `DELETE /legacy_reporting/batch_detail_records/voice/{id}` ```java 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"); ``` ## Get available CDR report fields Retrieves all available fields that can be used in CDR reports `GET /legacy_reporting/batch_detail_records/voice/fields` ```java 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(); ``` ## List MDR usage reports Fetch all previous requests for MDR usage reports. `GET /legacy_reporting/usage_reports/messaging` ```java 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(); ``` ## 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` ```java 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); ``` ## Get an MDR usage report Fetch single MDR usage report by id. `GET /legacy_reporting/usage_reports/messaging/{id}` ```java 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"); ``` ## 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}` ```java 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"); ``` ## List telco data usage reports Retrieve a paginated list of telco data usage reports `GET /legacy_reporting/usage_reports/number_lookup` ```java 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(); ``` ## Submit telco data usage report Submit a new telco data usage report `POST /legacy_reporting/usage_reports/number_lookup` ```java 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(); ``` ## Get telco data usage report by ID Retrieve a specific telco data usage report by its ID `GET /legacy_reporting/usage_reports/number_lookup/{id}` ```java 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("id"); ``` ## Delete telco data usage report Delete a specific telco data usage report by its ID `DELETE /legacy_reporting/usage_reports/number_lookup/{id}` ```java import com.telnyx.sdk.models.legacy.reporting.usagereports.numberlookup.NumberLookupDeleteParams; client.legacy().reporting().usageReports().numberLookup().delete("id"); ``` ## Get speech to text usage report Generate and fetch speech to text usage report synchronously. `GET /legacy_reporting/usage_reports/speech_to_text` ```java import com.telnyx.sdk.models.legacy.reporting.usagereports.UsageReportRetrieveSpeechToTextParams; import com.telnyx.sdk.models.legacy.reporting.usagereports.UsageReportRetrieveSpeechToTextResponse; UsageReportRetrieveSpeechToTextResponse response = client.legacy().reporting().usageReports().retrieveSpeechToText(); ``` ## List CDR usage reports Fetch all previous requests for cdr usage reports. `GET /legacy_reporting/usage_reports/voice` ```java 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(); ``` ## 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` ```java 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); ``` ## Get a CDR usage report Fetch single cdr usage report by id. `GET /legacy_reporting/usage_reports/voice/{id}` ```java 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"); ``` ## 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}` ```java 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"); ``` ## Fetch all Messaging usage reports Fetch all messaging usage reports. `GET /reports/mdr_usage_reports` ```java import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportListPage; import com.telnyx.sdk.models.reports.mdrusagereports.MdrUsageReportListParams; MdrUsageReportListPage page = client.reports().mdrUsageReports().list(); ``` ## Create MDR Usage Report Submit request for new new messaging usage report. `POST /reports/mdr_usage_reports` ```java 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); ``` ## Retrieve messaging report Fetch a single messaging usage report by id `GET /reports/mdr_usage_reports/{id}` ```java 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"); ``` ## Delete MDR Usage Report Delete messaging usage report by id `DELETE /reports/mdr_usage_reports/{id}` ```java 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"); ``` ## Generate and fetch MDR Usage Report Generate and fetch messaging usage report synchronously. `GET /reports/mdr_usage_reports/sync`