Skip to main content

@dialstack/sdk-dev / server/src / FaxListParams

Interface: FaxListParams

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

Properties​

did?​

TypeScript
optional did?: string;

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

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

direction?​

TypeScript
optional direction?: FaxDirection;

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

expand?​

TypeScript
optional expand?: FaxExpand[];

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

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

is_read?​

TypeScript
optional is_read?: boolean;

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

Pass false to show only unread faxes.

limit?​

TypeScript
optional limit?: number;

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

number?​

TypeScript
optional number?: string;

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

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/server/src/index.ts:934

status?​

TypeScript
optional status?: FaxStatus;

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

On this page