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

    Interface ServiceRequest

    You can use the default created service, or create multiple services within the same project to have different default behavior for all your different faxing use cases.

    interface ServiceRequest {
        coverPageId?: string;
        defaultForProject?: boolean;
        defaultFrom?: string;
        imageConversionMethod?: string;
        incomingWebhookUrl?: string;
        name?: string;
        numberOfRetries?: number;
        resolution?: string;
        retryDelaySeconds?: number;
        saveInboundFaxDocuments?: boolean;
        saveOutboundFaxDocuments?: boolean;
        scanIncomingBarcodes?: boolean;
        webhookContentType?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    coverPageId?: string

    If a value is set, it will always add that cover page id to outbound faxes

    defaultForProject?: boolean

    If set to true this is the service used to create faxes when no serviceId is specified in the API endpoints.

    defaultFrom?: string

    One of your Sinch numbers connected to this service or any of your verified numbers

    imageConversionMethod?: string

    Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

    incomingWebhookUrl?: string

    The URL to which Sinch will post when someone sends a fax to your Sinch number. To accept incoming faxes this must be set and your Sinch phone number must be configured to receive faxes.

    Note: If a webhook uses basicauth credentials, when the webhook URL is retrieved those credentials are masked. It is not possible to retrieve previously-set credentials through the API.

    name?: string

    A friendly name for the service. Maximum is 60 characters.

    numberOfRetries?: number

    The number of times to retry sending a fax if it fails. Default is 3. Maximum is 5.

    resolution?: string

    Resolution

    retryDelaySeconds?: number

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

    saveInboundFaxDocuments?: boolean

    Save fax documents with sinch when you receive faxes

    saveOutboundFaxDocuments?: boolean

    Save fax documents with sinch when you send faxes

    scanIncomingBarcodes?: boolean

    If set to true, barcodes will be detected on incoming faxes.

    webhookContentType?: string

    The content type of the webhook.