Webex · Schema

PersonalAssistantSettings

Personal assistant settings for a person.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
enabled	boolean	Enable/Disable the personal assistant feature.
presence	string	Presence status that triggers the personal assistant.
untilDateTime	string	Date and time until which the personal assistant is active (ISO 8601 format).
transferEnabled	boolean	Enable/Disable call transfer when personal assistant is active.
transferNumber	string	Phone number to transfer calls to when transfer is enabled.
alerting	string	Alerting behavior for incoming calls when personal assistant is active. Possible values: ALERT_ME_FIRST - Ring the user's phone first before the personal assistant takes over. PLAY_RING_REMINDER - Pla
alertMeFirstNumberOfRings	integer	Number of rings before transferring the call when alerting is set to ALERT_ME_FIRST.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonalAssistantSettings",
  "title": "PersonalAssistantSettings",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/Disable the personal assistant feature."
    },
    "presence": {
      "type": "string",
      "enum": [
        "BUSINESS_TRIP",
        "GONE_FOR_THE_DAY",
        "LUNCH",
        "MEETING",
        "OUT_OF_OFFICE",
        "TEMPORARILY_OUT",
        "TRAINING",
        "UNAVAILABLE",
        "VACATION"
      ],
      "example": "OUT_OF_OFFICE",
      "description": "Presence status that triggers the personal assistant."
    },
    "untilDateTime": {
      "type": "string",
      "format": "date-time",
      "example": "2026-03-28T14:30:00Z",
      "description": "Date and time until which the personal assistant is active (ISO 8601 format)."
    },
    "transferEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/Disable call transfer when personal assistant is active."
    },
    "transferNumber": {
      "type": "string",
      "example": "+14126525012",
      "description": "Phone number to transfer calls to when transfer is enabled."
    },
    "alerting": {
      "type": "string",
      "enum": [
        "ALERT_ME_FIRST",
        "PLAY_RING_REMINDER",
        "NONE"
      ],
      "example": "ALERT_ME_FIRST",
      "description": "Alerting behavior for incoming calls when personal assistant is active. Possible values: ALERT_ME_FIRST - Ring the user's phone first before the personal assistant takes over. PLAY_RING_REMINDER - Play a ring reminder to the user. NONE - No alerting."
    },
    "alertMeFirstNumberOfRings": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "example": 3,
      "description": "Number of rings before transferring the call when alerting is set to ALERT_ME_FIRST."
    }
  },
  "description": "Personal assistant settings for a person.",
  "example": {
    "enabled": true,
    "presence": "OUT_OF_OFFICE",
    "untilDateTime": "2026-03-28T14:30:00Z",
    "transferEnabled": true,
    "transferNumber": "+14126525012",
    "alerting": "ALERT_ME_FIRST",
    "alertMeFirstNumberOfRings": 3
  }
}