DIDs

Find Available

Path

/fax.php?cmd=faxlistdids

Description

Retrieve a list of available DIDs for purchase.

Parameters

state (required) - The two-letter abbreviation for the state.
full_dids - Set to “true” to receive a list of available numbers instead of available area codes.

Response

NOTE: This command no longer returns lists of full DIDs by default, and instead returns a placeholders demonstrating available area codes in the given state.

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <numbers>
    <did>225XXXXXXX</did>
    <did>318XXXXXXX</did>
    <did>337XXXXXXX</did>
  </numbers>
</content>

Example with full_dids=true:

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <numbers>
    <did>2252401111</did>
    <did>2252402222</did>
    <did>3182531111</did>
    <did>3182532222</did>
    <did>3373521111</did>
    <did>3373522222</did>
  </numbers>
</content>

Purchase

Path

/fax.php?cmd=faxgetdid

Description

Purchase a DID from a particular area code.

Parameters

did (required) - The full DID or placeholder, as returned by faxlistdids.

Response

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

List

Path

/fax.php?cmd=faxlistmydids

Description

Retrieve a full list of your DIDs.

Parameters

None

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <response>
    <faxnumber>
      <did>8888984835</did>
      <email>bob@example.com,alice@example.com</email>
    </faxnumber>
    <faxnumber>
      <did>3035551212</did>
      <email>tom@example.com,jerry@example.com</email>
  </response>
</content>

Update Emails

Path

/fax.php?cmd=faxchangeemail

Description

Update emails associated with a DID.

Parameters

did (required) - The DID (10 digits).
emails (required) - The emails to associate with the DID, separated by commas. These are email addresses that should receive notifications for faxes.

Response

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

Delete

Path

/fax.php?cmd=removedid

Description

Remove a currently assigned DID.

Parameters

did (required) - The DID (10 digits).

Response

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

Delete Faxes

Deleting a fax in VCAPI will not cause the corresponding Phaxio fax to be deleted.

Path

/fax.php?cmd=cleardidfaxes

Description

Delete all inbound and outbound faxes associated with a particular DID.

Parameters

did (required) - The DID (10 digits).

Response

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