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

    Interface Fax

    interface Fax {
        barCodes?: BarCode[];
        callbackUrl?: string;
        callbackUrlContentType?: WebhookContentType;
        completedTime?: Date;
        contentUrl?: FaxContentUrl;
        createTime?: Date;
        direction?: FaxDirection;
        errorCode?: number;
        errorMessage?: string;
        errorType?: ErrorType;
        from?: string;
        hasFile?: string;
        headerPageNumbers?: boolean;
        headerText?: string;
        headerTimeZone?: string;
        id?: string;
        imageConversionMethod?: ImageConversionMethod;
        labels?: { [key: string]: string };
        maxRetries?: number;
        numberOfPages?: number;
        price?: FaxMoney;
        projectId?: string;
        retryCount?: number;
        retryDelaySeconds?: number;
        serviceId?: string;
        status?: FaxStatus;
        to?: string;
    }
    Index

    Properties

    barCodes?: BarCode[]

    The bar codes found in the fax. This field is populated when sinch detects bar codes on incoming faxes.

    callbackUrl?: string

    The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the callbackUrl parameter, if provided, otherwise it will be sent to the URL specified in the callbackUrl field of the Fax Service object.

    callbackUrlContentType?: WebhookContentType

    The content type of the callback.

    completedTime?: Date

    If the job is complete, this is a timestamp representing the time the job was completed.

    contentUrl?: FaxContentUrl

    FaxContentUrl

    createTime?: Date

    A timestamp representing the time when the initial API call was made.

    direction?: FaxDirection

    FaxDirection

    errorCode?: number

    One of the error numbers listed in the Fax Error Messages section.

    errorMessage?: string

    One of the error messages listed in the Fax Error Messages section.

    errorType?: ErrorType

    ErrorType

    from?: string

    A phone number in E.164 format, including the leading '+'.

    hasFile?: string

    Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false)

    headerPageNumbers?: boolean

    If true, page numbers will be displayed in the header. Default is true.

    headerText?: string

    Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.

    headerTimeZone?: string

    A TZ database name string specifying the timezone for the header timestamp.

    id?: string

    The id of a fax

    imageConversionMethod?: ImageConversionMethod

    Determines how documents are converted to black and white. Defaults to value selected on Fax Service object.

    labels?: { [key: string]: string }

    You can use this to attach labels to your call that you can use in your applications. It is a key value store.

    maxRetries?: number

    The number of times the fax will be retired before cancel. Default value is set in your fax service. The maximum number of retries is 5.

    numberOfPages?: number

    The number of pages in the fax.

    price?: FaxMoney

    The total price for this fax. This field is populated after the final fax price is calculated.

    projectId?: string

    The Id of the project associated with the call.

    retryCount?: number

    The number of times the fax has been retried.

    retryDelaySeconds?: number

    The number of seconds to wait between retries if the fax is not yet completed.

    serviceId?: string

    ID of the fax service used.

    status?: FaxStatus

    FaxStatus

    to?: string

    A phone number in E.164 format, including the leading '+'.