GetLocationVoicemailGroupObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetLocationVoicemailGroupObject",
  "title": "GetLocationVoicemailGroupObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "firstName",
    "lastName",
    "enabled",
    "languageCode",
    "greeting",
    "greetingUploaded",
    "voiceMessageForwardingEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "a7dd4d39-4a78-4516-955f-7810dbe379cf",
      "description": "UUID of voicemail group of a particular location."
    },
    "name": {
      "type": "string",
      "example": "VGName",
      "description": "Name of the voicemail group."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+1234234324",
      "description": "Voicemail group phone number."
    },
    "extension": {
      "type": "number",
      "example": 23455,
      "description": "Voicemail group extension number."
    },
    "routingPrefix": {
      "type": "string",
      "example": "1234",
      "description": "Routing prefix of location."
    },
    "esn": {
      "type": "string",
      "example": "123423455",
      "description": "Routing prefix + extension of a person or workspace."
    },
    "tollFreeNumber": {
      "type": "boolean",
      "description": "Voicemail group toll free number."
    },
    "firstName": {
      "type": "string",
      "example": "Customer",
      "description": "Voicemail group caller ID first name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "lastName": {
      "type": "string",
      "example": "Support",
      "description": "Voicemail group called ID last name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable voicemail group."
    },
    "languageCode": {
      "type": "string",
      "example": "en_us",
      "description": "Language for voicemail group audio announcement."
    },
    "greeting": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "Set voicemail group greeting type.\n * `DEFAULT` - Default voicemail group greeting.\n * `CUSTOM` - Custom voicemail group greeting.\n"
    },
    "greetingUploaded": {
      "type": "boolean",
      "example": true,
      "description": "Enabled if CUSTOM greeting is previously uploaded."
    },
    "greetingDescription": {
      "type": "string",
      "example": "short greeting.wav",
      "description": "CUSTOM greeting for previously uploaded."
    },
    "messageStorage": {
      "type": "object",
      "required": [
        "storageType"
      ],
      "properties": {
        "storageType": {
          "type": "string",
          "enum": [
            "INTERNAL",
            "EXTERNAL"
          ],
          "description": "Message storage type\n * `INTERNAL` - Store messages in internal mailbox.\n * `EXTERNAL` - Send messages to the email address provided.\n"
        },
        "externalEmail": {
          "type": "string",
          "example": "[email protected]",
          "description": "External email to forward the message."
        }
      },
      "description": "Message storage information"
    },
    "notifications": {
      "type": "object",
      "required": [
        "enabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Enable/disable messages notification"
        },
        "destination": {
          "type": "string",
          "example": "[email protected]",
          "description": "Notifications to be sent to provided email to SMS gateway."
        }
      },
      "description": "Message notifications"
    },
    "faxMessage": {
      "type": "object",
      "required": [
        "enabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Enable/disable fax messaging."
        },
        "phoneNumber": {
          "type": "string",
          "example": "+1234234324",
          "description": "Phone number to receive fax messages."
        },
        "extension": {
          "type": "number",
          "example": 23455,
          "description": "Extension to receive fax messages."
        }
      },
      "description": "Fax message receive settings"
    },
    "transferToNumber": {
      "type": "object",
      "required": [
        "enabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Enable/disable to transfer message."
        },
        "destination": {
          "type": "string",
          "example": "+12147691003",
          "description": "Transfer phone number to be called when '0' is dialed."
        }
      },
      "description": "Transfer message information"
    },
    "emailCopyOfMessage": {
      "type": "object",
      "required": [
        "enabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true,
          "description": "Enable/disable to email message copy."
        },
        "emailId": {
          "type": "string",
          "example": "[email protected]",
          "description": "Email message copy to email address provided."
        }
      },
      "description": "Message copy information"
    },
    "voiceMessageForwardingEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable to forward voice message."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObject",
      "description": "Settings for the direct line caller ID name to be shown for this voicemail group."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "The name to be used for dial by name functions."
    }
  }
}