1.0.0 • Published 9 years ago

messagemedia-rest-api

Licence

Apache-2.0

Version

1.0.0

Deps

Vulns

Weekly

Summary Dependency Versions

MessageMedia REST API JavaScript SDK

MessagemediaRestApi - JavaScript client for messagemedia-rest-api Australia's Leading Messaging Solutions for Business and Enterprise.

API version: 1.0.0
Package version: 1.0.0
Build date: 2017-06-07T0547.762Z For more information, please visit https://www.messagemedia.com/contact-us

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install messagemedia-rest-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/messagemedia/messagemedia-rest-api-javascript-sdk then install it via:

    npm install messagemedia/messagemedia-rest-api-javascript-sdk --save

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var MessagemediaRestApi = require('messagemedia-rest-api');

var defaultClient = MessagemediaRestApi.ApiClient.instance;

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

var api = new MessagemediaRestApi.DeliveryReportsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkReports(callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
MessagemediaRestApi.DeliveryReportsApi	checkReports	GET /delivery_reports	Check delivery reports
MessagemediaRestApi.DeliveryReportsApi	confirmReports	POST /delivery_reports/confirmed	Confirm delivery reports as received
MessagemediaRestApi.MessagingApi	getMessageStatus	GET /messages/{messageId}	Get the status of a submitted message
MessagemediaRestApi.MessagingApi	sendMessages	POST /messages	Send one or more messages
MessagemediaRestApi.MessagingApi	updateMessageStatus	PUT /messages/{messageId}	Cancel a scheduled message
MessagemediaRestApi.MessagingReportsApi	getAsyncReportById	GET /reporting/async_reports/{report_id}	Gets a single asynchronous report.
MessagemediaRestApi.MessagingReportsApi	getAsyncReportDataById	GET /reporting/async_reports/{report_id}/data	Gets the data of an asynchronous report.
MessagemediaRestApi.MessagingReportsApi	getAsyncReports	GET /reporting/async_reports	Lists asynchronous reports.
MessagemediaRestApi.MessagingReportsApi	getDeliveryReportsDetail	GET /reporting/delivery_reports/detail	Returns a list of delivery reports
MessagemediaRestApi.MessagingReportsApi	getDeliveryReportsSummary	GET /reporting/delivery_reports/summary	Returns a summarised report of delivery reports
MessagemediaRestApi.MessagingReportsApi	getMetadataKeys	GET /reporting/{messageType}/metadata/keys	Returns a list of metadata keys
MessagemediaRestApi.MessagingReportsApi	getReceivedMessagesDetail	GET /reporting/received_messages/detail	Returns a list message received
MessagemediaRestApi.MessagingReportsApi	getReceivedMessagesSummary	GET /reporting/received_messages/summary	Returns a summarised report of messages received
MessagemediaRestApi.MessagingReportsApi	getSentMessagesDetail	GET /reporting/sent_messages/detail	Returns a list of message sent
MessagemediaRestApi.MessagingReportsApi	getSentMessagesSummary	GET /reporting/sent_messages/summary	Returns a summarised report of messages sent
MessagemediaRestApi.MessagingReportsApi	submitAsyncDeliveryReportsDetail	POST /reporting/delivery_reports/detail/async	Submits a request to generate an async detail report
MessagemediaRestApi.MessagingReportsApi	submitDeliveryReportsSummary	POST /reporting/delivery_reports/summary/async	Submits a summarised report of delivery reports
MessagemediaRestApi.MessagingReportsApi	submitReceivedMessagesDetail	POST /reporting/received_messages/detail/async	Submits a request to generate an async detail report
MessagemediaRestApi.MessagingReportsApi	submitReceivedMessagesSummary	POST /reporting/received_messages/summary/async	Submits a summarised report of received messages
MessagemediaRestApi.MessagingReportsApi	submitSentMessagesDetail	POST /reporting/sent_messages/detail/async	Submits a request to generate an async detail report
MessagemediaRestApi.MessagingReportsApi	submitSentMessagesSummary	POST /reporting/sent_messages/summary/async	Submits a summarised report of sent messages
MessagemediaRestApi.RepliesApi	checkReplies	GET /replies	Check replies
MessagemediaRestApi.RepliesApi	confirmReplies	POST /replies/confirmed	Confirm replies as received

Documentation for Models

Documentation for Authorization

basic

Type: HTTP basic authentication