CallForwardingInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallForwardingInfo",
  "title": "CallForwardingInfo",
  "type": "object",
  "required": [
    "callForwarding",
    "businessContinuity"
  ],
  "properties": {
    "callForwarding": {
      "type": "object",
      "required": [
        "always",
        "busy",
        "noAnswer"
      ],
      "properties": {
        "always": {
          "type": "object",
          "required": [
            "enabled",
            "ringReminderEnabled",
            "destinationVoicemailEnabled"
          ],
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "\"Always\" call forwarding is enabled or disabled."
            },
            "destination": {
              "type": "string",
              "example": "2225551212",
              "description": "Destination for \"Always\" call forwarding."
            },
            "ringReminderEnabled": {
              "type": "boolean",
              "description": "If `true`, a brief tone will be played on the virtual line's phone when a call has been forwarded."
            },
            "destinationVoicemailEnabled": {
              "type": "boolean",
              "description": "Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled."
            }
          },
          "description": "Settings for forwarding all incoming calls to the destination you choose."
        },
        "busy": {
          "type": "object",
          "required": [
            "enabled",
            "destinationVoicemailEnabled"
          ],
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "\"Busy\" call forwarding is enabled or disabled."
            },
            "destination": {
              "type": "string",
              "example": "2225551212",
              "description": "Destination for \"Busy\" call forwarding."
            },
            "destinationVoicemailEnabled": {
              "type": "boolean",
              "description": "Indicates the enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled."
            }
          },
          "description": "Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy."
        },
        "noAnswer": {
          "type": "object",
          "required": [
            "enabled",
            "numberOfRings",
            "systemMaxNumberOfRings",
            "destinationVoicemailEnabled"
          ],
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "\"No Answer\" call forwarding is enabled or disabled."
            },
            "destination": {
              "type": "string",
              "example": "2225551212",
              "description": "Destination for \"No Answer\" call forwarding."
            },
            "numberOfRings": {
              "type": "number",
              "example": 3,
              "description": "Number of rings before the call will be forwarded if unanswered."
            },
            "systemMaxNumberOfRings": {
              "type": "number",
              "example": 15,
              "description": "System-wide maximum number of rings allowed for `numberOfRings` setting."
            },
            "destinationVoicemailEnabled": {
              "type": "boolean",
              "description": "Indicates the enabled or disabled state of sending incoming calls to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled."
            }
          },
          "description": "Settings for forwarding which only occurs when you are away or not answering your phone."
        }
      },
      "description": "Settings related to \"Always\", \"Busy\", and \"No Answer\" call forwarding."
    },
    "businessContinuity": {
      "type": "object",
      "required": [
        "enabled",
        "destinationVoicemailEnabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Business Continuity is enabled or disabled."
        },
        "destination": {
          "type": "string",
          "example": "2225551212",
          "description": "Destination for Business Continuity."
        },
        "destinationVoicemailEnabled": {
          "type": "boolean",
          "description": "Indicates enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled."
        }
      },
      "description": "Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem."
    }
  }
}