IO.ClickSend.ClickSend.Api.MMSApi

All URIs are relative to https://rest.clicksend.com/v3

Method	HTTP request	Description
MmsHistoryExportGet	GET /mms/history/export	Export all mms history
MmsHistoryGet	GET /mms/history	Get all mms history
MmsPricePost	POST /mms/price	Get Price for MMS sent
MmsReceiptsGet	GET /mms/receipts	Get all delivery receipts
MmsReceiptsReadPut	PUT /mms/receipts-read	Mark delivery receipts as read
MmsSendPost	POST /mms/send	Send MMS

MmsHistoryExportGet

string MmsHistoryExportGet (string filename)

Export all mms history

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var filename = filename_example;  // string | Filename to download history as

            try
            {
                // Export all mms history
                string result = apiInstance.MmsHistoryExportGet(filename);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsHistoryExportGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
filename	string	Filename to download history as

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MmsHistoryGet

string MmsHistoryGet (string q = null, int? dateFrom = null, int? dateTo = null, int? page = null, int? limit = null)

Get all mms history

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var q = q_example;  // string | Custom query Example: from:{number},status_code:201. (optional) 
            var dateFrom = 56;  // int? | Start date (optional) 
            var dateTo = 56;  // int? | End date (optional) 
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)

            try
            {
                // Get all mms history
                string result = apiInstance.MmsHistoryGet(q, dateFrom, dateTo, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsHistoryGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
q	string	Custom query Example: from:{number},status_code:201.	[optional]
dateFrom	int?	Start date	[optional]
dateTo	int?	End date	[optional]
page	int?	Page number	[optional] [default to 1]
limit	int?	Number of records per page	[optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MmsPricePost

string MmsPricePost (MmsMessageCollection body)

Get Price for MMS sent

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var body = new MmsMessageCollection(); // MmsMessageCollection | MmsMessageCollection model

            try
            {
                // Get Price for MMS sent
                string result = apiInstance.MmsPricePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsPricePost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	MmsMessageCollection	MmsMessageCollection model

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MmsReceiptsGet

string MmsReceiptsGet (int? page = null, int? limit = null)

Get all delivery receipts

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)

            try
            {
                // Get all delivery receipts
                string result = apiInstance.MmsReceiptsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsReceiptsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
page	int?	Page number	[optional] [default to 1]
limit	int?	Number of records per page	[optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MmsReceiptsReadPut

string MmsReceiptsReadPut (DateBefore body = null)

Mark delivery receipts as read

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var body = new DateBefore(); // DateBefore | DateBefore model (optional) 

            try
            {
                // Mark delivery receipts as read
                string result = apiInstance.MmsReceiptsReadPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsReceiptsReadPut: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	DateBefore	DateBefore model	[optional]

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MmsSendPost

string MmsSendPost (MmsMessageCollection body)

Send MMS

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

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

            var apiInstance = new MMSApi();
            var body = new MmsMessageCollection(); // MmsMessageCollection | MmsMessageCollection model

            try
            {
                // Send MMS
                string result = apiInstance.MmsSendPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MMSApi.MmsSendPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	MmsMessageCollection	MmsMessageCollection model

Return type

string

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MMSApi.md

Latest commit

History

MMSApi.md

File metadata and controls

IO.ClickSend.ClickSend.Api.MMSApi

MmsHistoryExportGet

Example

Parameters

Return type

Authorization

HTTP request headers

MmsHistoryGet

Example

Parameters

Return type

Authorization

HTTP request headers

MmsPricePost

Example

Parameters

Return type

Authorization

HTTP request headers

MmsReceiptsGet

Example

Parameters

Return type

Authorization

HTTP request headers

MmsReceiptsReadPut

Example

Parameters

Return type

Authorization

HTTP request headers

MmsSendPost

Example

Parameters

Return type

Authorization

HTTP request headers