Account

These actions manage the registration of your Phaxio API keys with the VCAPI. For actions related to accounts for your end users, see vFax Accounts.

Register

Path

/user.php?cmd=register

Description

Register a new user account for VCAPI. Some configuration of your Phaxio account is also needed. Please see the notes below.

Parameters

• phaxio_api_key (required) - Your Phaxio API key
• phaxio_api_secret (required) - Your Phaxio API secret
• phaxio_webhook_token (required) - Your Phaxio webhook token

Response

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

Notes

Your Phaxio API credentials can be found here, and your webhook token can be found here.

Also on your Phaxio webhook settings page, set the received handler to the VCAPI /webhooks/received_fax endpoint, and the sent handler to the VCAPI /webhooks/sent_fax endpoint. Ensure that inflight webhooks are disabled, and that the webhook version is 2.1.0.

Update

Path

/user.php?cmd=update

Description

Update a user account.

Parameters

• phaxio_webhook_token - Your Phaxio webhook token

Response

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