-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
177 changed files
with
10,296 additions
and
1,234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
client/src/main/com/sinch/sdk/domains/sms/DeliveryReportsService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
package com.sinch.sdk.domains.sms; | ||
|
||
import com.sinch.sdk.core.exceptions.ApiException; | ||
import com.sinch.sdk.domains.sms.models.DeliveryReportBatch; | ||
import com.sinch.sdk.domains.sms.models.DeliveryReportRecipient; | ||
import com.sinch.sdk.domains.sms.models.requests.DeliveryReportBatchGetRequestParameters; | ||
import com.sinch.sdk.domains.sms.models.requests.DeliveryReportListRequestParameters; | ||
import com.sinch.sdk.domains.sms.models.responses.DeliveryReportsListResponse; | ||
|
||
/** | ||
* Delivery reports Service | ||
* | ||
* <p>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 <a | ||
* href="https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByBatchId">Retrieve | ||
* a delivery report</a> or sent as a callback. | ||
* | ||
* @see <a | ||
* href="https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports">https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports</a> | ||
* @since 1.0 | ||
*/ | ||
public interface DeliveryReportsService { | ||
|
||
/** | ||
* Retrieve a batch delivery report <br> | ||
* 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 <a | ||
* href="https://community.sinch.com/t5/Glossary/E-164/ta-p/7537">E.164</a> format for each status | ||
* code. | ||
* | ||
* @param batchId The batch ID you received from sending a message param type param status param | ||
* code | ||
* @param parameters Filtering parameters | ||
* @return Delivery report related to batchId according to filters | ||
* @see <a | ||
* href="https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByBatchId">https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByBatchId</a> | ||
* @since 1.0 | ||
*/ | ||
DeliveryReportBatch get(String batchId, DeliveryReportBatchGetRequestParameters parameters) | ||
throws ApiException; | ||
|
||
/** | ||
* Retrieve a recipient delivery report <br> | ||
* A recipient delivery report contains the message status for a single recipient phone number. | ||
* | ||
* @param batchId The batch ID you received from sending a message param type param status param | ||
* code | ||
* @param recipient Phone number for which you to want to search | ||
* @return Delivery report related to batchId according to filters | ||
* @see <a | ||
* href="https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByPhoneNumber">https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/GetDeliveryReportByPhoneNumber</a> | ||
* @since 1.0 | ||
*/ | ||
DeliveryReportRecipient getForNumber(String batchId, String recipient) throws ApiException; | ||
|
||
/** | ||
* Get a list of finished delivery reports.<br> | ||
* This operation supports pagination. | ||
* | ||
* @param parameters Filtering parameters | ||
* @return Delivery report related to batchId according to filters | ||
* @see <a | ||
* href="https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/getDeliveryReports">https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/getDeliveryReports</a> | ||
* @since 1.0 | ||
*/ | ||
DeliveryReportsListResponse list(DeliveryReportListRequestParameters parameters) | ||
throws ApiException; | ||
} |
Oops, something went wrong.