KEMKeys

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KEMKeys",
  "title": "KEMKeys",
  "type": "object",
  "required": [
    "kemModuleIndex",
    "kemKeyIndex",
    "kemKeyType",
    "sharedLineIndex"
  ],
  "properties": {
    "kemModuleIndex": {
      "type": "number",
      "example": 1,
      "description": "An index representing a KEM Module. The Index starts from 1 representing the first KEM Module."
    },
    "kemKeyIndex": {
      "type": "number",
      "example": 1,
      "description": "An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone."
    },
    "kemKeyType": {
      "$ref": "#/components/schemas/LineKeyType",
      "description": "The action that would be performed when the KEM Key is pressed."
    },
    "kemKeyLabel": {
      "type": "string",
      "example": "Office",
      "description": "Applicable only when the kemKeyType is `SPEED_DIAL`."
    },
    "kemKeyValue": {
      "type": "string",
      "example": "213457",
      "description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
    },
    "sharedLineIndex": {
      "type": "number",
      "example": 4,
      "description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
    }
  }
}