Documentation for Developer/Administrators
HomeAccount PortalPricing
  • About this Documentation
  • Overview
    • Table of Content
    • Introduction
    • Welcome Kit
      • Add Balance
      • Buy New Phone Number
      • Voice configuration
      • SMS Configuration
        • SMS Forwarding
      • Reporting
        • CDR
        • SMS
        • FAX
  • DIDforSale Portal
    • Register a new account
    • Dashboard
    • Reporting
      • CDR
      • SMS
      • Inbound Calls
      • FAX
      • Group Usage
      • Voicemails
    • Phone Numbers
      • Phone Numbers
      • Channels
      • E911
      • Porting
      • Send FAX
      • FAX Emails
      • SMS Groups
      • Groups
      • CNAM
    • Interconnection
      • Manage IP
      • SIP Accounts
      • Testing Center
      • Phones and Devices
      • Custom Dialplan
      • Audio Files
    • Tools/Settings
      • Outbound Rates
      • API Control
      • Fraud Control
      • Postcalls
    • Account
      • Profile
      • Change Password
      • Add Balance
      • Payment History
      • Voucher
      • Invoices
      • Auto Refill
      • Charges
      • Contact Us
      • Global Settings
      • Logout
  • SIP Trunking
    • Configuration of Phone Numbers
      • Configuring SIP to IP Account
      • Configuring Custom Dial Plan to a Phone Number
      • Configure SIP to SIP Account
      • Set up Call Forwarding to a Phone Number
      • http URL Forwarding Setup
      • Webhook Setup
      • FAX
        • Receive FAX
        • Fax through SIP Account
        • Send FAX
    • Adding IP Address
    • Creating SIP Account
      • VoiceMails
    • SIP Trunk Interconnection Guide
      • 3CX
        • SIP-based Configuration
        • IP-based Configuration
      • Allworx
      • Asterisk
      • CISCO UCM
      • FreePBX
        • FreePBX PJSIP Configuration
          • IP-based
          • SIP-based
        • FreePBX ChanSIP Configuration
          • IP based
          • SIP based
      • FreeSwitch
      • FusionPBX
      • GoAutoDial
      • Grandstream Devices
        • GrandStream 6102 IPPBX
        • GrandStream 502
        • Grandstream 6104 IPPBX
      • HoduSoft PBX System
      • Microsoft Skype for Business
      • NEC Corporation
      • PBXinaFlash
      • Polycom OBi300
      • ShoreTel PBX
      • Vital PBX
      • Yealink Phones
      • ZYCOO
    • DIDForSale Softphone
    • Zoiper Softphone Application
      • Iphone App
    • Grandstream Wave Mobile Application
    • Enable Call Recording
    • Call Transcription
  • Voice and SMS APIs
    • Getting the API key and Token
    • Voice
      • Big Picture
      • Quick Start
        • Identify Caller
        • Collect Response
      • didML Reference Doc
        • Voice API Request Params
        • Voice API Response
      • didML Verbs
        • <dial>
          • <client>
          • <conference>
          • <number>
          • <queue>
          • <sip>
        • <enqueue>
        • <fax>
        • <gather>
        • <hangup>
        • <pause>
        • <play>
        • <postcall>
        • <record>
        • <recordcall>
        • <redirect>
        • <reject>
        • <say>
        • <sms>
    • SMS
      • Configure SMS
      • Send/Receive SMS via Email
      • SMS Forwarding
        • SMS forwarding to Phone Number
        • SMS forwarding to Email
        • SMS forwarding to a Webhook
      • SMS/MMS Desktop Application
      • SMS APIs
        • Activate SMS
        • Deactivate SMS API
        • Send SMS
        • SMS CDR
        • Set SMS Forwarding
      • Bulk SMS Feature
        • Creating SMS Campaign
        • Custom or Dynamic Text Sms
  • UC Editor
    • UC Editor
      • Features
      • How to configure/setup the Custom Call Flow
  • FAX via Email
    • Send & Receive FAX via Email
Powered by GitBook
On this page

Was this helpful?

  1. Voice and SMS APIs
  2. Voice
  3. didML Verbs

<fax>

Role: <fax> keyword allow you to receive efax on the number. Once the fax is received, and action url is passed in the attributes we will send the link to pdf file where you can download the file at any time.

Use:

  • eFax – You can build an efax application. Our system will receive the fax and send you the link to the url defined in action attribute. You can download the file and email to end user.

While there are no limitation on where <fax> can be used, there definitely is optional set of attributes to use with <fax>. Below is a list of attributes to be used with <fax>, each attribute has a specific function and can use certain values.

Attributes

Attribute

Value

Default

action

Callback URL

none

Method

POST/GET

POST

Here is an example of how <fax> is used within code.

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

If the action url is passed, system will receive the fax and send the link to the url.

<?xml version="1.0" encoding="UTF-8"?> 
<Response>
       <fax action="handlefax.php" method=post/>
 </Response>

We also send other details about the fax in the url defined in action attribute. We will post the fax file location and other details in the post/get method.

“faxurl=Path do download the pdf file for the received fax. “callid=UUID “dialednumber=Dialed Number “callerid=callerid “faxstatus=Complete|incomplete|failed “numofpages= Total number of pages “Received= Number of pages received”

example get method

Previous<enqueue>Next<gather>

Last updated 6 years ago

Was this helpful?

www.example.com/faxhandle.php?faxurl=”didforsale.com/downloads/accountid/uuid.pdf”&callid=”8787hsgsh-aask9qwh-hsgd”&dialednumber=9499300360&callerid=9499300361&faxstatus=complete&numofpages=10&received=10