Type alias VoicemailSetting

VoicemailSetting: {
    enabled: boolean;
    sendAllCalls: {
        enabled: boolean;
    };
    sendBusyCalls: {
        enabled: boolean;
        greeting?: string;
        greetingUploaded?: boolean;
    };
    sendUnansweredCalls: {
        enabled: boolean;
        greeting?: string;
        greetingUploaded?: boolean;
        numberOfRings: number;
        systemMaxNumberOfRings?: number;
    };
    notifications: {
        enabled: boolean;
        destination?: string;
    };
    transferToNumber?: {
        enabled: boolean;
        destination: string;
    };
    emailCopyOfMessage: {
        enabled: boolean;
        emailId?: string;
    };
    messageStorage: {
        mwiEnabled: boolean;
        storageType: string;
        externalEmail?: string;
    };
    faxMessage?: {
        enabled: boolean;
        phoneNumber?: string;
        extension?: string;
    };
    voiceMessageForwardingEnabled?: boolean;
}

VoicemailSetting object used within the callSetting object for Voicemail APIs

Type declaration

  • enabled: boolean

    Boolean property to indicate if the voicemail is enabled/disabled for the user.

  • sendAllCalls: {
        enabled: boolean;
    }

    Object to configure properties for enabling/disabling the forwarding of all the incoming calls to voicemail. Please note that this setting can only be adjusted when voicemail is enabled.

    • enabled: boolean

      This indicates if the voicemail is enabled/disabled for all the incoming calls.

  • sendBusyCalls: {
        enabled: boolean;
        greeting?: string;
        greetingUploaded?: boolean;
    }

    Object to configure properties for enabling/disabling the forwarding of busy calls to voicemail. Please note that this setting can only be adjusted when voicemail is enabled.

    • enabled: boolean

      This indicates if the voicemail is enabled/disabled for the calls when the user's line is busy.

    • Optional greeting?: string

      Type of voicemail greeting to be played when the user's line is busy, 'default' or 'custom' is specified here.

    • Optional greetingUploaded?: boolean

      This indicates if the custom voicemail greeting is uploaded or not.

  • sendUnansweredCalls: {
        enabled: boolean;
        greeting?: string;
        greetingUploaded?: boolean;
        numberOfRings: number;
        systemMaxNumberOfRings?: number;
    }

    Object to configure properties for enabling/disabling the forwarding of unanswered calls to voicemail. Please note that this setting can only be adjusted when voicemail is enabled.

    • enabled: boolean

      This indicates if the voicemail is enabled/disabled for the calls when the call goes unanswered.

    • Optional greeting?: string

      Type of voicemail greeting to be played when the call goes unanswered, 'default' or 'custom' is specified here.

    • Optional greetingUploaded?: boolean

      This indicates if the custom voicemail greeting is uploaded or not.

    • numberOfRings: number

      This property indicates number of rings before the call goes to voicemail if unanswered.

    • Optional systemMaxNumberOfRings?: number

      System-wide maximum number of rings allowed to specify under numberOfRings property.

  • notifications: {
        enabled: boolean;
        destination?: string;
    }

    Settings for sending notifications when there are any new voicemails.

    • enabled: boolean

      Boolean property to indicate if sending notifications for any new voicemails is enabled/disabled.

    • Optional destination?: string

      Notifications are sent to the email address specifed here when there are any new voicemails.

  • Optional transferToNumber?: {
        enabled: boolean;
        destination: string;
    }

    Settings for voicemail caller to transfer to a different number by pressing zero (0).

    • enabled: boolean

      Boolean property to indicate if voicemail caller transfer to a destination is enabled/disabled if they press zero (0).

    • destination: string

      The number voicemail caller will be transferred to when they press zero (0).

  • emailCopyOfMessage: {
        enabled: boolean;
        emailId?: string;
    }

    Settings for sending a copy of new voicemail message audio via email.

    • enabled: boolean

      Boolean property to enable sending the copy of the new voicemail message audio will be sent to the designated email address.

    • Optional emailId?: string

      Email address to which the new voicemail audio will be sent

  • messageStorage: {
        mwiEnabled: boolean;
        storageType: string;
        externalEmail?: string;
    }

    Object to configure the storage for new voicemails

    • mwiEnabled: boolean

      Property to indicate on the line that there are new voicemails in the mailbox if enabled.

    • storageType: string

      Designates which type of voicemail message storage to use, 'internal' or 'external' is specified here.

    • Optional externalEmail?: string

      External email address to which the new voicemail audio will be sent.

  • Optional faxMessage?: {
        enabled: boolean;
        phoneNumber?: string;
        extension?: string;
    }

    Settings for sending fax messages for new voicemails.

    • enabled: boolean

      Boolean property to enable sending fax messages to the designated number for new voicemails.

    • Optional phoneNumber?: string

      Designated phone number is specified here where fax messages will be sent to if enabled for new voicemails.

    • Optional extension?: string

      Designated optional extension is specified here where fax messages will be sent to if enabled for new voicemails.

  • Optional voiceMessageForwardingEnabled?: boolean

Settings

Member Visibility

Theme