Package com.sinch.sdk.domains.sms

Interface DeliveryReportsService

public interface DeliveryReportsService

Delivery reports Service

The REST API uses message statuses and error codes in delivery reports, which refer to the state of the batch and can be present in either Retrieve a delivery report or sent as a callback.

Since:

1.0

See Also:

https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports

Method Summary

Modifier and Type	Method	Description
DeliveryReportBatch	get(String batchId, DeliveryReportBatchGetRequestParameters parameters)	Retrieve a batch delivery report Delivery reports can be retrieved even if no callback was requested.
DeliveryReportRecipient	getForNumber(String batchId, String recipient)	Retrieve a recipient delivery report A recipient delivery report contains the message status for a single recipient phone number.
DeliveryReportsListResponse	list(DeliveryReportListRequestParameters parameters)	Get a list of finished delivery reports. This operation supports pagination.

Method Detail

get

DeliveryReportBatch get(String batchId,
                        DeliveryReportBatchGetRequestParameters parameters)
                 throws ApiException

Retrieve a batch delivery report
Delivery reports can be retrieved even if no callback was requested. The difference between a summary and a full report is only that the full report contains the phone numbers in E.164 format for each status code.

Parameters:

batchId - The batch ID you received from sending a message param type param status param code

parameters - Filtering parameters

Returns:

Delivery report related to batchId according to filters

Throws:

ApiException

Since:

1.0

See Also:

https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByBatchId

getForNumber

DeliveryReportRecipient getForNumber(String batchId,
                                     String recipient)
                              throws ApiException

Retrieve a recipient delivery report
A recipient delivery report contains the message status for a single recipient phone number.

Parameters:

batchId - The batch ID you received from sending a message param type param status param code

recipient - Phone number for which you to want to search

Returns:

Delivery report related to batchId according to filters

Throws:

ApiException

Since:

1.0

See Also:

https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByPhoneNumber

list

DeliveryReportsListResponse list(DeliveryReportListRequestParameters parameters)
                          throws ApiException

Get a list of finished delivery reports.
This operation supports pagination.

Parameters:

parameters - Filtering parameters

Returns:

Delivery report related to batchId according to filters

Throws:

ApiException

Since:

1.0

See Also:

https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/getDeliveryReports