PutLocationInterceptObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutLocationInterceptObject",
  "title": "PutLocationInterceptObject",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable location intercept. Enable this feature to override any location's Call Intercept settings that a person configures."
    },
    "incoming": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "INTERCEPT_ALL",
            "ALLOW_ALL"
          ],
          "description": "Select inbound call options.\n * `INTERCEPT_ALL` - Set to `INTERCEPT_ALL` to intercept all inbound calls.\n * `ALLOW_ALL` - Set to `ALLOW_ALL` to allow all inbound calls.\n"
        },
        "voicemailEnabled": {
          "type": "boolean",
          "example": true,
          "description": "Set to `true` to route voice mail."
        },
        "announcements": {
          "type": "object",
          "properties": {
            "greeting": {
              "type": "string",
              "enum": [
                "DEFAULT",
                "CUSTOM"
              ],
              "description": "Greeting type for location intercept.\n * `DEFAULT` - Set to `DEFAULT` to play default greeting.\n * `CUSTOM` - Set to `CUSTOM` to play custom greeting.\n"
            },
            "fileName": {
              "type": "string",
              "example": ".wav",
              "description": "If set to `CUSTOM` for greeting, filename of previously uploaded file."
            },
            "newNumber": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean",
                  "example": true,
                  "description": "Set to `true` to play new number announcement."
                },
                "destination": {
                  "type": "string",
                  "example": "2147691003",
                  "description": "If enabled, set destination phone number."
                }
              },
              "description": "Details for new number."
            },
            "zeroTransfer": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean",
                  "example": true,
                  "description": "Set to `true` to transfer to phone number."
                },
                "destination": {
                  "type": "string",
                  "example": "2147691005",
                  "description": "Transfer phone number to be called when '0' is dialed."
                }
              },
              "description": "Transfer number details."
            }
          },
          "description": "Announcements details."
        }
      },
      "description": "Inbound call details."
    },
    "outgoing": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "INTERCEPT_ALL",
            "ALLOW_LOCAL_ONLY"
          ],
          "description": "Outbound call options.\n * `INTERCEPT_ALL` - Set to `INTERCEPT_ALL` to intercept all outbound calls.\n * `ALLOW_LOCAL_ONLY` - Set to `ALLOW_LOCAL_ONLY` to allow local outbound calls.\n"
        },
        "transferEnabled": {
          "type": "boolean",
          "example": true,
          "description": "If `true`, allows transfer and forwarding for the call type."
        },
        "destination": {
          "type": "string",
          "example": "2147691007",
          "description": "If enabled, set valid outgoing destination phone number."
        }
      },
      "description": "Outbound Call details"
    }
  }
}