Webex · Schema

ApplicationPutSharedLineMemberItem

Member to be added or modified for shared-line assignment to a Webex Calling Apps.

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.
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 Indicates 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.
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

webex-applicationputsharedlinememberitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApplicationPutSharedLineMemberItem",
  "title": "ApplicationPutSharedLineMemberItem",
  "type": "object",
  "required": [
    "id",
    "port",
    "primaryOwner",
    "lineType",
    "lineWeight"
  ],
  "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."
    },
    "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": "Indicates 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."
    },
    "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."
    }
  },
  "description": "Member to be added or modified for shared-line assignment to a Webex Calling Apps."
}