Fax

Programmable Fax in the cloud

Prototype, build, and deploy fax applications quickly and at competitive rates using our APIs and SDKs as well as the lightweight SignalWire Markup Language ("SWML").

🔐security first

SignalWire Fax is certified SOC 2 Type II compliant, and is built from the ground up for seamless HIPAA compliance.

REST API

REST API

curl -L 'https://<SPACE_URL>/api/laml/2010-04-01/Accounts/<ACCOUNT_ID>/Faxes' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <ACCOUNT_AUTH>' \
-d 'MediaUrl=<LINK_TO_PDF>' \
-d 'To=<TO_NUMBER>' \
-d 'From=<FROM_NUMBER>'

SWML

SWML

version: 1.0.0
sections:
  main:
    - receive_fax: {}

📚 SWML docsView the full guide →

CXML

CXML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive></Receive>
</Response>

📚 CXML docsView the full guide →

CXML

CXML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Reject/>
</Response>

Relay Realtime SDK (Server)

Relay Realtime SDK (Server)

import { SignalWire } from "@signalwire/realtime-api";

const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })

const voiceClient = client.voice;

// Setup a voice client tolisten for incoming calls
await voiceClient.listen({
  topics: ['office'],
  onCallReceived: async (call) => {
    // Answer the call
    call.answer();
    // Fax detection
    await call.detectFax({
      tone: 'CNG',
      listen: {
        onEnded: (event) => {
          // If the fax is detected, hangup the call
          if (event.result === 'CNG') {
            call.hangup();
          }
        }
      }
    })
  }
})

REST API

REST API

curl -L 'https://<SPACE_URL>/api/laml/2010-04-01/Accounts/<ACCOUNT_ID>/Faxes' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <ACCOUNT_AUTH>' \
-d 'MediaUrl=<LINK_TO_PDF>' \
-d 'To=<TO_NUMBER>' \
-d 'From=<FROM_NUMBER>'

SWML

SWML

version: 1.0.0
sections:
  main:
    - receive_fax: {}

📚 SWML docsView the full guide →

CXML

CXML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive></Receive>
</Response>

📚 CXML docsView the full guide →

CXML

CXML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Reject/>
</Response>

Relay Realtime SDK (Server)

Relay Realtime SDK (Server)

import { SignalWire } from "@signalwire/realtime-api";

const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })

const voiceClient = client.voice;

// Setup a voice client tolisten for incoming calls
await voiceClient.listen({
  topics: ['office'],
  onCallReceived: async (call) => {
    // Answer the call
    call.answer();
    // Fax detection
    await call.detectFax({
      tone: 'CNG',
      listen: {
        onEnded: (event) => {
          // If the fax is detected, hangup the call
          if (event.result === 'CNG') {
            call.hangup();
          }
        }
      }
    })
  }
})

REST API

REST API

curl -L 'https://<SPACE_URL>/api/laml/2010-04-01/Accounts/<ACCOUNT_ID>/Faxes' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <ACCOUNT_AUTH>' \
-d 'MediaUrl=<LINK_TO_PDF>' \
-d 'To=<TO_NUMBER>' \
-d 'From=<FROM_NUMBER>'

SignalWire REST API

SignalWire API

Technical reference for Fax endpoints

SWML

SWML fax documentation

Handle incoming faxes with your SWML script using the receive_fax method

Compatibility (cXML) API

Ideally suited for porting existing applications, cXML offers plug-and-play compatibility to quickly realize cost savings and enhanced performance.

Compatibility API

Technical reference for Fax endpoints

Fax cXML

cXML verb documentation

cXML Helper SDKs

SDKs for generating valid cXML

Learn more

Fax product page

Pricing, product, and contact info

Building secure communication solutions

Learn about security and compliance on the SignalWire platform