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_date indicating when it was obtained.

Number Assignment

  • Numbers can be assigned to one or more users within your organization.
  • The assigned_to field contains an array of user IDs who have access to the number.

Number Status

Numbers can have different statuses:

  • waiting_verification: The number is in the process of being verified.
  • active: The number is fully operational and ready for use.

Number Ownership

  • Each number has an owner_id, typically the user or organization that acquired the number.

Number Expiration

  • Some numbers may have an expiration_date, after which they may no longer be available for use.

Notifications

  • Numbers can be configured with various notification settings for different events (e.g., receiving a fax, voicemail, etc.).

Number Properties

PropertyDescription
idUnique identifier for the number
numberThe actual phone number in E.164 format (e.g., +16699990000)
owner_idID of the user or organization that owns the number
statusCurrent status of the number (waiting_verification or active)
assigned_toArray of user IDs to whom this number is assigned
acquired_dateDate and time when the number was acquired
expiration_dateDate when the number will expire (if applicable)
is_canceledBoolean indicating if the number has been canceled
notificationsArray 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

acquired_date
string
required

Date and time at which the number was acquired

assigned_to
string[]
required

IDs of the user to whom this number is assigned

expiration_date
string

Number expiration date, might be blank

id
string
required

Number ID

is_canceled
boolean

True if number is canceled but not yet deleted

notifications
object[]
number
string
required

Fax number

owner_id
string
required

Number owner ID

status
enum<string>
required

Status of your fax number e.g. active, inactive.

Available options:
waiting_verification,
active