Class DeliveryReportsApi

Hierarchy

SmsDomainApi
- DeliveryReportsApi

Index

Methods

get getByPhoneNumber list setBasePath

Methods

get

get(data: GetDeliveryReportByBatchIdRequestData): Promise<DeliveryReport>
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 <a href="https://community.sinch.com/t5/Glossary/E-164/ta-p/7537\" target="_blank">E.164</a> format for each status code.
Parameters
- data: GetDeliveryReportByBatchIdRequestData
  The data to provide to the API call.
Returns Promise<DeliveryReport>

getByPhoneNumber

getByPhoneNumber(
data: GetDeliveryReportByPhoneNumberRequestData,
): Promise<RecipientDeliveryReport>
Retrieve a recipient delivery report A recipient delivery report contains the message status for a single recipient phone number.
Parameters
- data: GetDeliveryReportByPhoneNumberRequestData
  The data to provide to the API call.
Returns Promise<RecipientDeliveryReport>

list

list(
data: GetDeliveryReportsRequestData,
): ApiListPromise<RecipientDeliveryReport>
Retrieve a list of delivery reports Get a list of finished delivery reports. This operation supports pagination.
Parameters
- data: GetDeliveryReportsRequestData
  The data to provide to the API call.
Returns ApiListPromise<RecipientDeliveryReport>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from SmsDomainApi.setBasePath