Numbers
Get number information
Get Started
SDKs
API Reference
- Accounts
- Numbers
- Faxes
- Files
- Outbox
- Webhooks
- Shop
Numbers
Get number information
Get information about a single purchased/assigned fax number (Permitted scopes: fax:all:read, fax:numbers:read)
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"
}
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
OAuth2 Authorization Grant
Path Parameters
ID of the number owner
Fax number to get information about
Response
200
application/json
Object containing number information
The response is of type object
.
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"
}