Webex · Schema

HostObject

`HOTDESKING_GUEST` endpoints include the `host` element when the user has an active hotdesking session on a host.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier of the endpoint.
type object
name string Name of the endpoint.
autoAndForcedAnswerEnabled boolean If `true`, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer.
ownerId string Unique identifier of the endpoint owner.
ownerType object
secondaryLines array List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user.
View JSON Schema on GitHub

JSON Schema

webex-hostobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HostObject",
  "title": "HostObject",
  "type": "object",
  "description": "`HOTDESKING_GUEST` endpoints include the `host` element when the user has an active hotdesking session on a host.",
  "required": [
    "id",
    "type",
    "name",
    "autoAndForcedAnswerEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM",
      "description": "Unique identifier of the endpoint."
    },
    "type": {
      "$ref": "#/components/schemas/EndpointType"
    },
    "name": {
      "type": "string",
      "example": "Webex Go Device",
      "description": "Name of the endpoint."
    },
    "autoAndForcedAnswerEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer."
    },
    "ownerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM",
      "description": "Unique identifier of the endpoint owner."
    },
    "ownerType": {
      "$ref": "#/components/schemas/MemberType"
    },
    "secondaryLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SecondaryLine"
      },
      "description": "List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user."
    }
  }
}