Skip to content

DeliveryReportApi.md

Latest commit

 

History

History
56 lines (39 loc) · 1.68 KB

DeliveryReportApi.md

File metadata and controls

56 lines (39 loc) · 1.68 KB

MessenteApi.DeliveryReportApi

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

Method HTTP request Description
retrieveDeliveryReport GET /omnimessage/{omnimessageId}/status Retrieves the delivery report for the Omnimessage

retrieveDeliveryReport

DeliveryReportResponse retrieveDeliveryReport(omnimessage_id)

Retrieves the delivery report for the Omnimessage

Example

var MessenteApi = require('messente_api');
var defaultClient = MessenteApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new MessenteApi.DeliveryReportApi();
var omnimessage_id = "omnimessage_id_example"; // String | UUID of the omnimessage to for which the delivery report is to be retrieved
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.retrieveDeliveryReport(omnimessage_id, callback);

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

Authorization

basicAuth

HTTP request headers

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