Concepts
Number
Definition
A Number in the Fax.Plus system represents a fax-enabled phone number. It can be used to send faxes from (as your own number) or to send faxes to (as a recipient’s number). Numbers are a crucial part of the faxing process, allowing you to manage your fax communication channels effectively.Key Concepts
Number Acquisition
- Numbers are acquired through the Fax.Plus service.
- Each number has an
acquired_dateindicating when it was obtained.
Number Assignment
- Numbers can be assigned to one or more users within your organization.
- The
assigned_tofield contains an array of user IDs who have access to the number.
Number Ownership
- Each number has an
owner_id, typically the user or organization that acquired the number.
Notifications
- Numbers can be configured with various notification settings for different events (e.g., receiving a fax, voicemail, etc.).
Number Properties
| Property | Description |
|---|---|
| id | Unique identifier for the number |
| number | The actual phone number in E.164 format (e.g., +16699990000) |
| owner_id | ID of the user or organization that owns the number |
| status | Current status of the number (waiting_verification or active) |
| assigned_to | Array of user IDs to whom this number is assigned |
| acquired_date | Date and time when the number was acquired |
| expiration_date | Date when the number will expire (if applicable) |
| is_canceled | Boolean indicating if the number has been canceled |
| notifications | Array of notification settings for various events |
Using Numbers
Sending Faxes
When sending a fax, you can specify the “from” number to use. This should be one of your acquired and active numbers.Receiving Faxes
Incoming faxes will be directed to the numbers you’ve acquired. You can set up notifications to alert you when a fax is received.Managing Numbers
The Fax.Plus API provides endpoints to:- List all your numbers
- Get details about a specific number
- Assign numbers to users
- Revoke numbers from users
Schema
Date and time at which the number was acquired
IDs of the user to whom this number is assigned
Number ID
Fax number
Pattern:
^[+][1-9][0-9]{1,14}$Number owner ID
Status of your fax number e.g. active, inactive.
Available options:
waiting_verification, active Number expiration date, might be blank
True if number is canceled but not yet deleted