Cebod Telecom
  • Introduction
  • Customer Onboarding
  • FAQs (Frequently Asked Questions)
  • Cebod Telecom Web Portal
    • Dashboard
    • Activities
      • Call records
      • Messages
      • Active calls
      • SMS records
      • Faxes
    • Phone System
      • Phone Numbers
      • IVR (Auto Receptionist)
      • Users (Extensions)
        • Dynamic Caller ID
      • Manage Devices
      • Manage Groups
      • Manage Conferences
      • Postcall Actions
      • Webhooks
      • Time Conditions
      • Call Blocking
      • Call Center
        • Active Calls
        • Agents
        • Queue
        • Agents to queue
        • Agents Status
        • Agent Statistics
    • Tools / Settings
      • Manage Phone Lines
      • Add 911 Address
      • SMS
      • International Calling
      • Outbound Rates
      • Manage Recordings
        • AI Text-to-Speech Feature
      • Global Settings
        • Daily Spent Control
      • Voicemail Greetings
      • CNAM
    • My Account
      • Profile
      • Change Password:
      • Add Balance
      • Payment History
      • Vouchers
      • Invoices
      • Auto Refill
      • Logout
  • How To's
    • Set up BLF
    • Register a New Account
    • Setup Call Forwarding
      • Call Forwarding to an Extension
      • Call Forwarding Manually to a Cell Phone
    • Dial-By-Name Directory
    • Voicemail
      • Setting up the Voicemail Menu
      • Accessing Voicemail
      • Navigate through the Voicemail Menu
    • Provisioning
      • Cisco 8841
    • Setup Speed Dial
    • Cebod Telecom Free Applications
      • MS Windows Desktop Softphone
      • Mac Desktop Softphone
      • Apple IOS Mobile App
      • Android Mobile App
      • Desktop SMS/MMS Application
      • Click to Call Browser Extension
    • GS Wave
    • Setting Up Whisper Announcement
  • Enable Call Recording
  • Features
    • Manage Phone Features
      • Call Block
      • Call transfer
      • Call Queue
      • Call Center
      • Active Call Features
      • Ring Groups
      • Call Forward
      • Call Recording
      • Call Park
      • Paging
      • Voicemail
      • Call Monitoring
      • Hide Caller ID
    • Missed Call SMS
    • Missed Call Email Notification
    • 3-Way Calling
    • Conference Bridge
    • Setting up Time Condition
    • Setup Email FAX - Incoming
    • Sending eFax using email
  • API
    • Voice API
    • Quick Start
      • Identify Caller
      • Collect Response
    • didML reference doc
      • Voice API reference 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>
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. didML reference doc
  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