Webex · Schema

GeneratedSummariesDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. This field is required for all bulk save operations.
id	string	ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version	integer	The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
callDropSummariesEnabled	boolean	Used to toggle the enable/disable call drop summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a va
virtualAgentTransferSummariesEnabled	boolean	Used to toggle the enable/disable virtual agent transfer summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer shoul
consultTransferSummariesEnabled	boolean	Used to toggle the enable/disable mid call consult/transfer summaries in Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer sho
agentInclusionType	string	Provides information whether all or specific agents are selected for generated summaries.
createdTime	integer	This is the created time of the entity.
lastUpdatedTime	integer	This is the updated time of the entity.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GeneratedSummariesDTO",
  "title": "GeneratedSummariesDTO",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "callDropSummariesEnabled": {
      "type": "boolean",
      "description": "Used to toggle the enable/disable call drop summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false.",
      "example": true
    },
    "virtualAgentTransferSummariesEnabled": {
      "type": "boolean",
      "description": "Used to toggle the enable/disable virtual agent transfer summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false.",
      "example": true
    },
    "consultTransferSummariesEnabled": {
      "type": "boolean",
      "description": "Used to toggle the enable/disable mid call consult/transfer summaries in Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false.",
      "example": true
    },
    "agentInclusionType": {
      "type": "string",
      "description": "Provides information whether all or specific agents are selected for generated summaries.",
      "enum": [
        "ALL",
        "SPECIFIC"
      ],
      "example": "ALL"
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity.",
      "example": 123456789
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity.",
      "example": 123456789
    }
  }
}