Get Started
SDKs
API Reference
- Accounts
- Numbers
- Faxes
- Files
- Outbox
- Webhooks
- Shop
Outbox
List faxes in the outbox
Get a list of the faxes in the outbox which were not yet sent. (Permitted scopes: fax:all:read, fax:fax:read)
GET
/
accounts
/
{user_id}
/
outbox
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 listOutboxFaxes() {
const reqParams = {
"userId": '13d8z73c'
}
const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
const resp = await req(axios);
}
listOutboxFaxes()
{
"records": [
{
"comment": {
"tags": [],
"text": ""
},
"contact_name": "",
"designated_src": "",
"extra_info": {},
"file_changes": [],
"files": [
"/transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df"
],
"id": "13a4afb0585345639733857e8f36df8d",
"initiated_from": {
"from_id": "",
"type": ""
},
"ip": "8.8.8.8",
"last_updated_status_time": "2017-09-24 06:43:04",
"options": {},
"page_count": 0,
"retry": {
"count": 0,
"delay": 0
},
"send_time": "2017-09-24 06:43:04 +0000",
"should_enhance": false,
"src": "+16699990000",
"status": "submitted",
"status_changes": [
{
"at": "2017-09-24 06:43:04",
"status": "submitted"
}
],
"submit_time": "2017-09-24 06:43:04 +0000",
"to": [
"+16699990000"
],
"uid": "53a1afb8585345a39033857e1f36bf8d"
}
]
}
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 listOutboxFaxes() {
const reqParams = {
"userId": '13d8z73c'
}
const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
const resp = await req(axios);
}
listOutboxFaxes()
Authorizations
OAuth2 Authorization Grant
Path Parameters
self or user id of a corporate member
Response
200
application/json
Response containing a list of faxes waiting to be sent
List of the outgoing faxes
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
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 listOutboxFaxes() {
const reqParams = {
"userId": '13d8z73c'
}
const req = await OutboxApiFp(config).listOutboxFaxes(reqParams);
const resp = await req(axios);
}
listOutboxFaxes()
{
"records": [
{
"comment": {
"tags": [],
"text": ""
},
"contact_name": "",
"designated_src": "",
"extra_info": {},
"file_changes": [],
"files": [
"/transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df"
],
"id": "13a4afb0585345639733857e8f36df8d",
"initiated_from": {
"from_id": "",
"type": ""
},
"ip": "8.8.8.8",
"last_updated_status_time": "2017-09-24 06:43:04",
"options": {},
"page_count": 0,
"retry": {
"count": 0,
"delay": 0
},
"send_time": "2017-09-24 06:43:04 +0000",
"should_enhance": false,
"src": "+16699990000",
"status": "submitted",
"status_changes": [
{
"at": "2017-09-24 06:43:04",
"status": "submitted"
}
],
"submit_time": "2017-09-24 06:43:04 +0000",
"to": [
"+16699990000"
],
"uid": "53a1afb8585345a39033857e1f36bf8d"
}
]
}