Skip to main content

@dialstack/sdk / server / Fax

Interface: Fax

Defined in: sdk/src/server/index.ts:874

Properties​

attempts​

TypeScript
attempts: number;

Defined in: sdk/src/server/index.ts:904

call_id​

TypeScript
call_id: string | null;

Defined in: sdk/src/server/index.ts:894

completed_at​

TypeScript
completed_at: string | null;

Defined in: sdk/src/server/index.ts:908

created_at​

TypeScript
created_at: string;

Defined in: sdk/src/server/index.ts:909

did​

TypeScript
did: string | DIDSummary;

Defined in: sdk/src/server/index.ts:890

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​

TypeScript
direction: FaxDirection;

Defined in: sdk/src/server/index.ts:876

error_code​

TypeScript
error_code: string | null;

Defined in: sdk/src/server/index.ts:903

file​

TypeScript
file: string | FileObject | null;

Defined in: sdk/src/server/index.ts:884

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​

TypeScript
from_number: string | null;

Defined in: sdk/src/server/index.ts:892

Sender's number in E.164. Null inbound when caller ID was withheld.

id​

TypeScript
id: string;

Defined in: sdk/src/server/index.ts:875

pages​

TypeScript
pages: number | null;

Defined in: sdk/src/server/index.ts:896

Pages transmitted, once known.

read_at​

TypeScript
read_at: string | null;

Defined in: sdk/src/server/index.ts:906

When the fax was marked read. Read state is the null-ness of this field.

source_pages​

TypeScript
source_pages: number | null;

Defined in: sdk/src/server/index.ts:901

Page count of the source document (outbound only). Pair with pages to show progress while sending, e.g. "15 of 30 sent".

status​

TypeScript
status: FaxStatus;

Defined in: sdk/src/server/index.ts:877

submitted_at​

TypeScript
submitted_at: string | null;

Defined in: sdk/src/server/index.ts:907

to_number​

TypeScript
to_number: string | null;

Defined in: sdk/src/server/index.ts:893

transport​

TypeScript
transport: FaxTransport | null;

Defined in: sdk/src/server/index.ts:902

updated_at​

TypeScript
updated_at: string;

Defined in: sdk/src/server/index.ts:910

On this page