List fax records

Authorizations

Authorization

string

header

required

OAuth2 Authorization Grant

Path Parameters

user_id

string

default:

self

required

self or user id of a corporate member

Query Parameters

Response

200 - application/json

List of fax data

data

object

data.records

object[]

data.records.comment

string

required

Free-form comment

data.records.cost_details

object

required

data.records.id

string

required

Fax ID

data.records.owner_id

string

required

User ID of the fax owner

data.records.pages

integer

required

Number of pages in the fax

Required range: x > 0

data.records.status

enum<string>

required

Fax status

Available options:

success,

partially_sent,

partially_received,

insufficient_credit,

failed,

failed_internal_process_error,

failed_user_busy,

failed_no_answer,

failed_unallocated_number,

failed_office_converter_issue,

failed_separate_file_pages_issue,

failed_render_header_issue,

failed_invalid_number_format,

failed_mimetype_not_supported,

failed_destination_not_supported,

failed_image_preparation,

failed_to_send,

failed_normal_temporary_failure,

failed_unknown_converter_issue,

failed_normal_clearing,

failed_convert_to_tiff_issue,

failed_fs_49,

failed_fs_2

data.records.cost

integer

Fax cost in the user currency

Required range: x > 0

data.records.cover_page

object

Fax cover page

data.records.description

string

data.records.direction

enum<string>

Fax direction

Available options:

outgoing,

incoming

data.records.duration

integer

Required range: x > 0

data.records.file

string

Fax file ID for the getFile handle

data.records.file_name

string

Human-readable file name

data.records.from

string

Sender number. Might be a userId for faxes sent or received with free accounts

data.records.header

string

data.records.is_read

boolean

data.records.is_spam

boolean

True if the fax is marked as spam

data.records.last_update

string

data.records.max_retry

integer

Maximum number of retries

Required range: 0 < x < 3

data.records.retry_delay

integer

Delay between two retries

Required range: 0 < x < 30

data.records.scheduled_time

string

data.records.start_time

string

Time at which faxing session started. Format: YYYY-MM-DD HH:mm:ss

data.records.submit_time

string

Time when the fax was submitted for sending. For outgoing faxes only

data.records.to

string

Fax destination number. Might be a userId for faxes sent or received with free accounts

Get Started

Concepts

SDKs

API Reference

Authorizations

Path Parameters

Query Parameters

Response