Sha256: 535faa13b926142e630d5b4dbdee126926b7cdf4865c299f2b88a480e7da3f64

Contents?: true

Size: 1.59 KB

Versions: 9

Compression:

Stored size: 1.59 KB

Contents

# MessenteApi::DeliveryReportApi

All URIs are relative to *https://api.messente.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage



## retrieve_delivery_report

> DeliveryReportResponse retrieve_delivery_report(omnimessage_id)

Retrieves the delivery report for the Omnimessage

### Example

```ruby
# load the gem
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::DeliveryReportApi.new
omnimessage_id = 'omnimessage_id_example' # String | UUID of the omnimessage to for which the delivery report is to be retrieved

begin
  #Retrieves the delivery report for the Omnimessage
  result = api_instance.retrieve_delivery_report(omnimessage_id)
  p result
rescue MessenteApi::ApiError => e
  puts "Exception when calling DeliveryReportApi->retrieve_delivery_report: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **omnimessage_id** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved | 

### Return type

[**DeliveryReportResponse**](DeliveryReportResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
messente_api-1.4.0 docs/DeliveryReportApi.md
messente_api-1.3.1 docs/DeliveryReportApi.md
messente_api-1.3.0 docs/DeliveryReportApi.md
messente_api-1.2.2 docs/DeliveryReportApi.md
messente_api-1.2.1 docs/DeliveryReportApi.md
messente_api-1.2.0 docs/DeliveryReportApi.md
messente_api-1.1.0 docs/DeliveryReportApi.md
messente_api-1.0.3 docs/DeliveryReportApi.md
messente_api-1.0.2 docs/DeliveryReportApi.md