Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface ListFaxesRequestData

    interface ListFaxesRequestData {
        createTime?: string | Date;
        createTimeRange?: Fax.DateRangeFilter;
        direction?: string;
        from?: string;
        labels?: Labels;
        page?: string;
        pageSize?: number;
        serviceId?: string;
        status?: string;
        to?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createTime? createTimeRange? direction? from? labels? page? pageSize? serviceId? status? to?

    Properties

    createTime?: string | Date

    Filter calls based on createTime. It can be a year, a month or a day.

    createTimeRange?: Fax.DateRangeFilter

    Filter calls based on createTime. It will filter the faxes on a range of dates.

    direction?: string

    Limits results to faxes with the specified direction.

    from?: string

    A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.

    labels?: Labels

    Filter faxes by labels.

    Optionalpage

    page?: string

    The page you want to retrieve returned from a previous List request, if any

    pageSize?: number

    The maximum number of items to return per request. The default is 100 and the maximum is 1000. If you need to export larger amounts and pagination is not suitable for you can use the Export function in the dashboard.

    serviceId?: string

    Limits results to faxes that were sent using the specified service.

    status?: string

    Limits results to faxes with the specified status.

    to?: string

    A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.

    Settings

    Member Visibility

    On This Page

    Properties