ClickSend\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($date_from, $date_to, $q, $order, $page, $limit)

Get a list of Fax History.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$date_from = 56; // int | Customize result by setting from date (timestsamp) Example: 1457572619.
$date_to = 56; // int | Customize result by setting to date (timestamp) Example: 1457573000.
$q = "q_example"; // string | Custom query Example: status:Sent,status_code:201.
$order = "order_example"; // string | Order result by Example: date_added:desc,list_id:desc.
$page = 1; // int | Page number
$limit = 10; // int | Number of records per page

try {
    $result = $apiInstance->faxHistoryGet($date_from, $date_to, $q, $order, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxHistoryGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
date_from	int	Customize result by setting from date (timestsamp) Example: 1457572619.	[optional]
date_to	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($body)

Calculate Total Price for Fax Messages sent

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\FaxMessageCollection(); // \ClickSend\Model\FaxMessageCollection | FaxMessageCollection model

try {
    $result = $apiInstance->faxPricePost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxPricePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\ClickSend\Model\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($message_id)

Get a single fax receipt based on message id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$message_id = "message_id_example"; // string | ID of the message receipt to retrieve

try {
    $result = $apiInstance->faxReceiptsByMessageIdGet($message_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxReceiptsByMessageIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
message_id	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($page, $limit)

Get all delivery receipts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Page number
$limit = 10; // int | Number of records per page

try {
    $result = $apiInstance->faxReceiptsGet($page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxReceiptsGet: ', $e->getMessage(), PHP_EOL;
}
?>

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($body)

Add a delivery receipt

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\Url(); // \ClickSend\Model\Url | Url model

try {
    $result = $apiInstance->faxReceiptsPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxReceiptsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\ClickSend\Model\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($body)

Mark delivery receipts as read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\DateBefore(); // \ClickSend\Model\DateBefore | DateBefore model

try {
    $result = $apiInstance->faxReceiptsReadPut($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxReceiptsReadPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\ClickSend\Model\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($body)

Send a fax using supplied supported file-types.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\FAXApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\FaxMessageCollection(); // \ClickSend\Model\FaxMessageCollection | FaxMessageCollection model

try {
    $result = $apiInstance->faxSendPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAXApi->faxSendPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\ClickSend\Model\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

ClickSend\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