Webex · Schema

CallHistoryRecord

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
type object The type of call history record.
name string The name of the called/calling party. Only present when the name is available and privacy is not enabled.
number string The number of the called/calling party. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`,
privacyEnabled boolean Indicates whether privacy is enabled for the name and number.
time string The date and time the call history record was created. For a placed call history record, this is when the call was placed. For a missed call history record, this is when the call was disconnected. For
View JSON Schema on GitHub

JSON Schema

webex-callhistoryrecord-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallHistoryRecord",
  "title": "CallHistoryRecord",
  "type": "object",
  "required": [
    "type",
    "privacyEnabled",
    "time"
  ],
  "properties": {
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CallHistoryRecordTypeEnum"
        }
      ],
      "description": "The type of call history record."
    },
    "name": {
      "type": "string",
      "example": "John Smith",
      "description": "The name of the called/calling party. Only present when the name is available and privacy is not enabled."
    },
    "number": {
      "type": "string",
      "example": "+12225554444",
      "description": "The number of the called/calling party. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`, `+12223334444`, `*73`, `[email protected]`"
    },
    "privacyEnabled": {
      "type": "boolean",
      "description": "Indicates whether privacy is enabled for the name and number."
    },
    "time": {
      "type": "string",
      "example": "2016-04-21T17:00:00.000Z",
      "description": "The date and time the call history record was created. For a placed call history record, this is when the call was placed. For a missed call history record, this is when the call was disconnected. For a received call history record, this is when the call was answered."
    }
  }
}