Webex · Schema

GetAutoAttendantCallForwardSelectiveRuleObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique ID for the rule.
name string Unique name for the selective rule in the auto attendant.
enabled boolean Reflects if rule is enabled.
businessSchedule string Name of the location's business schedule which determines when this selective call forwarding rule is in effect.
holidaySchedule string Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect.
forwardTo object Controls what happens when the rule matches including the destination number for the call forwarding.
callsFrom object Settings related to the rule matching based on incoming caller ID.
callsTo object Settings related to the rule matching based on the destination number.
View JSON Schema on GitHub

JSON Schema

webex-getautoattendantcallforwardselectiveruleobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetAutoAttendantCallForwardSelectiveRuleObject",
  "title": "GetAutoAttendantCallForwardSelectiveRuleObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "enabled",
    "businessSchedule",
    "forwardTo",
    "callsFrom",
    "callsTo"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WR1Z6ZENCU2RXeGw",
      "description": "Unique ID for the rule."
    },
    "name": {
      "type": "string",
      "example": "Test Rule",
      "description": "Unique name for the selective rule in the auto attendant."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Reflects if rule is enabled."
    },
    "businessSchedule": {
      "type": "string",
      "example": "AUTOATTENDANT-BUSINESS-HOURS",
      "description": "Name of the location's business schedule which determines when this selective call forwarding rule is in effect."
    },
    "holidaySchedule": {
      "type": "string",
      "example": "AUTOATTENDANT-HOLIDAY",
      "description": "Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect."
    },
    "forwardTo": {
      "$ref": "#/components/schemas/CallForwardSelectiveForwardToObject",
      "description": "Controls what happens when the rule matches including the destination number for the call forwarding."
    },
    "callsFrom": {
      "$ref": "#/components/schemas/CallForwardSelectiveCallsFromObject",
      "description": "Settings related to the rule matching based on incoming caller ID."
    },
    "callsTo": {
      "$ref": "#/components/schemas/CallForwardSelectiveCallsToObject",
      "description": "Settings related to the rule matching based on the destination number."
    }
  }
}