Webex · Schema

RecordingAttributes

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
fileName string The file name of the recording.
filePath string Capture download url.
startTime integer Begin time of capture(epoch timestamp)
stopTime integer End time of capture(epoch timestamp).
participants array Comma separated list of CI user Id (UUID) of agents, masked customer contact email/phone details and virtual agent id if any involved in the recording.
channel1 string Caller - channel contains caller audio only, Agent - channel contains agent audio only for main call and its segments, VA - channel contains virtual agent audio only.
channel2 string Agent if callType is consult. For main callType, Agent/Caller/VA/Others based on number of participants.
callType string main if recording belongs to main call; consult if recording belongs to consult call; va-main if recording belongs to virtual agent in main call; va-consult if recording belongs to virtual agent in co
sensitive boolean Applicable only to virtual agent recordings. Flag; (true) indicates the virtual agent recording may contain sensitive information, (false) otherwise.
View JSON Schema on GitHub

JSON Schema

webex-recordingattributes-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RecordingAttributes",
  "title": "RecordingAttributes",
  "type": "object",
  "properties": {
    "fileName": {
      "type": "string",
      "description": "The file name of the recording.",
      "example": "recording-1.wav"
    },
    "filePath": {
      "type": "string",
      "description": "Capture download url.",
      "example": "https://cjp-ccone-devus1-media-storage-recording.s3.amazonaws.com/9e4895c9-787b-4615-b15f-f1b3b12c3091/"
    },
    "startTime": {
      "type": "integer",
      "description": "Begin time of capture(epoch timestamp)",
      "format": "int64",
      "example": 1617373126000
    },
    "stopTime": {
      "type": "integer",
      "description": "End time of capture(epoch timestamp).",
      "format": "int64",
      "example": 1627373126000
    },
    "participants": {
      "type": "array",
      "description": "Comma separated list of CI user Id (UUID) of agents, masked customer contact email/phone details and virtual agent id if any involved in the recording.",
      "example": [
        "e890a591-63f0-4984-a8f2-00e631368fb4",
        "+121****1219"
      ],
      "items": {
        "type": "string"
      }
    },
    "channel1": {
      "type": "string",
      "description": "Caller - channel contains caller audio only, Agent - channel contains agent audio only for main call and its segments, VA - channel contains virtual agent audio only.",
      "example": "Caller|Agent|VA"
    },
    "channel2": {
      "type": "string",
      "description": "Agent if callType is consult. For main callType, Agent/Caller/VA/Others based on number of participants.",
      "example": "Caller|Agent|VA|Others"
    },
    "callType": {
      "type": "string",
      "description": "main if recording belongs to main call; consult if recording belongs to consult call; va-main if recording belongs to virtual agent in main call; va-consult if recording belongs to virtual agent in consult call.",
      "example": "main|consult|va-main|va-consult"
    },
    "sensitive": {
      "type": "boolean",
      "description": "Applicable only to virtual agent recordings. Flag; (true) indicates the virtual agent recording may contain sensitive information, (false) otherwise.",
      "example": true
    }
  }
}