Webex · Schema

DECTHandsetItem

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier of the handset.
index string Index of the handset.
defaultDisplayName string Default display name for the handset.
customDisplayName string Custom display name on the handset.
accessCode string Access code is used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected.
primaryEnabled boolean Flags the handset as a primary line if `true`.
lines array Array of lines associated to the handset up to a maximum of 2.
View JSON Schema on GitHub

JSON Schema

webex-decthandsetitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DECTHandsetItem",
  "title": "DECTHandsetItem",
  "type": "object",
  "required": [
    "id",
    "index",
    "defaultDisplayName",
    "lines"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz",
      "description": "Unique identifier of the handset."
    },
    "index": {
      "type": "string",
      "example": "1",
      "description": "Index of the handset."
    },
    "defaultDisplayName": {
      "type": "string",
      "example": "Demo_Handset",
      "description": "Default display name for the handset."
    },
    "customDisplayName": {
      "type": "string",
      "example": "Demo_Handset",
      "description": "Custom display name on the handset."
    },
    "accessCode": {
      "type": "string",
      "example": "4788",
      "description": "Access code is used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected."
    },
    "primaryEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Flags the handset as a primary line if `true`."
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/lines"
      },
      "description": "Array of lines associated to the handset up to a maximum of 2."
    }
  }
}