Webex · Schema

GetLineKeyTemplateResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the Line Key Template.
templateName	string	Name of the Line Key Template.
deviceModel	string	The Device Model for which the Line Key Template is applicable.
modelDisplayName	string	The friendly display name used to represent the device model in Control Hub.
userReorderEnabled	boolean	Indicates whether user can reorder the line keys.
lineKeys	array	Contains a mapping of Line Keys and their corresponding actions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetLineKeyTemplateResponse",
  "title": "GetLineKeyTemplateResponse",
  "type": "object",
  "required": [
    "id",
    "templateName",
    "deviceModel",
    "modelDisplayName",
    "userReorderEnabled",
    "lineKeys"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ",
      "description": "Unique identifier for the Line Key Template."
    },
    "templateName": {
      "type": "string",
      "example": "Basic Template",
      "description": "Name of the Line Key Template."
    },
    "deviceModel": {
      "type": "string",
      "example": "'DMS Cisco 6821'",
      "description": "The Device Model for which the Line Key Template is applicable."
    },
    "modelDisplayName": {
      "type": "string",
      "example": "Cisco 6821",
      "description": "The friendly display name used to represent the device model in Control Hub."
    },
    "userReorderEnabled": {
      "type": "boolean",
      "description": "Indicates whether user can reorder the line keys."
    },
    "lineKeys": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProgrammableLineKeys"
      },
      "description": "Contains a mapping of Line Keys and their corresponding actions."
    }
  }
}