Type alias CallForwardSetting

CallForwardSetting: {
    callForwarding: {
        always: CallForwardAlwaysSetting;
        busy: {
            enabled: boolean;
            destinationVoicemailEnabled?: boolean;
            destination?: string;
        };
        noAnswer: {
            enabled: boolean;
            numberOfRings?: number;
            systemMaxNumberOfRings?: number;
            destinationVoicemailEnabled?: boolean;
            destination?: string;
        };
    };
    businessContinuity: {
        enabled: boolean;
        destinationVoicemailEnabled?: boolean;
        destination?: string;
    };
}

CallForwardSetting object used within the callSetting object for Call forwarding APIs

Type declaration

  • callForwarding: {
        always: CallForwardAlwaysSetting;
        busy: {
            enabled: boolean;
            destinationVoicemailEnabled?: boolean;
            destination?: string;
        };
        noAnswer: {
            enabled: boolean;
            numberOfRings?: number;
            systemMaxNumberOfRings?: number;
            destinationVoicemailEnabled?: boolean;
            destination?: string;
        };
    }
    • always: CallForwardAlwaysSetting

      Object to configure properties to enable/disable call forward to a destination of your choice for all the incoming calls.

    • busy: {
          enabled: boolean;
          destinationVoicemailEnabled?: boolean;
          destination?: string;
      }

      Object to configure properties to enable/disable call forwarding to a destination of your choice when the user's line is busy.

      • enabled: boolean

        This indicates if the call forward is enabled or disabled when the user's line is busy.

      • Optional destinationVoicemailEnabled?: boolean

        This property signifies whether incoming calls are directed to the voicemail of the destination number when the user's line is busy, provided that the destination is an internal phone number with an enabled voicemail service.

      • Optional destination?: string

        Specify the destination number to which the call is forwarded in case of an unanswered call, if this feature is enabled. The destination can be either a phone number or a voicemail service.

    • noAnswer: {
          enabled: boolean;
          numberOfRings?: number;
          systemMaxNumberOfRings?: number;
          destinationVoicemailEnabled?: boolean;
          destination?: string;
      }

      Object to configure properties to enable/disable call forward to a destination of your choice in case the call goes unanswered.

      • enabled: boolean

        This indicates if the call forward is enabled or disabled when the call goes unanswered.

      • Optional numberOfRings?: number

        This property indicates number of rings before the call is forwarded to the destination number if unanswered.

      • Optional systemMaxNumberOfRings?: number

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

      • Optional destinationVoicemailEnabled?: boolean

        This property signifies whether incoming calls are directed to the voicemail of the destination number when the call goes unanswered, provided that the destination is an internal phone number with an enabled voicemail service.

      • Optional destination?: string

        If noAnswer is enabled, incoming calls are routed to the specified destination number in the event that the call remains unanswered. This destination can be either a phone number or a voicemail.

  • businessContinuity: {
        enabled: boolean;
        destinationVoicemailEnabled?: boolean;
        destination?: string;
    }

    Object to configure properties to enable/disable call forward to a destination of your choice when the user's line is not connected to the network.

    • enabled: boolean

      This indicates if the call forward is enabled or disabled when the user's line is not connected to the network.

    • Optional destinationVoicemailEnabled?: boolean

      This property signifies whether incoming calls are directed to the voicemail of the destination number in case the user's line is not connected to the network, provided that the destination is an internal phone number with an enabled voicemail service.

    • Optional destination?: string

      Once the "businessContinuity" feature is enabled, calls will be redirected to the specified destination number in case the user's line is not connected to the network. The designated destination can either be a phone number or a voicemail service.