Webex · Schema

AudioFileInfoDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. It is required to define for the following operations - 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.
description	string	A short description of the dial plan.
systemDefault	boolean	Indicates whether the created resource is system created or not
audioFile	string
createdTime	integer	Creation time(in epoch millis) of this resource.
lastUpdatedTime	integer	Time(in epoch millis) when this resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AudioFileInfoDTO",
  "title": "AudioFileInfoDTO",
  "required": [
    "contentType",
    "name"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "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}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "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",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "name": {
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._\\-\\s]*$",
      "type": "string",
      "description": "A name for the Agent's personal greeting file. It should have valid extension i.e. .wav ",
      "example": "WelcomeMessage.wav"
    },
    "contentType": {
      "type": "string",
      "description": "Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV",
      "example": "AUDIO_WAV",
      "enum": [
        "AUDIO_WAV",
        "TEXT_HTML",
        "TEXT_PHP",
        "AUDIO_X_WAV",
        "APPLICATION_OCTET_STREAM"
      ]
    },
    "blobId": {
      "type": "string",
      "description": "Identifier for the audio file.",
      "example": "audio-file_a7c700d5-2fac-4a6c-9a16-eb2f2b42d7a8"
    },
    "url": {
      "type": "string",
      "description": "Audio file download url.",
      "format": "url",
      "example": "https://cjp-ccone-devus1-ivr-media.s3.amazonaws.com/bde75a64-f4d5-4ffc-a239-feb607c17ef8/"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A short description of the dial plan.",
      "example": "Required for transferring calls to Queues"
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "audioFile": {
      "type": "string",
      "format": "binary"
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  }
}