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
getSingleMessageInfo	GET https://fax.maxmddirect.com/api/fax/{fax_number}/{message_handle} get single message information based on fax number and message handle Sample Codes:
getMultipleMessageInfo	GET https://fax.maxmddirect.com/api/fax/getMessageList/{fax_number}/{offset} get multiple message information based on fax number with offset. Set offset to be 0 to get the most recent 10 fax messages Sample Codes:

HTTP Request Header

Authorization: Bearer {accessToken}

Content-Type: application/json

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

MessageHandle

String

Unique message identifier to retrieve message information

MessageDetail

MessageObject[]

List of MessageObjects

fax_number

String

Fax number used in sending fax.

status

String

Status of message: waiting or complete

updated_ts

Timestamp

Updated timestamp

recipients

RecipientObject[]

List of Recipient Objects

Address	String	The fax number has been dialed.
Name	String	Name associated with this recipient.
PageCount	Integer	Number of pages per recipient

description

String

Description

description

String

Description

GET /api/fax/{fax_number}/{message_handle} HTTP/1.1
Host: https://fax.maxmddirect.com
Authorization: Bearer {access_token}
Cache-Control: no-cache


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://fax.maxmddirect.com/api/fax/{fax_number}/{message_handle}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access_token}",
    "cache-control: no-cache"
  ),
));

$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}/{message_handle}"

headers = {
    'authorization': "Bearer {access_token}",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://fax.maxmddirect.com/api/fax/{fax_number}/{message_handle}",
  "method": "GET",
  "headers": {
    "authorization": "Bearer {access_token}",
    "cache-control": "no-cache"
  }
}

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

curl -X GET \
  https://fax.maxmddirect.com/api/fax/{fax_number}/{message_handle} \
  -H 'authorization: Bearer {access_token}' \
  -H 'cache-control: no-cache' \

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://fax.maxmddirect.com/api/fax/{fax_number}/{message_handle}")
  .get()
  .addHeader("authorization", "Bearer {access_token}")
  .addHeader("cache-control", "no-cache")
  .build();

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

GET /api/fax/getMessageList/{fax_number}/{offset} HTTP/1.1
Host: https://fax.maxmddirect.com
Authorization: Bearer {access_token}
Cache-Control: no-cache


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://fax.maxmddirect.com/api/fax/getMessageList/{fax_number}/{offset}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer {access_token}",
    "cache-control: no-cache"
  ),
));

$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/getMessageList/{fax_number}/{offset}"

headers = {
    'authorization': "Bearer {access_token}",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://fax.maxmddirect.com/api/fax/getMessageList/{fax_number}/{offset}",
  "method": "GET",
  "headers": {
    "authorization": "Bearer {access_token}",
    "cache-control": "no-cache"
  }
}

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

curl -X GET \
  https://fax.maxmddirect.com/api/fax/getMessageList/{fax_number}/{offset} \
  -H 'authorization: Bearer {access_token}' \
  -H 'cache-control: no-cache' \

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://fax.maxmddirect.com/api/fax/getMessageList/{fax_number}/{offset}")
  .get()
  .addHeader("authorization", "Bearer {access_token}")
  .addHeader("cache-control", "no-cache")
  .build();

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