Sinch Node.js SDK - v0.0.4
    Preparing search index...

    Interface ServiceResponse

    interface ServiceResponse {
        defaultForProject?: boolean;
        defaultFrom?: string;
        emailSettings?: ServiceEmailSettings;
        id?: string;
        imageConversionMethod?: ImageConversionMethod;
        incomingWebhookUrl?: string;
        name?: string;
        numberOfRetries?: number;
        projectId?: string;
        retryDelaySeconds?: number;
        saveInboundFaxDocuments?: boolean;
        saveOutboundFaxDocuments?: boolean;
        webhookContentType?: WebhookContentType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    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

    emailSettings?: ServiceEmailSettings

    ServiceEmailSettings

    id?: string

    ID of the fax service used.

    imageConversionMethod?: ImageConversionMethod

    Determines how documents are converted to black and white. Value should be halftone or monochrome. Defaults to value selected on Fax Settings page

    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.

    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.

    projectId?: string

    The Id of the project associated with the call.

    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

    webhookContentType?: WebhookContentType

    The content type of the webhook.