Get outgoing fax

Get specific details of a fax currently scheduled for sending. (Permitted scopes: fax:all:read, fax:fax:read)

NodeJS SDK

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 getOutboxFax() {
    const reqParams = {
        "userId": '13d8z73c',
        "outboxFaxId": '132esd4cs31'
    }
    const req = await OutboxApiFp(config).getOutboxFax(reqParams);
    const resp = await req(axios);
}

getOutboxFax()

Authorizations

Authorization · string · header · required

OAuth2 Authorization Grant

Path Parameters

user_id · string · default: self · required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

outbox_fax_id · string · required

ID of the outgoing fax to get

Response

200

application/json

Response containing a single outbox object

Model for the outbound fax stored in the outbox

id · string · required

Fax ID

status · enum<string> · required

Outbound fax status

Available options:

submitted,

converting,

scheduled_for_sending,

sending

uid · string · required

User ID

comment · object

Comment to set for the fax job

Show child attributes

contact_name · string

designated_src · string

extra_info · object

file_changes · object[]

Show child attributes

files · string[]

Files to send

initiated_from · object

Show child attributes

ip · string

IP address from which the send request originated

last_updated_status_time · string

Time and date when the send request status was last updated. Format: YYYY-MM-DD HH:mm:ss

options · object

Additional configuration for sending a fax

Show child attributes

page_count · integer

Number of fax pages

Required range: x >= 0

retry · object

Fax retry settings

Show child attributes

Example:

{ "retry": { "count": 2, "delay": 10 } }

send_time · string

should_enhance · boolean

src · string

status_changes · object[]

Show child attributes

submit_time · string

Date and time when the fax was submitted for sending

to · string[]

cover_page · object

Fax cover page

Show child attributes