Sign in

v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Faxes

Get a fax record

Get a specific fax record details like duration, pages etc. (Permitted scopes: fax:all:read, fax:fax:read)

get/accounts/{user_id}/faxes/{fax_id}

Path parameters

user_idstring required

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

fax_idstring required

Response

Response containing a single fax object

commentstring required

Free-form comment

costinteger

Fax cost in the user currency

descriptionstring
direction'outgoing' | 'incoming'

Fax direction

durationinteger

Fax transmission duration in seconds

filestring

Fax file ID for the getFile handle

file_namestring

Human-readable file name

fromstring

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

headerstring
idstring required

Fax ID

is_readboolean
is_spamboolean

True if the fax is marked as spam

last_updatestring
max_retryinteger

Maximum number of retries

owner_idstring required

User ID of the fax owner

pagesinteger required

Number of pages in the fax

retry_delayinteger

Delay between two retries

scheduled_timestring
start_timestring

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

status'success' | 'partially_sent' | 'partially_received' | 'in_progress' | '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_2' | 'failed_fs_3' | 'failed_fs_8' | 'failed_fs_9' | 'failed_fs_31' | 'failed_fs_32' | 'failed_fs_35' | 'failed_fs_39' | 'failed_fs_48' | 'failed_fs_49' required

Fax status. Some failure codes use failed_fs_* values which represent low-level fax transport issues (for example, fax protocol incompatibility, the remote endpoint stopping responding, or remote disconnections). In particular: failed_fs_8/failed_fs_9 indicate protocol incompatibility; failed_fs_31/failed_fs_32 indicate that the remote stopped responding; failed_fs_35/failed_fs_39 indicate that the remote disconnected.

submit_timestring

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

tostring

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

Example response

{
  "comment": "",
  "cost": 2,
  "cost_details": {
    "multiplier": 1,
    "notification_cost": 0
  },
  "description": "OK",
  "direction": "incoming",
  "duration": 0,
  "file": "ec28edc283a74daca1787efb5fa6fae2.tiff",
  "file_name": "fax-from-12076001783",
  "from_number": "+12076001783",
  "header": null,
  "id": "5e7de3ad54cfd54eb568cc76",
  "is_read": false,
  "is_spam": false,
  "last_update": "2020-03-27 11:29:49",
  "max_retry": null,
  "owner_id": "74d59d2779fb42a99cd5bb993c0c89d2",
  "pages": 2,
  "retry_delay": null,
  "scheduled_time": null,
  "start_time": "2020-03-27 11:29:21",
  "status": "failed",
  "submit_time": null,
  "to": "+12076001783"
}