Webex · Schema

CallingPermission

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
callType string Type of the outgoing call. * `INTERNAL_CALL` - Internal call type. * `TOLL_FREE` - Toll free call type. * `INTERNATIONAL` - International call type. * `OPERATOR_ASSISTED` - Operator Assisted call type
action string Permission for call types. * `ALLOW` - The call type is allowed. * `BLOCK` - The call type is blocked. * `AUTH_CODE` - Access Code action for the specified call type. * `TRANSFER_NUMBER_1` - Transfer
transferEnabled boolean If `true`, allows transfer and forwarding for the call type.
isCallTypeRestrictionEnabled boolean Indicates if the restriction is enforced by the system for the corresponding call type and cannot be changed. For example, certain call types (such as `INTERNATIONAL`) may be permanently blocked and t
View JSON Schema on GitHub

JSON Schema

webex-callingpermission-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallingPermission",
  "title": "CallingPermission",
  "type": "object",
  "required": [
    "callType",
    "action",
    "transferEnabled",
    "isCallTypeRestrictionEnabled"
  ],
  "properties": {
    "callType": {
      "type": "string",
      "enum": [
        "INTERNAL_CALL",
        "TOLL_FREE",
        "INTERNATIONAL",
        "OPERATOR_ASSISTED",
        "CHARGEABLE_DIRECTORY_ASSISTED",
        "SPECIAL_SERVICES_I",
        "SPECIAL_SERVICES_II",
        "PREMIUM_SERVICES_I",
        "PREMIUM_SERVICES_II",
        "NATIONAL"
      ],
      "description": "Type of the outgoing call.\n * `INTERNAL_CALL` - Internal call type.\n * `TOLL_FREE` - Toll free call type.\n * `INTERNATIONAL` - International call type.\n * `OPERATOR_ASSISTED` - Operator Assisted call type.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Chargeable Directory Assisted call type.\n * `SPECIAL_SERVICES_I` - Special Services I call type.\n * `SPECIAL_SERVICES_II` - Special Services II call type.\n * `PREMIUM_SERVICES_I` - Premium Services I call type.\n * `PREMIUM_SERVICES_II` - Premium Services II call type.\n * `NATIONAL` - National call type.\n"
    },
    "action": {
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK",
        "AUTH_CODE",
        "TRANSFER_NUMBER_1",
        "TRANSFER_NUMBER_2",
        "TRANSFER_NUMBER_3"
      ],
      "description": "Permission for call types.\n * `ALLOW` - The call type is allowed.\n * `BLOCK` - The call type is blocked.\n * `AUTH_CODE` - Access Code action for the specified call type.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n"
    },
    "transferEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, allows transfer and forwarding for the call type."
    },
    "isCallTypeRestrictionEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates if the restriction is enforced by the system for the corresponding call type and cannot be changed. For example, certain call types (such as `INTERNATIONAL`) may be permanently blocked and this field will be `true` to reflect that the restriction is system-controlled and not editable."
    }
  }
}