IO.ClickSend.ClickSend.Api.FAXApi

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

Method	HTTP request	Description
FaxHistoryGet	GET /fax/history	Get a list of Fax History.
FaxPricePost	POST /fax/price	Calculate Total Price for Fax Messages sent
FaxReceiptsByMessageIdGet	GET /fax/receipts/{message_id}	Get a single fax receipt based on message id.
FaxReceiptsGet	GET /fax/receipts	Get all delivery receipts
FaxReceiptsPost	POST /fax/receipts	Add a delivery receipt
FaxReceiptsReadPut	PUT /fax/receipts-read	Mark delivery receipts as read
FaxSendPost	POST /fax/send	Send a fax using supplied supported file-types.

FaxHistoryGet

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

Get a list of Fax 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 FaxHistoryGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXApi();
            var dateFrom = 56;  // int? | Customize result by setting from date (timestsamp) Example: 1457572619. (optional) 
            var dateTo = 56;  // int? | Customize result by setting to date (timestamp) Example: 1457573000. (optional) 
            var q = q_example;  // string | Custom query Example: status:Sent,status_code:201. (optional) 
            var order = order_example;  // string | Order result by Example: date_added:desc,list_id:desc. (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 a list of Fax History.
                string result = apiInstance.FaxHistoryGet(dateFrom, dateTo, q, order, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxHistoryGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dateFrom	int?	Customize result by setting from date (timestsamp) Example: 1457572619.	[optional]
dateTo	int?	Customize result by setting to date (timestamp) Example: 1457573000.	[optional]
q	string	Custom query Example: status:Sent,status_code:201.	[optional]
order	string	Order result by Example: date_added:desc,list_id:desc.	[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]

FaxPricePost

string FaxPricePost (FaxMessageCollection body)

Calculate Total Price for Fax Messages 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 FaxPricePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXApi();
            var body = new FaxMessageCollection(); // FaxMessageCollection | FaxMessageCollection model

            try
            {
                // Calculate Total Price for Fax Messages sent
                string result = apiInstance.FaxPricePost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxPricePost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	FaxMessageCollection	FaxMessageCollection 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]

FaxReceiptsByMessageIdGet

string FaxReceiptsByMessageIdGet (string messageId)

Get a single fax receipt based on message id.

Example

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

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

            var apiInstance = new FAXApi();
            var messageId = messageId_example;  // string | ID of the message receipt to retrieve

            try
            {
                // Get a single fax receipt based on message id.
                string result = apiInstance.FaxReceiptsByMessageIdGet(messageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxReceiptsByMessageIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
messageId	string	ID of the message receipt to retrieve

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]

FaxReceiptsGet

string FaxReceiptsGet (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 FaxReceiptsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXApi();
            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.FaxReceiptsGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxReceiptsGet: " + 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]

FaxReceiptsPost

string FaxReceiptsPost (Url body)

Add a delivery receipt

Example

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

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

            var apiInstance = new FAXApi();
            var body = new Url(); // Url | Url model

            try
            {
                // Add a delivery receipt
                string result = apiInstance.FaxReceiptsPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxReceiptsPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Url	Url 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]

FaxReceiptsReadPut

string FaxReceiptsReadPut (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 FaxReceiptsReadPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

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

            try
            {
                // Mark delivery receipts as read
                string result = apiInstance.FaxReceiptsReadPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxReceiptsReadPut: " + 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]

FaxSendPost

string FaxSendPost (FaxMessageCollection body)

Send a fax using supplied supported file-types.

Example

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

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

            var apiInstance = new FAXApi();
            var body = new FaxMessageCollection(); // FaxMessageCollection | FaxMessageCollection model

            try
            {
                // Send a fax using supplied supported file-types.
                string result = apiInstance.FaxSendPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXApi.FaxSendPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	FaxMessageCollection	FaxMessageCollection 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]

FilesExpand file tree

FAXApi.md

Latest commit

History

FAXApi.md

File metadata and controls

IO.ClickSend.ClickSend.Api.FAXApi

FaxHistoryGet

Example

Parameters

Return type

Authorization

HTTP request headers

FaxPricePost

Example

Parameters

Return type

Authorization

HTTP request headers

FaxReceiptsByMessageIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

FaxReceiptsGet

Example

Parameters

Return type

Authorization

HTTP request headers

FaxReceiptsPost

Example

Parameters

Return type

Authorization

HTTP request headers

FaxReceiptsReadPut

Example

Parameters

Return type

Authorization

HTTP request headers

FaxSendPost

Example

Parameters

Return type

Authorization

HTTP request headers