Faxes

Send Fax

Path

/fax.php?cmd=sendfax

Description

Send a fax.

Parameters

• faxnum (required) - The destination number (10 digits).
• faxsrc (required) - The source fax number (10 digits). Must be a number owned by your account.
• recname (required) - The recipient name.
• file1 (required) - The name of the first file to send.
• data1 (required) - The base64-encoded contents of the first file to send.

Note: Up to 20 files may be sent with a fax, using file1, data1, file2, data2, etc.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <response>ok</response>
  <jobid>1234</jobid>
</content>

List Outbound Faxes

Path

/fax.php?cmd=sentfaxstatus

Description

Retrieve a list of the last hundred outbound faxes for a vfax user.

Parameters

• vfaxaccount (required) - The vfax account name.

Response

Note: All timestamps are UTC.

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <sentfaxes>
    <fax>
      <jobid>1824488</jobid>
      <date>2007-05-25 03:43:25</date>
      <source>3035551212</source>
      <destination>3033331212</destination>
      <status>Processing</status>
      <pages>10</pages>
    </fax>
    <fax>
      <jobid>1824490</jobid>
      <date>2007-05-25 03:55:07</date>
      <source>3035551213</source>
      <destination>3033331213</destination>
      <status>deleted</status>
      <pages>2</pages>
    </fax>
  </sentfaxes>
</content>

Download Outbound Fax

Path

/fax.php?cmd=getsentfax

Description

Download an outbound fax.

Parameters

• faxid (required) - The ID of the fax to download.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <data>JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW</data>
</content>

Delete Outbound Fax

Path

/fax.php?cmd=delsentfax

Description

Delete an outbound fax.

Parameters

• faxid (required) - The ID of the fax.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <response>ok</response>
</content>

List Inbound Faxes

Path

/fax.php?cmd=listincomingfaxes

Description

Retrieve a list of the last hundred inbound faxes for a vfax user.

Parameters

• vfaxacc (required) - The vfax account name.
• type - Set to "unread" to only retrieve unread faxes. Leave blank for all faxes.

Response

Note: All timestamps are UTC.

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <faxes>
    <fax>
      <faxid>113812</faxid>
      <date>2007-03-09 19:44:45</date>
      <source>3035551212</source>
      <destination>3039991212</destination>
      <status>deleted</status>
      <pages>1</pages>
    </fax>
    <fax>
      <faxid>113803</faxid>
      <date>2007-03-09 18:48:22</date>
      <source>3035551212</source>
      <destination>3039991212</destination>
      <status>read</status>
      <pages>4</pages>
    </fax>
    <fax>
      <faxid>155854</faxid>
      <date>2007-05-17 23:37:01</date>
      <source>3035551212</source>
      <destination>3039991212</destination>
      <status>new</status>
      <pages>10</pages>
    </fax>
  </faxes>
</content>

Download Inbound Fax

Path

/fax.php?cmd=getfax

Description

Download an inbound fax.

Parameters

• faxid (required) - The ID of the fax to download.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <data>JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW</data>
</content>

Delete Inbound Fax

Path

/fax.php?cmd=delfax

Description

Delete an inbound fax.

Parameters

• faxid (required) - The ID of the fax.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <response>ok</response>
</content>