Webex · Schema

CallForwardRulesObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique ID for the rule.
name string Unique name of rule.
callsFrom string Comma-separated list of incoming call numbers that, when matched, will not be forwarded. A Limit of 12 numbers is allowed. Use `Any private Number` in the comma-separated value to indicate rules that
callsTo string Comma-separated list of the types of numbers being matched for incoming call destination.
forwardTo string Number to which calls will be forwarded if the rule is of type "Forward To" and the incoming call is matched.
enabled boolean Reflects if rule is enabled.
View JSON Schema on GitHub

JSON Schema

webex-callforwardrulesobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallForwardRulesObject",
  "title": "CallForwardRulesObject",
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WR1Z6ZENCU2RXeGw",
      "description": "Unique ID for the rule."
    },
    "name": {
      "type": "string",
      "example": "Test Rule",
      "description": "Unique name of rule."
    },
    "callsFrom": {
      "type": "string",
      "example": "Any private number",
      "description": "Comma-separated list of incoming call numbers that, when matched, will not be forwarded. A Limit of 12 numbers is allowed. Use `Any private Number` in the comma-separated value to indicate rules that match incoming calls from a private number. Use `Any unavailable number` in the comma-separated value to match incoming calls from an unavailable number."
    },
    "callsTo": {
      "type": "string",
      "example": "+19705550006",
      "description": "Comma-separated list of the types of numbers being matched for incoming call destination."
    },
    "forwardTo": {
      "type": "string",
      "example": "+19705550026",
      "description": "Number to which calls will be forwarded if the rule is of type \"Forward To\" and the incoming call is matched."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Reflects if rule is enabled."
    }
  }
}