Skip to main content
GET
/
accounts
/
{user_id}
/
numbers
/
{number}
const axios = require('axios');
const NumbersApiFp = require('@alohi/faxplus-api').NumbersApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getNumber() {
    const reqParams = {
        "userId": '23415ufasx8df7',
        "number": '+123417543010'
    }
    const req = await NumbersApiFp(config).getNumber(reqParams);
    const resp = await req(axios);
}

getNumber()

{
  "acquired_date": "2017-07-31 09:20:06",
  "assigned_to": [
    "7724157c0974440293e45877c57f0703"
  ],
  "expiration_date": null,
  "id": "e6e68ef87f0b8768ebacdb218994bfe7",
  "is_canceled": false,
  "notifications": [
    {
      "email": true,
      "push_notification": true,
      "type": "voicemail"
    },
    {
      "email": true,
      "push_notification": true,
      "type": "receive_fax"
    },
    {
      "email": true,
      "push_notification": true,
      "type": "announcement"
    },
    {
      "email": true,
      "push_notification": true,
      "type": "callforward"
    }
  ],
  "number": "+16699990000",
  "owner_id": "7724157c0974440293e45877c57f0703",
  "status": "active"
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

const axios = require('axios');
const NumbersApiFp = require('@alohi/faxplus-api').NumbersApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getNumber() {
    const reqParams = {
        "userId": '23415ufasx8df7',
        "number": '+123417543010'
    }
    const req = await NumbersApiFp(config).getNumber(reqParams);
    const resp = await req(axios);
}

getNumber()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
user_id
string
default:self
required

ID of the number owner

​
number
string
required

Fax number to get information about

Response

Object containing number information

​
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

​
id
string
required

Number ID

​
number
string
required

Fax number

Pattern: ^[+][1-9][0-9]{1,14}$
​
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
​
expiration_date
string

Number expiration date, might be blank

​
is_canceled
boolean

True if number is canceled but not yet deleted

​
notifications
object[]