MessageMedia REST API C# SDK

Australia's Leading Messaging Solutions for Business and Enterprise.

• API version: 1.0.0
• SDK version: 1.0.0
• Build date: 2017-03-16T05:50:11.422Z For more information, please visit https://www.messagemedia.com/contact-us

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using MessageMedia.REST.API.Api;
using MessageMedia.REST.API.Client;
using Model;

Getting Started

using System;
using System.Diagnostics;
using MessageMedia.REST.API.Api;
using MessageMedia.REST.API.Client;
using Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DeliveryReportsApi();

            try
            {
                // Check delivery reports
                Reports result = apiInstance.CheckReports();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryReportsApi.CheckReports: " + e.Message );
            }
        }
    }
}

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

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

Documentation for Authorization

basic

• Type: HTTP basic authentication