Webex · Schema

AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose

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.
name	string	A name for the Agent's personal greeting file. It should have valid extension i.e. .wav
contentType	string	Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV
blobId	string	Identifier for the audio file.
url	string	Audio file download url.
agentId	string	Agent Id with which this greeting file is to be associated with.
firstName	string	First Name of the Agent with whom this greeting file is to be associated with.
lastName	string	Last Name of the Agent with whom this greeting file is to be associated with.
email	string	Email of the Agent with whom this greeting file is to be associated with.
agentActive	boolean	Indicates whether the Agent with whom this greeting file is to be associated with is active or not active
ciUserId	string	Id of the Agent in common identity with whom this greeting file is to be associated with.
greetingPurposeId	string	Id of the greeting purpose
greetingPurposeName	string	Name of the greeting purpose
audioFile	string
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/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose",
  "title": "AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose",
  "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
    },
    "name": {
      "type": "string",
      "description": "A name for the Agent's personal greeting file. It should have valid extension i.e. .wav ",
      "example": "WelcomeMessage.wav",
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._\\-\\s]*$"
    },
    "contentType": {
      "type": "string",
      "description": "Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV",
      "enum": [
        "AUDIO_WAV",
        "TEXT_HTML",
        "TEXT_PHP",
        "AUDIO_X_WAV",
        "APPLICATION_OCTET_STREAM"
      ],
      "example": "AUDIO_WAV"
    },
    "blobId": {
      "type": "string",
      "description": "Identifier for the audio file.",
      "example": "audio-file_a7c700d5-2fac-4a6c-9a16-eb2f2b42d7a8"
    },
    "url": {
      "type": "string",
      "format": "url",
      "description": "Audio file download url.",
      "example": "https://cjp-ccone-devus1-ivr-media.s3.amazonaws.com/bde75a64-f4d5-4ffc-a239-feb607c17ef8/"
    },
    "agentId": {
      "type": "string",
      "description": "Agent Id with which this greeting file is to be associated with.",
      "example": "955fe2b9-ba25-4de9-92b0-6cb055d5b432",
      "minLength": 1
    },
    "firstName": {
      "type": "string",
      "description": "First Name of the Agent with whom this greeting file is to be associated with.",
      "example": "John"
    },
    "lastName": {
      "type": "string",
      "description": "Last Name of the Agent with whom this greeting file is to be associated with.",
      "example": "Doe"
    },
    "email": {
      "type": "string",
      "description": "Email of the Agent with whom this greeting file is to be associated with.",
      "example": "[email protected]"
    },
    "agentActive": {
      "type": "boolean",
      "description": "Indicates whether the Agent with whom this greeting file is to be associated with is active or not active",
      "example": true
    },
    "ciUserId": {
      "type": "string",
      "description": "Id of the Agent in common identity with whom this greeting file is to be associated with.",
      "example": "c71876ae-ddfa-4049-9a1b-298535152578"
    },
    "greetingPurposeId": {
      "type": "string",
      "description": "Id of the greeting purpose",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "greetingPurposeName": {
      "type": "string",
      "description": "Name of the greeting purpose",
      "example": "en"
    },
    "audioFile": {
      "type": "string",
      "format": "binary"
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity."
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity."
    }
  },
  "required": [
    "agentId",
    "contentType",
    "name"
  ]
}