Webex · Schema

ProgrammableLineKeys

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
lineKeyIndex number An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone.
lineKeyType object The action that would be performed when the Line Key is pressed.
lineKeyLabel string This is applicable only when the lineKeyType is `SPEED_DIAL`.
lineKeyValue string 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 number 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, enterin
View JSON Schema on GitHub

JSON Schema

webex-programmablelinekeys-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProgrammableLineKeys",
  "title": "ProgrammableLineKeys",
  "type": "object",
  "required": [
    "lineKeyIndex",
    "lineKeyType",
    "sharedLineIndex"
  ],
  "properties": {
    "lineKeyIndex": {
      "type": "number",
      "example": 2,
      "description": "An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone."
    },
    "lineKeyType": {
      "$ref": "#/components/schemas/LineKeyType",
      "description": "The action that would be performed when the Line Key is pressed."
    },
    "lineKeyLabel": {
      "type": "string",
      "example": "Help Line",
      "description": "This is applicable only when the lineKeyType is `SPEED_DIAL`."
    },
    "lineKeyValue": {
      "type": "string",
      "example": "5646",
      "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."
    }
  }
}