Skip to main content

@dialstack/sdk / server / FaxListParams

Interface: FaxListParams

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

Properties​

did?​

TypeScript
optional did?: string;

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

Filter by your own associated phone number, by its id.

direction?​

TypeScript
optional direction?: FaxDirection;

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

expand?​

TypeScript
optional expand?: FaxExpand[];

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

Related resources to include inline. Supported values: file, did.

is_read?​

TypeScript
optional is_read?: boolean;

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

Pass false to show only unread faxes.

limit?​

TypeScript
optional limit?: number;

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

number?​

TypeScript
optional number?: string;

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

Substring filter on the sender or recipient number. Non-digit characters are stripped, then matched anywhere in the stored E.164 value — 415 returns every fax to or from a 415 number.

page?​

TypeScript
optional page?: string;

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

status?​

TypeScript
optional status?: FaxStatus;

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

On this page