Webex · Schema

PersonalAssistantPatch

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
enabled	boolean	Toggles feature.
presence	string	Person's availability. * `NONE` - User is available. * `BUSINESS_TRIP` - User is gone for a business trip. * `GONE_FOR_THE_DAY` - User is gone for the day. * `LUNCH` - User is gone for lunch. * `MEETI
untilDateTime	string	The date until which the personal assistant is active.
transferEnabled	boolean	If `true`, allows transfer and forwarding for the call type.
transferNumber	string	Number to transfer to.
alerting	string	Alert type. * `ALERT_ME_FIRST` - Ring the recipient first. * `PLAY_RING_REMINDER` - Ring reminder for the recipient. * `NONE` - No alert.
alertMeFirstNumberOfRings	number	Number of rings for alert type: ALERT_ME_FIRST; available range is 2-20.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonalAssistantPatch",
  "title": "PersonalAssistantPatch",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Toggles feature."
    },
    "presence": {
      "type": "string",
      "enum": [
        "NONE",
        "BUSINESS_TRIP",
        "GONE_FOR_THE_DAY",
        "LUNCH",
        "MEETING",
        "OUT_OF_OFFICE",
        "TEMPORARILY_OUT",
        "TRAINING",
        "UNAVAILABLE",
        "VACATION"
      ],
      "description": "Person's availability.\n * `NONE` - User is available.\n * `BUSINESS_TRIP` - User is gone for a business trip.\n * `GONE_FOR_THE_DAY` - User is gone for the day.\n * `LUNCH` - User is gone for lunch.\n * `MEETING` - User is gone for a meeting.\n * `OUT_OF_OFFICE` - User is out of office.\n * `TEMPORARILY_OUT` - User is temporarily out.\n * `TRAINING` - User is gone for training.\n * `UNAVAILABLE` - User is unavailable.\n * `VACATION` - User is gone for vacation.\n"
    },
    "untilDateTime": {
      "type": "string",
      "example": "2022-08-24T06:18:31.092Z",
      "description": "The date until which the personal assistant is active."
    },
    "transferEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, allows transfer and forwarding for the call type."
    },
    "transferNumber": {
      "type": "string",
      "example": "+14126525012",
      "description": "Number to transfer to."
    },
    "alerting": {
      "type": "string",
      "enum": [
        "ALERT_ME_FIRST",
        "PLAY_RING_REMINDER",
        "NONE"
      ],
      "description": "Alert type.\n * `ALERT_ME_FIRST` - Ring the recipient first.\n * `PLAY_RING_REMINDER` - Ring reminder for the recipient.\n * `NONE` - No alert.\n"
    },
    "alertMeFirstNumberOfRings": {
      "type": "number",
      "example": 3,
      "description": "Number of rings for alert type: ALERT_ME_FIRST; available range is 2-20."
    }
  }
}