Skip to main content

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

Interface: FaxListParams

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

Properties​

did?​

TypeScript
did?: string;

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

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


direction?​

TypeScript
direction?: FaxDirection;

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


expand?​

TypeScript
expand?: FaxExpand[];

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

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


is_read?​

TypeScript
is_read?: boolean;

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

Pass false to show only unread faxes.


limit?​

TypeScript
limit?: number;

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


number?​

TypeScript
number?: string;

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

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
page?: string;

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


status?​

TypeScript
status?: FaxStatus;

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