Fax API v3.0

RESTful API for eFax Services

Authentication

Access Token is required in order to access Fax API functions. Click here for OAuth2 authentication instruction.
Put a valid Access Token in each HTTP Request Header:
Authorization: Bearer {access_token}

Endpoints

Function	Endpoint
Send	POST https://fax.maxmddirect.com/api/fax/{fax_number} Send eFax to multiple recipients with multiple documents Sample Codes:

HTTP Request Header

Authorization: Bearer {accessToken}

Content-Type: application/json

Request Body (format: application/json)

Name

Type

Description

NoPageHeader

String

Optional, if set to 1 then the fax is sent without page headers. The default is 0 (add headers to pages). This is option is intended for sending fax content Proprietary and Confidential, NativeFAX, LLC. 2018 6that was recently created where each page contains an informative page header.

SenderCompany

String

Optional, values that are used to populate fields in cover page.

SenderName

String

Optional, values that are used to populate fields in cover page.

SenderFaxNumber

String

Optional, values that are used to populate fields in cover page.

SenderVoiceNumber

String

Optional, values that are used to populate fields in cover page.

Subject

String

Optional, values that are used to populate fields in cover page.

Recipients

RecipientObject[]

List of Recipient objects with the following parameters

Address	String	Required, The fax number to be dialed.
Name	String	Optional, set a name associated with this recipient. The name is used for cover page creation.
Prefix	Integer	Optional, the type of recipient 0 = To 1 = Cc 2 = Bcc
CallerId	String	Optional set the caller id (ANI) for the call when the the fax is sent.

Documents

DocumentObject[]

List of Document objects with the following parameters

DocumentPart	Integer	Required, Specifies how the document is to be treated. 0 = CoverMessage 1 = Document
DocumentType	Integer	Specifies the type of document being supplied. Required when DocumentPart = 1. Optional when DocumentPart = 0 0 = Unknown 1 = TIFF 2 = RTF 3 = PDF 4 = HTML 5 = TEXT
Name	String	Specifies the name of the document. Required when DocumentPart = 1. Optional when DocumentPart = 0
ContentText	String	for Xml/Json posts, specifies the text content of the document. Required when DocumentPart = 0. Optional when DocumentPart = 1
ContentData	String	for Xml/Json posts, specifies the text content of the document. using Base64 encoding Required when DocumentPart = 1. Optional when DocumentPart = 0
PaperSize	String	Optional, specifies how the content should be converted to conform to a specified paper size, in particular the page length. The page width of the fax message is specified by the Resolution setting at the message level. The page width for an entire fax message must remain the same, and it is limited to widths that are supported by the receiving fax device (the most commonly supported width is 215mm that corresponds roughly to Letter or A4 paper size). The page length is more flexible and can be unique for each page. Letter Legal GovernmentLetter GovernmentLegal Tabloid A3 A4 A5 B3 B4 B5 C3 C4 C5

HTTP Response Code

HTTP Code	Description
200	Success.
400	Bad Request. Invalid action. Or some parameter is missing or invalid.
401	Unauthorized. No valid access token is found at request.
403	Forbidden. Permission denied for the requested action
404	Endpoint is not found
500	Server Error.

Error Response Body (format: application/json)

Name	Type	Description
error	String	Error message
description	String	Error description

Success Response Body (format: application/json)

Name

Type

Description

Username

String

MaxMD Username

FromFax

String

Fax number used in sending fax

ToRecipientList

RecipientObject[]

List of Recipient Objects

Address	String	The fax number has been dialed.
Name	String	Name associated with this recipient.
Prefix	Integer	The type of recipient 0 = To 1 = Cc 2 = Bcc
CallerId	String	The caller id (ANI) for the call when the the fax is sent.

MessageHandle

String

Unique message identifier to retrieve message information

description

String

Description

POST /api/fax/{fax_number} HTTP/1.1
Host: https://fax.maxmddirect.com
Content-Type: application/json
Authorization: Bearer {access_token}
Cache-Control: no-cache

{ "SenderFaxNumber": "111-111-1111", "Subject": "testtest", "RecipientMode": 0, "Recipients": [ { "Name": "Cheng Liu", "Address": "2016046642", "Prefix": "0", "CallerId": "2019630005" } ], "Documents": [ { "DocumentPart": 1, "Name": "FAX_20181018_1539874760_7.pdf", "DocumentType": 3, "PagerSize": "A4", "ContentData": "aGVsbG8=" } ] }


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://fax.maxmddirect.com/api/fax/{fax_number}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{ \"SenderFaxNumber\": \"111-111-1111\", \"Subject\": \"testtest\", \"RecipientMode\": 0, \"Recipients\": [ { \"Name\": \"Cheng Liu\", \"Address\": \"2016046642\", \"Prefix\": \"0\", \"CallerId\": \"2019630005\" } ], \"Documents\": [ { \"DocumentPart\": 1, \"Name\": \"FAX_20181018_1539874760_7.pdf\", \"DocumentType\": 3, \"PagerSize\": \"A4\", \"ContentData\": \"aGVsbG8=\" } ] }",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access_token}",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://fax.maxmddirect.com/api/fax/{fax_number}"

payload = "{ \"SenderFaxNumber\": \"111-111-1111\", \"Subject\": \"testtest\", \"RecipientMode\": 0, \"Recipients\": [ { \"Name\": \"Cheng Liu\", \"Address\": \"2016046642\", \"Prefix\": \"0\", \"CallerId\": \"2019630005\" } ], \"Documents\": [ { \"DocumentPart\": 1, \"Name\": \"FAX_20181018_1539874760_7.pdf\", \"DocumentType\": 3, \"PagerSize\": \"A4\", \"ContentData\": \"aGVsbG8=\" } ] }"
headers = {
    'content-type': "application/json",
    'authorization': "Bearer {access_token}",
    'cache-control': "no-cache"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://fax.maxmddirect.com/api/fax/5512055460",
  "method": "POST",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer {access_token}",
    "cache-control": "no-cache"
  },
  "processData": false,
  "data": "{ \"SenderFaxNumber\": \"111-111-1111\", \"Subject\": \"testtest\", \"RecipientMode\": 0, \"Recipients\": [ { \"Name\": \"Cheng Liu\", \"Address\": \"2016046642\", \"Prefix\": \"0\", \"CallerId\": \"2019630005\" } ], \"Documents\": [ { \"DocumentPart\": 1, \"Name\": \"FAX_20181018_1539874760_7.pdf\", \"DocumentType\": 3, \"PagerSize\": \"A4\", \"ContentData\": \"aGVsbG8=\" } ] }"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl -X POST \
  https://fax.maxmddirect.com/api/fax/{fax_number} \
  -H 'authorization: Bearer {access_token}' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{ "SenderFaxNumber": "111-111-1111", "Subject": "testtest", "RecipientMode": 0, "Recipients": [ { "Name": "Cheng Liu", "Address": "2016046642", "Prefix": "0", "CallerId": "2019630005" } ], "Documents": [ { "DocumentPart": 1, "Name": "FAX_20181018_1539874760_7.pdf", "DocumentType": 3, "PagerSize": "A4", "ContentData": "aGVsbG8=" } ] }'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"SenderFaxNumber\": \"111-111-1111\", \"Subject\": \"testtest\", \"RecipientMode\": 0, \"Recipients\": [ { \"Name\": \"Cheng Liu\", \"Address\": \"2016046642\", \"Prefix\": \"0\", \"CallerId\": \"2019630005\" } ], \"Documents\": [ { \"DocumentPart\": 1, \"Name\": \"FAX_20181018_1539874760_7.pdf\", \"DocumentType\": 3, \"PagerSize\": \"A4\", \"ContentData\": \"aGVsbG8=\" } ] }");
Request request = new Request.Builder()
  .url("https://fax.maxmddirect.com/api/fax/{fax_number}")
  .post(body)
  .addHeader("content-type", "application/json")
  .addHeader("authorization", "Bearer {access_token}")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();