Webex · Schema

DeviceLayout

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
layoutMode object Defines the layout mode of the device, i.e. DEFAULT or CUSTOM.
userReorderEnabled boolean If `true`, user customization is enabled.
lineKeys array Contains a mapping of Line Keys and their corresponding actions.
kemModuleType object Type of KEM module.
kemKeys array Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN.
View JSON Schema on GitHub

JSON Schema

webex-devicelayout-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeviceLayout",
  "title": "DeviceLayout",
  "type": "object",
  "required": [
    "layoutMode",
    "lineKeys"
  ],
  "properties": {
    "layoutMode": {
      "$ref": "#/components/schemas/LayoutMode",
      "description": "Defines the layout mode of the device, i.e. DEFAULT or CUSTOM."
    },
    "userReorderEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, user customization is enabled."
    },
    "lineKeys": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProgrammableLineKeys"
      },
      "description": "Contains a mapping of Line Keys and their corresponding actions."
    },
    "kemModuleType": {
      "$ref": "#/components/schemas/KemModuleType",
      "description": "Type of KEM module."
    },
    "kemKeys": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/KEMKeys"
      },
      "description": "Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN."
    }
  }
}