Webex · Schema

GetThirdPartyDeviceObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
manufacturer string Manufacturer of the device.
managedBy string Device manager(s).
id string A unique identifier for the device.
ip string The current IP address of the device.
mac string The unique address for the network adapter.
model string A model type of the device.
activationState object Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex.
description array Comma-separated array of tags used to describe the device.
upgradeChannelEnabled boolean Enabled / disabled status of the upgrade channel.
owner object
proxy object
View JSON Schema on GitHub

JSON Schema

webex-getthirdpartydeviceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetThirdPartyDeviceObject",
  "title": "GetThirdPartyDeviceObject",
  "type": "object",
  "required": [
    "manufacturer",
    "managedBy",
    "id",
    "ip",
    "model",
    "upgradeChannelEnabled"
  ],
  "properties": {
    "manufacturer": {
      "type": "string",
      "example": "THIRD_PARTY",
      "description": "Manufacturer of the device."
    },
    "managedBy": {
      "type": "string",
      "example": "CUSTOMER",
      "description": "Device manager(s)."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
      "description": "A unique identifier for the device."
    },
    "ip": {
      "type": "string",
      "example": "100.110.120.130",
      "description": "The current IP address of the device."
    },
    "mac": {
      "type": "string",
      "example": "11223344AAFF",
      "description": "The unique address for the network adapter."
    },
    "model": {
      "type": "string",
      "example": "DMS Cisco 8811",
      "description": "A model type of the device."
    },
    "activationState": {
      "$ref": "#/components/schemas/ActivationStates",
      "description": "Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex."
    },
    "description": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "device description"
      },
      "description": "Comma-separated array of tags used to describe the device."
    },
    "upgradeChannelEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enabled / disabled status of the upgrade channel."
    },
    "owner": {
      "type": "object",
      "required": [
        "sipUserName"
      ],
      "properties": {
        "sipUserName": {
          "type": "string",
          "example": "392829",
          "description": "SIP authentication user name for the owner of the device."
        },
        "linePort": {
          "type": "string",
          "example": "[email protected]",
          "description": "Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode."
        }
      }
    },
    "proxy": {
      "type": "object",
      "properties": {
        "outboundProxy": {
          "type": "string",
          "example": "hs17.hosted-int.bcld.webex.com",
          "description": "Outgoing server which the phone should use for all SIP requests. Not set if the response has no body."
        }
      }
    }
  }
}