Webex · Schema

UserCallRecordingGetResponseObject

Response object for the user call recording settings.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean Indicates whether Call Recording is enabled for the user or not.
vendor object List of available vendors and their details.
recordingMode object
pauseResumeNotifyMethod object
announcementEnabled boolean If `true`, an announcement is played when call recording starts.
warningToneEnabled boolean If `true`, a warning tone is played when call recording starts.
warningToneDuration number Duration of the warning tone in seconds. Duration can be configured between 10 and 1800 seconds.
View JSON Schema on GitHub

JSON Schema

webex-usercallrecordinggetresponseobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserCallRecordingGetResponseObject",
  "title": "UserCallRecordingGetResponseObject",
  "type": "object",
  "description": "Response object for the user call recording settings.",
  "example": {
    "enabled": true,
    "vendor": {
      "id": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk",
      "name": "ITFDual",
      "loginUrl": "https://www.itfdualportal.com"
    },
    "recordingMode": "On Demand",
    "pauseResumeNotifyMethod": "Beep",
    "announcementEnabled": true,
    "warningToneEnabled": false,
    "warningToneDuration": 70
  },
  "required": [
    "enabled",
    "vendor",
    "recordingMode"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether Call Recording is enabled for the user or not."
    },
    "vendor": {
      "type": "object",
      "description": "List of available vendors and their details.",
      "required": [
        "id",
        "name",
        "loginUrl"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk",
          "description": "Unique identifier of a vendor."
        },
        "name": {
          "type": "string",
          "example": "Dubber",
          "description": "Name of a call recording vendor."
        },
        "loginUrl": {
          "type": "string",
          "example": "https://wxc-us.dubber.net/login?sso=webex",
          "description": "Login URL of the vendor."
        }
      }
    },
    "recordingMode": {
      "$ref": "#/components/schemas/RecordingModeType"
    },
    "pauseResumeNotifyMethod": {
      "$ref": "#/components/schemas/PauseResumeNotifyMethodType"
    },
    "announcementEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, an announcement is played when call recording starts."
    },
    "warningToneEnabled": {
      "type": "boolean",
      "description": "If `true`, a warning tone is played when call recording starts."
    },
    "warningToneDuration": {
      "type": "number",
      "example": 70,
      "description": "Duration of the warning tone in seconds. Duration can be configured between 10 and 1800 seconds."
    }
  }
}