Package com.sinch.sdk.domains.sms.api.v1

Interface DeliveryReportsService

public interface DeliveryReportsService
Delivery reports Service

  • Method Details

    • list

      ListDeliveryReportsResponse list() throws ApiException
      Retrieve a list of delivery reports (using default parameters)

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

      Returns:
      ListDeliveryReportsResponse
      Throws:
      ApiException - if fails to make API call

    • list

      ListDeliveryReportsResponse list(ListDeliveryReportsQueryParameters queryParameter) throws ApiException
      Retrieve a list of delivery reports

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

      Parameters:
      queryParameter - (optional)
      Returns:
      ListDeliveryReportsResponse
      Throws:
      ApiException - if fails to make API call

    • get

      BatchDeliveryReport get(String batchId) throws ApiException
      Retrieve a delivery report (using default parameters)

      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](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format for each status code.

      Parameters:
      batchId - The batch ID you received from sending a message. (required)
      Returns:
      BatchDeliveryReport
      Throws:
      ApiException - if fails to make API call

    • get

      BatchDeliveryReport get(String batchId, BatchDeliveryReportQueryParameters queryParameter) throws ApiException
      Retrieve a 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](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format for each status code.

      Parameters:
      batchId - The batch ID you received from sending a message. (required)
      queryParameter - (optional)
      Returns:
      BatchDeliveryReport
      Throws:
      ApiException - if fails to make API call

    • getForNumber

      RecipientDeliveryReport getForNumber(String batchId, String recipientMsisdn) 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. (required)
      recipientMsisdn - Phone number for which you to want to search. (required)
      Returns:
      RecipientDeliveryReport
      Throws:
      ApiException - if fails to make API call