MessageMedia REST API PHP SDK

Australia's Leading Messaging Solutions for Business and Enterprise.

• API version: 1.0.0
• Build date: 2017-06-07T05:13:52.481Z For more information, please visit https://www.messagemedia.com/contact-us

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/messagemedia/messagemedia-rest-api-php-sdk.git"
    }
  ],
  "require": {
    "messagemedia/messagemedia-rest-api-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/./autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basic
MessageMedia\RESTAPI\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
MessageMedia\RESTAPI\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new MessageMedia\RESTAPI\Api\DeliveryReportsApi();

try {
    $result = $api_instance->checkReports();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryReportsApi->checkReports: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

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

Documentation For Models

• AccountsBody
• ActionBody
• AsyncDeliveryReportDetailRequest
• AsyncDeliveryReportsSummaryRequest
• AsyncDeliverySentMessagesRequest
• AsyncReceivedMessagesDetailRequest
• AsyncReceivedMessagesSummaryRequest
• AsyncReport
• AsyncReportResponse
• AsyncSentMessagesDetailRequest
• DeliveryOptionsBody
• DeliveryOptionsBodyInner
• DeliveryReport
• DeliveryReportBody
• DeliveryReportId
• DeliveryReports
• DestinationAddressBody
• DestinationAddressCountryBody
• EndDateBody
• InlineResponse200
• InlineResponse400
• MessageFormatBody
• Messages
• MetadataKeyBody
• MetadataKeysResponse
• MetadataKeysResponseProperties
• MetadataValueBody
• NewMessage
• Pagination
• ReceivedMessage
• ReceivedMessages
• Replies
• Reply
• ReplyId
• ReplyVendorAccountId
• Report
• ReportingDetailProperties
• ReportingDetailPropertiesFilters
• ReportingDetailPropertiesSorting
• Reports
• SentMessage
• SentMessages
• SortDirectionBody
• SourceAddressBody
• SourceAddressCountryBody
• StartDateBody
• Status
• StatusBody
• StatusCodeBody
• StatusesBody
• SubmittedMessage
• SubmittedMessages
• SummaryByBody
• SummaryFieldBody
• SummaryReport
• SummaryReportItem
• SummaryReportProperties
• TimezoneBody

Documentation For Authorization

basic

• Type: HTTP basic authentication

Author

[email protected]