Receive Fax

Set up fax receiving capabilities for your Audian account. Configure fax numbers, routing, and notifications for incoming documents.

Endpoints

List Received Faxes

GET https://api.audian.com:8443/v2/fax/received

Get Fax Details

GET https://api.audian.com:8443/v2/fax/received/{faxId}

Download Fax Document

GET https://api.audian.com:8443/v2/fax/received/{faxId}/download

Configure Webhook

POST https://api.audian.com:8443/v2/fax/webhooks

List Received Faxes

Retrieve all received faxes for your account.

Request

curl -X GET "https://api.audian.com:8443/v2/fax/received?limit=20&offset=0" \
  -H "X-Auth-Token: YOUR_API_KEY"

Parameters

Parameter	Type	Description
limit	Number	Results per page (default: 20, max: 100)
offset	Number	Pagination offset (default: 0)
from_date	ISO8601	Filter by received date (start)
to_date	ISO8601	Filter by received date (end)
status	String	Filter by status (received, processed, archived)

Examples

JavaScript/Node.js

const axios = require('axios');

const listReceivedFaxes = async (limit = 20, offset = 0) => {
  try {
    const response = await axios.get(
      'https://api.audian.com:8443/v2/fax/received',
      {
        params: {
          limit: limit,
          offset: offset
        },
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY'
        }
      }
    );
    console.log('Received faxes:', response.data);
    return response.data;
  } catch (error) {
    console.error('Failed to retrieve faxes:', error);
  }
};

// Usage
listReceivedFaxes(10);

Python

import requests
from datetime import datetime, timedelta

def list_received_faxes(api_key, limit=20, offset=0, 
                       from_date=None, to_date=None, status=None):
    url = 'https://api.audian.com:8443/v2/fax/received'
    headers = {
        'X-Auth-Token': api_key
    }
    
    params = {
        'limit': limit,
        'offset': offset
    }
    
    if from_date:
        params['from_date'] = from_date
    
    if to_date:
        params['to_date'] = to_date
    
    if status:
        params['status'] = status
    
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Usage
result = list_received_faxes(
    api_key='YOUR_API_KEY',
    limit=20,
    status='received'
)
print(result)

Get Faxes from Last 7 Days

curl -X GET "https://api.audian.com:8443/v2/fax/received?from_date=2024-01-28T00:00:00Z" \
  -H "X-Auth-Token: YOUR_API_KEY"

Response Format

List Faxes Success (200)

{
  "faxes": [
    {
      "id": "fax_received_123",
      "from_number": "+12025551234",
      "from_name": "John Smith",
      "to_number": "+15551234567",
      "pages": 5,
      "received_at": "2024-02-04T13:15:00Z",
      "status": "received",
      "format": "pdf",
      "file_size": 450000,
      "document_url": "https://api.audian.com:8443/v2/fax/received/fax_received_123/download",
      "processed": false
    }
  ],
  "total": 5,
  "limit": 20,
  "offset": 0
}

Get Fax Details

Retrieve detailed information about a received fax.

curl -X GET https://api.audian.com:8443/v2/fax/received/fax_received_123 \
  -H "X-Auth-Token: YOUR_API_KEY"

Response

{
  "id": "fax_received_123",
  "from_number": "+12025551234",
  "from_name": "John Smith",
  "to_number": "+15551234567",
  "pages": 5,
  "received_at": "2024-02-04T13:15:00Z",
  "status": "received",
  "format": "pdf",
  "file_size": 450000,
  "duration": 45,
  "baud_rate": 14400,
  "document_url": "https://api.audian.com:8443/v2/fax/received/fax_received_123/download",
  "processed": false,
  "created_at": "2024-02-04T13:15:00Z"
}

Download Fax Document

Download the received fax document.

curl -X GET https://api.audian.com:8443/v2/fax/received/fax_received_123/download \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -o received_fax.pdf

Configure Webhook for Incoming Faxes

Set up a webhook to receive notifications when faxes arrive.

Request

curl -X POST https://api.audian.com:8443/v2/fax/webhooks \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-domain.com/webhook/fax",
    "events": ["fax_received"],
    "enabled": true,
    "format": "json"
  }'

Parameters

Parameter	Type	Required	Description
url	String	Yes	Webhook URL
events	Array	Yes	Events to receive (fax_received, fax_processed)
enabled	Boolean	No	Enable webhook (default: true)
format	String	No	Payload format (json, xml, default: json)

Webhook Payload

When a fax is received, your webhook will receive:

{
  "event": "fax_received",
  "id": "fax_received_123",
  "from_number": "+12025551234",
  "from_name": "John Smith",
  "to_number": "+15551234567",
  "pages": 5,
  "received_at": "2024-02-04T13:15:00Z",
  "file_size": 450000,
  "format": "pdf",
  "document_url": "https://api.audian.com:8443/v2/fax/received/fax_received_123/download"
}

Incoming Fax Routing

Configure where incoming faxes are routed:

Email Notification

curl -X POST https://api.audian.com:8443/v2/fax/routing \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "destination": "receiving@company.com",
    "attach_document": true,
    "enabled": true
  }'

Webhook Routing

curl -X POST https://api.audian.com:8443/v2/fax/routing \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "webhook",
    "destination": "https://your-crm.com/api/fax",
    "attach_document": false,
    "enabled": true
  }'

Mark Fax as Processed

Update fax status after processing.

curl -X PUT https://api.audian.com:8443/v2/fax/received/fax_received_123 \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "processed"
  }'

Archive Fax

Move a fax to archive storage.

curl -X POST https://api.audian.com:8443/v2/fax/received/fax_received_123/archive \
  -H "X-Auth-Token: YOUR_API_KEY"

Search Received Faxes

Search for faxes by sender or date range.

const searchFaxes = async (fromNumber, fromDate, toDate) => {
  const params = new URLSearchParams();
  params.append('from_number', fromNumber);
  params.append('from_date', fromDate);
  params.append('to_date', toDate);
  
  const response = await axios.get(
    `https://api.audian.com:8443/v2/fax/received?${params}`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );
  
  return response.data;
};

Best Practices

1. Webhook Setup: Configure webhooks for real-time processing
2. Document Storage: Download and store important faxes immediately
3. Verification: Verify sender phone numbers for security
4. Processing: Mark faxes as processed to track workflow
5. Archival: Archive old faxes regularly
6. Routing: Set up appropriate routing rules
7. Retention: Define retention policies for compliance

Fax Number Management

Dedicated Fax Numbers

Request dedicated fax numbers for your account:

curl -X POST https://api.audian.com:8443/v2/fax/numbers \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "area_code": "202",
    "quantity": 1
  }'

Limits and Quotas

• Max received faxes stored: Based on plan
• Max fax numbers: 100 per account
• Webhook retries: 5 attempts over 24 hours
• Document retention: Per your storage plan
• Concurrent downloads: 10 per account
• Storage per fax: Variable based on pages