Webex · Schema

Endpoint

Details of an endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier of the endpoint.
type	object
name	string	Display 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.
mobilitySettings	object	Mobility settings of the endpoint.
host	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Endpoint",
  "title": "Endpoint",
  "type": "object",
  "description": "Details of an endpoint associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM=",
    "type": "CALLING_DEVICE",
    "name": "Webex Go Device",
    "autoAndForcedAnswerEnabled": false,
    "ownerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM",
    "ownerType": "PEOPLE",
    "mobilitySettings": {
      "phoneNumber": "+13374831660",
      "alertingEnabled": false
    }
  },
  "required": [
    "id",
    "type",
    "name",
    "autoAndForcedAnswerEnabled",
    "ownerId",
    "ownerType"
  ],
  "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": "Display 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."
    },
    "mobilitySettings": {
      "type": "object",
      "required": [
        "phoneNumber",
        "alertingEnabled"
      ],
      "properties": {
        "phoneNumber": {
          "type": "string",
          "example": "+13374831660",
          "description": "Phone number of the mobile device endpoint."
        },
        "alertingEnabled": {
          "type": "boolean",
          "description": "If `true`, alerting is enabled for the endpoint."
        }
      },
      "description": "Mobility settings of the endpoint."
    },
    "host": {
      "$ref": "#/components/schemas/HostObject"
    }
  }
}