VoicemailPut

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoicemailPut",
  "title": "VoicemailPut",
  "type": "object",
  "required": [
    "notifications",
    "transferToNumber"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Voicemail is enabled or disabled."
    },
    "sendAllCalls": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "All calls will be sent to voicemail."
        }
      },
      "description": "Settings for sending all calls to voicemail."
    },
    "sendBusyCalls": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Calls will be sent to voicemail when busy."
        },
        "greeting": {
          "type": "string",
          "enum": [
            "DEFAULT",
            "CUSTOM"
          ],
          "description": "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n"
        }
      },
      "description": "Settings for sending calls to voicemail when the line is busy."
    },
    "sendUnansweredCalls": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Unanswered call sending to voicemail is enabled or disabled."
        },
        "greeting": {
          "type": "string",
          "enum": [
            "DEFAULT",
            "CUSTOM"
          ],
          "description": "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n"
        },
        "numberOfRings": {
          "type": "number",
          "example": 3,
          "description": "Number of rings before an unanswered call will be sent to voicemail. `numberOfRings` must be between 2 and 20, inclusive."
        }
      }
    },
    "notifications": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Notifications for voicemails will be sent."
        },
        "destination": {
          "type": "string",
          "example": "[email protected]",
          "description": "Email address to which the notification will be sent. For text messages, use an email to text message gateway like `[email protected]`."
        }
      },
      "description": "Settings for notifications when there are any new voicemails."
    },
    "transferToNumber": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Enable or disable  voicemail caller transfer to a destination by pressing zero (0)."
        },
        "destination": {
          "type": "string",
          "example": "6527",
          "description": "Number voicemail caller will be transferred to when they press zero (0)."
        }
      },
      "description": "Settings for voicemail caller to transfer to a different number by pressing zero (0)."
    },
    "emailCopyOfMessage": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "When `true` copy of new voicemail message audio will be sent to the designated email."
        },
        "emailId": {
          "type": "string",
          "example": "[email protected]",
          "description": "Email address to which the new voicemail audio will be sent."
        }
      },
      "description": "Settings for sending a copy of new voicemail message audio via email."
    },
    "messageStorage": {
      "type": "object",
      "properties": {
        "mwiEnabled": {
          "type": "boolean",
          "example": true,
          "description": "When `true` desktop phone will indicate there are new voicemails."
        },
        "storageType": {
          "type": "string",
          "enum": [
            "INTERNAL",
            "EXTERNAL"
          ],
          "description": "Designates which type of voicemail message storage is used.\n * `INTERNAL` - Internal mailbox storage has the following limitations: Single message limit of 10 minutes and total mailbox limit of 100 minutes.\n * `EXTERNAL` - If `EXTERNAL` is selected, all messages will be sent to the email address entered. Messages will not be accessible via phone, clients, or the end user's calling portal.\n"
        },
        "externalEmail": {
          "type": "string",
          "example": "[email protected]",
          "description": "External email address to which the new voicemail audio will be sent."
        }
      }
    },
    "faxMessage": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "When `true` FAX messages for new voicemails are sent to the designated number."
        },
        "phoneNumber": {
          "type": "string",
          "example": "2025551212",
          "description": "Designates FAX number."
        },
        "extension": {
          "type": "string",
          "example": "1234",
          "description": "Designates Optional FAX extension."
        }
      }
    }
  }
}