MdrUsageReportsApi

All URIs are relative to https://api.telnyx.com/v2

Method	HTTP request	Description
deleteUsageReport	DELETE /reports/mdr_usage_reports/{id}
getUsageReport	GET /reports/mdr_usage_reports/{id}
getUsageReportSync	GET /reports/mdr_usage_reports/sync
getUsageReports	GET /reports/mdr_usage_reports
submitUsageReport	POST /reports/mdr_usage_reports

deleteUsageReport

MdrDeleteUsageReportsResponse deleteUsageReport(id)

Delete messaging usage report by id

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MdrUsageReportsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MdrUsageReportsApi apiInstance = new MdrUsageReportsApi(defaultClient);
        UUID id = UUID.randomUUID(); // UUID | 
        try {
            MdrDeleteUsageReportsResponse result = apiInstance.deleteUsageReport(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MdrUsageReportsApi#deleteUsageReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID

Return type

MdrDeleteUsageReportsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-

getUsageReport

MdrGetUsageReportsByIdResponse getUsageReport(id)

Fetch a single messaging usage report by id

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MdrUsageReportsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MdrUsageReportsApi apiInstance = new MdrUsageReportsApi(defaultClient);
        UUID id = UUID.randomUUID(); // UUID | 
        try {
            MdrGetUsageReportsByIdResponse result = apiInstance.getUsageReport(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MdrUsageReportsApi#getUsageReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID

Return type

MdrGetUsageReportsByIdResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-

getUsageReportSync

MdrGetSyncUsageReportResponse getUsageReportSync(aggregationType, startDate, endDate, profiles)

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.

Example

import java.time.OffsetDateTime;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MdrUsageReportsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MdrUsageReportsApi apiInstance = new MdrUsageReportsApi(defaultClient);
        String aggregationType = "NO_AGGREGATION"; // String | 
        OffsetDateTime startDate = OffsetDateTime.parse("2020-07-01T00:00-06:00"); // OffsetDateTime | 
        OffsetDateTime endDate = OffsetDateTime.parse("2020-07-01T00:00-06:00"); // OffsetDateTime | 
        List<String> profiles = Arrays.asList(); // List<String> | 
        try {
            MdrGetSyncUsageReportResponse result = apiInstance.getUsageReportSync(aggregationType, startDate, endDate, profiles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MdrUsageReportsApi#getUsageReportSync");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
aggregationType	String	[enum: NO_AGGREGATION, PROFILE, TAGS]
startDate	OffsetDateTime	[optional]
endDate	OffsetDateTime	[optional]
profiles	List<String>	[optional]

Return type

MdrGetSyncUsageReportResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-

getUsageReports

MdrGetUsageReportsResponse getUsageReports(pageNumber, pageSize)

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

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MdrUsageReportsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MdrUsageReportsApi apiInstance = new MdrUsageReportsApi(defaultClient);
        Integer pageNumber = 1; // Integer | Page number
        Integer pageSize = 20; // Integer | Size of the page
        try {
            MdrGetUsageReportsResponse result = apiInstance.getUsageReports(pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MdrUsageReportsApi#getUsageReports");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	Page number	[optional] [default to 1]
pageSize	Integer	Size of the page	[optional] [default to 20]

Return type

MdrGetUsageReportsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-

submitUsageReport

MdrPostUsageReportsResponse submitUsageReport(mdrPostUsageReportRequest)

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

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.MdrUsageReportsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        MdrUsageReportsApi apiInstance = new MdrUsageReportsApi(defaultClient);
        MdrPostUsageReportRequest mdrPostUsageReportRequest = new MdrPostUsageReportRequest(); // MdrPostUsageReportRequest | Mdr usage report data
        try {
            MdrPostUsageReportsResponse result = apiInstance.submitUsageReport(mdrPostUsageReportRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MdrUsageReportsApi#submitUsageReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
mdrPostUsageReportRequest	MdrPostUsageReportRequest	Mdr usage report data

Return type

MdrPostUsageReportsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-

Files

MdrUsageReportsApi.md

Latest commit

History

MdrUsageReportsApi.md

File metadata and controls

MdrUsageReportsApi

deleteUsageReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUsageReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUsageReportSync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getUsageReports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitUsageReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details