vFax Accounts

These actions manage your end user accounts in VCAPI. For actions related to your main user account, see Account.

Create

Path

/fax.php?cmd=newfaxacc

Description

Create a vfax account.

Parameters

• acclogin (required) - The vfax account login.
• accname (required) - The name of the vfax account.
• did (required) - DIDs to be associated with the vfax account, separated by commas.
• accpass - The vfax account password. This password is not presently used, and only accepted for the sake of compatibility. Must be between 8 and 72 characters.
• accemails - Emails to be associated with the vfax account, separated by commas.
• hipaa_enabled - Set to “true” to enable HIPAA compliance for the vfax account.

Response

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

Show

Path

/fax.php?cmd=getfaxacc

Description

Retrieve information about a vfax account.

Parameters

• faxacc (required) - The vfax account login.

Response

<?xml version="1.0" encoding="UTF-8"?>
<content>
  <status>ok</status>
  <accname>TestAccount</accname>
  <did>2252409999,3185412222</did>
  <accemails>bob@example.com,alice@example.com</accemails>
</content>

Update

Path

/fax.php?cmd=setfaxacc

Description

Update vfax account settings.

Parameters

• faxacc (required) - The vfax account login.
• did - DIDs to be associated with the vfax account, separated by commas.
• accemails - Emails to be associated with the vfax account, separated by commas.
• hipaa_enabled - Set to “true” to enable HIPAA compliance for the vfax account.

Response

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

Delete

Path

/fax.php?cmd=delfaxacc

Description

Delete a vfax account.

Parameters

• acclogin (required) - The vfax account login.

Response

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