Webex · Schema

OutgoingCallingPlanPermissionsByType

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
configurationLevel object The level from which the configuration is applied.
callType string Designates the action to be taken for each call type and if transferring the call type is allowed. * `INTERNAL_CALL` - Controls calls within your own company. * `TOLL_FREE` - Controls calls to a telep
permission object Action to be performed on the input number that matches with the OCP.
transferNumber string The number to which the outgoing permission by type is to be transferred.
reason object The reason for the result reported for non-standard OCP service.
number string A transfer number is present in case it gets transferred to some other number.
View JSON Schema on GitHub

JSON Schema

webex-outgoingcallingplanpermissionsbytype-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OutgoingCallingPlanPermissionsByType",
  "title": "OutgoingCallingPlanPermissionsByType",
  "type": "object",
  "required": [
    "number"
  ],
  "properties": {
    "configurationLevel": {
      "$ref": "#/components/schemas/ConfigurationLevelType",
      "description": "The level from which the configuration is applied."
    },
    "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": "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the long-distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n"
    },
    "permission": {
      "$ref": "#/components/schemas/CallingPermissionAction",
      "description": "Action to be performed on the input number that matches with the OCP."
    },
    "transferNumber": {
      "type": "string",
      "example": "+14157279300",
      "description": "The number to which the outgoing permission by type is to be transferred."
    },
    "reason": {
      "$ref": "#/components/schemas/CallingPlanReason",
      "description": "The reason for the result reported for non-standard OCP service."
    },
    "number": {
      "type": "string",
      "example": "+14157279300",
      "description": "A transfer number is present in case it gets transferred to some other number."
    }
  }
}