@dialstack/sdk-dev / server/src / Fax
Interface: Fax
Defined in: sdk/server/src/index.ts:1567
Properties
attempts
attempts: number;
Defined in: sdk/server/src/index.ts:1598
call_id
call_id: string | null;
Defined in: sdk/server/src/index.ts:1587
completed_at
completed_at: string | null;
Defined in: sdk/server/src/index.ts:1602
created_at
created_at: string;
Defined in: sdk/server/src/index.ts:1603
did
did: string | DIDSummary;
Defined in: sdk/server/src/index.ts:1583
Your own number on the fax — the source DID outbound, the terminating DID
inbound. Its id by default, or a DIDSummary when
expand: ['did'] is requested.
direction
direction: FaxDirection;
Defined in: sdk/server/src/index.ts:1569
error_code
error_code: string | null;
Defined in: sdk/server/src/index.ts:1597
Machine-readable reason a failed fax failed. Null unless status is failed.
file
file: string | FileObject | null;
Defined in: sdk/server/src/index.ts:1577
The fax document — the file's id by default, or the full
FileObject with a signed url when expand: ['file'] is
requested. Null until the document exists (an inbound row before receipt,
or a failed fax).
from_number
from_number: string | null;
Defined in: sdk/server/src/index.ts:1585
Sender's number in E.164. Null inbound when caller ID was withheld.
id
id: string;
Defined in: sdk/server/src/index.ts:1568
pages
pages: number | null;
Defined in: sdk/server/src/index.ts:1589
Pages transmitted, once known.
read_at
read_at: string | null;
Defined in: sdk/server/src/index.ts:1600
When the fax was marked read. Read state is the null-ness of this field.
source_pages
source_pages: number | null;
Defined in: sdk/server/src/index.ts:1594
Page count of the source document (outbound only). Pair with pages to
show progress while sending, e.g. "15 of 30 sent".
status
status: FaxStatus;
Defined in: sdk/server/src/index.ts:1570
submitted_at
submitted_at: string | null;
Defined in: sdk/server/src/index.ts:1601
to_number
to_number: string | null;
Defined in: sdk/server/src/index.ts:1586
transport
transport: FaxTransport | null;
Defined in: sdk/server/src/index.ts:1595
updated_at
updated_at: string;
Defined in: sdk/server/src/index.ts:1604