Webex · Schema

PutSharedLineMemberItem

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the person or workspace.
port	number	Device port number assigned to person or workspace.
t38FaxCompressionEnabled `true`	boolean	T.38 Fax Compression setting. Valid only for ATA Devices. Overrides user level compression options.
primaryOwner	string	If `true` the person or the workspace is the owner of the device. Points to primary line/port of the device.
lineType	object	If the line is acting as a primary line or a shared line for this device.
lineWeight	number	Number of lines that have been configured for the person on the device.
hotlineEnabled	boolean	Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in `hotlineDestination`.
hotlineDestination	string	Preconfigured number for the hotline. Required only if `hotlineEnabled` is set to `true`.
allowCallDeclineEnabled	boolean	Set how a device behaves when a call is declined. When set to `true`, a call decline request is extended to all the endpoints on the device. When set to `false`, a call decline request is only decline
lineLabel	string	Device line label.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutSharedLineMemberItem",
  "title": "PutSharedLineMemberItem",
  "type": "object",
  "required": [
    "id",
    "port",
    "primaryOwner",
    "lineType",
    "lineWeight",
    "hotlineEnabled",
    "hotlineDestination",
    "allowCallDeclineEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE",
      "description": "Unique identifier for the person or workspace."
    },
    "port": {
      "type": "number",
      "example": 1,
      "description": "Device port number assigned to person or workspace."
    },
    "t38FaxCompressionEnabled `true`": {
      "type": "boolean",
      "description": "T.38 Fax Compression setting. Valid only for ATA Devices. Overrides user level compression options."
    },
    "primaryOwner": {
      "type": "string",
      "example": "true",
      "description": "If `true` the person or the workspace is the owner of the device. Points to primary line/port of the device."
    },
    "lineType": {
      "$ref": "#/components/schemas/LineType",
      "description": "If the line is acting as a primary line or a shared line for this device."
    },
    "lineWeight": {
      "type": "number",
      "minimum": 1,
      "example": 1,
      "description": "Number of lines that have been configured for the person on the device."
    },
    "hotlineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in `hotlineDestination`."
    },
    "hotlineDestination": {
      "type": "string",
      "example": "1234",
      "description": "Preconfigured number for the hotline. Required only if `hotlineEnabled` is set to `true`."
    },
    "allowCallDeclineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Set how a device behaves when a call is declined. When set to `true`, a call decline request is extended to all the endpoints on the device. When set to `false`, a call decline request is only declined at the current endpoint."
    },
    "lineLabel": {
      "type": "string",
      "example": "share line label",
      "description": "Device line label."
    }
  }
}