Webex · Schema

endpoints

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for the endpoint.
type object Enumeration that indicates if the endpoint is of type `DEVICE` or `APPLICATION`.
name string The `name` field in the response is calculated using device tag. Admins have the ability to set tags for devices. If a `name=` tag is set, for example “name=home phone“, then the `` is i
View JSON Schema on GitHub

JSON Schema

webex-endpoints-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/endpoints",
  "title": "endpoints",
  "type": "object",
  "required": [
    "id",
    "type",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29z...",
      "description": "Unique identifier for the endpoint."
    },
    "type": {
      "$ref": "#/components/schemas/DeviceType",
      "description": "Enumeration that indicates if the endpoint is of type `DEVICE` or `APPLICATION`."
    },
    "name": {
      "type": "string",
      "example": "Cisco 8865 (Phone in reception area)",
      "description": "The `name` field in the response is calculated using device tag. Admins have the ability to set tags for devices. If a `name=<value>` tag is set, for example \u201cname=home phone\u201c, then the `<value>` is included in the `name` field of the API response. In this example \u201chome phone\u201d."
    }
  }
}