Webex · Schema

VoiceMessageDetails

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	The message identifier of the voicemail message.
duration	number	The duration (in seconds) of the voicemail message. Duration is not present for a FAX message.
callingParty	object	The calling party's details. For example, if user A calls user B and leaves a voicemail message, then A is the calling party.
urgent	boolean	`true` if the voicemail message is urgent.
confidential	boolean	`true` if the voicemail message is confidential.
read	boolean	`true` if the voicemail message has been read.
faxPageCount	number	Number of pages for the FAX. Only set for a FAX.
created	string	The date and time the voicemail message was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoiceMessageDetails",
  "title": "VoiceMessageDetails",
  "type": "object",
  "required": [
    "id",
    "callingParty",
    "created"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx",
      "description": "The message identifier of the voicemail message."
    },
    "duration": {
      "type": "number",
      "example": 38,
      "description": " The duration (in seconds) of the voicemail message.  Duration is not present for a FAX message."
    },
    "callingParty": {
      "$ref": "#/components/schemas/VoiceMailPartyInformation",
      "description": "The calling party's details. For example, if user A calls user B and leaves a voicemail message, then A is the calling party."
    },
    "urgent": {
      "type": "boolean",
      "description": "`true` if the voicemail message is urgent."
    },
    "confidential": {
      "type": "boolean",
      "description": "`true` if the voicemail message is confidential."
    },
    "read": {
      "type": "boolean",
      "example": true,
      "description": "`true` if the voicemail message has been read."
    },
    "faxPageCount": {
      "type": "number",
      "example": 2,
      "description": "Number of pages for the FAX.  Only set for a FAX."
    },
    "created": {
      "type": "string",
      "example": "2021-11-14T17:00:00.000Z",
      "description": "The date and time the voicemail message was created."
    }
  }
}