Skip to main content

Lens Data Dictionary

Last updated on September 10, 2025 at 15:45 UTC

ActivityStateEvents.enterView

Represents an event that signals the entry of an Android activity or view within the system.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.Category TypeSTRINGIdentifies the category type of an event or activity.
payload.value.eventData.Session nameSTRINGIdentifies the name of the session in activity state events.
payload.value.eventData.View nameSTRINGIdentifies the name of the view
payload.value.eventData.categoryTypeSTRINGIdentifies the category type of an event or error occurrence in the system or application.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.sessionNameSTRINGIdentifies the session name associated with ActivityState events.
payload.value.eventData.viewNameSTRINGIdentifies the name of the current view or application being used in ActivityState events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

ActivityStateEvents.exitView

Represents an event that signals the exit of an Android activity or view within the system.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.viewNameSTRINGIdentifies the name of the current view or application being used in ActivityState events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

ActivityStateEvents.trackClick

Tracks the click events

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.Category TypeSTRINGIdentifies the category type of an event or activity.
payload.value.eventData.IDSTRINGIdentifies the specific UI element that triggered an event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

ActivityStateEvents.trackCrash

Represents an event that reports a system crash occurrence.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.categoryTypeSTRINGIdentifies the category type of an event or error occurrence in the system or application.
payload.value.eventData.crashDetailsSTRINGContains detailed information about application crashes and system errors.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.viewNameSTRINGIdentifies the name of the current view or application being used in ActivityState events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

appClose

Sends details of the app that has been exited

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.appNameSTRINGIdentifies the application name during start and close events.
payload.data.closeReasonSTRINGIndicates the reason for application closure.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.lastUpdatedOnSTRINGStores the timestamp of the last update for various application events.
payload.data.packageNameSTRINGIdentifies the package name of the application being started or closed.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionCodeNUMBERIndicates the version code of the application during start and close events.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

appsInfo

Event that logs application-level monitoring of app health, user interactions, and provisioning behaviors across connected devices.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.AppsOBJECT[]See payload.data.Apps[] definition
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.providerSTRINGIdentifies the provider of the payload data in various communication applications.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

appsInfo: payload.data.Apps[]

Field NameData TypeDescription
appNameSTRINGIdentifies the name of an application in the system.
isEnabledBOOLEANIndicates whether an application is enabled or disabled.
isPrimaryBOOLEANIndicates whether an application is the primary one.
PackagesOBJECT[]See payload.data.Apps[].Packages[] definition

appsInfo: payload.data.Apps[].Packages[]

Field NameData TypeDescription
lastUpdatedOnSTRINGStores the last update timestamp for application packages.
packageNameSTRINGIdentifies the package name of an installed application.
versionCodeNUMBERStores the version code of installed application packages.
versionInfoSTRINGSpecifies the version information of installed application packages.

appStart

Initialization of the device's primary application environment following a boot sequence, firmware update, or provisioning cycle.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.activityNameSTRINGIdentifies the name of the activity being launched when an application starts.
payload.data.appNameSTRINGIdentifies the application name during start and close events.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.intentNameSTRINGIdentifies the intent name associated with an application start event.
payload.data.lastUpdatedOnSTRINGStores the timestamp of the last update for various application events.
payload.data.packageNameSTRINGIdentifies the package name of the application being started or closed.
payload.data.startReasonSTRINGIndicates the reason for starting an application.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionCodeNUMBERIndicates the version code of the application during start and close events.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

BLF_SCA

Represents a Busy Lamp Field or Shared Call Appearance configuration

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.BLF.AttendantSTRINGIdentifies the attendant's SIP address in BLF events.
payload.data.BLF.configuredBlfCountSTRINGIndicates the total number of configured BLF entries.
payload.data.BLF.detailsOBJECT[]See payload.data.BLF.details[] definition
payload.data.BLF.droppedNotificationCountSTRINGIndicates the number of dropped notifications for a specific event.
payload.data.BLF.eventMonotonicTimeSTRINGRepresents the event monotonic time in a specific format for various system events.
payload.data.SCA.configuredSCACountSTRINGIndicates the number of configured secondary call appearances.
payload.data.SCA.detailsOBJECT[]See payload.data.SCA.details[] definition
payload.data.SCA.eventMonotonicTimeSTRINGRepresents the event monotonic time in a specific format for SCA events.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

BLF_SCA: payload.data.BLF.details[]

Field NameData TypeDescription
actionCountSTRINGIndicates the number of actions performed in a specific event.
notifyCountSTRINGIndicates the number of notifications for a specific event.
userSTRINGIdentifies the user associated with a specific session or call detail record.

BLF_SCA: payload.data.SCA.details[]

Field NameData TypeDescription
actionCountSTRINGRepresents the number of actions performed in a specific SCA details instance.
notifyCountSTRINGIndicates the number of notifications for a specific event.
registeredSTRINGIndicates whether a supplementary service is registered or not.
userSTRINGIdentifies the user associated with a specific SCA event detail.

callConnect

Event that initiates a conference call (merge a held call with an active call)

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.callDirectionSTRINGIndicates the direction of a call.
payload.data.callIdSTRINGIdentifies a unique call identifier for various telecommunication events.
payload.data.callSpeedSTRINGIndicates the call speed during a call connection event.
payload.data.callStatusSTRINGIndicates the current status of a phone call.
payload.data.protocolTypeSTRINGIdentifies the protocol used for communication during a call.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

cdr

Contains a Call Detail Record (CDR) of a call.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.callDirectionSTRINGIndicates the direction of a call.
payload.data.callDurationSTRINGIndicates the duration of a call in seconds.
payload.data.callIdSTRINGIdentifies a unique call identifier for various telecommunication events.
payload.data.callRateSTRINGSpecifies the rate of the call in the call details record.
payload.data.disconnectInfoSTRINGIndicates the reason for a call disconnect in a call details record.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.localTagSTRINGIdentifies a unique local tag for various call events and records.
payload.data.protocolTypeSTRINGIdentifies the protocol used for communication during a call.
payload.data.remotePartySTRINGIdentifies the remote party's phone number or name in a call details record.
payload.data.remoteTagSTRINGIdentifies a unique remote tag for various network events and records.
payload.data.startTimeSTRINGRepresents the start time of an event in ISO 8601 format.
payload.data.transferredToSTRINGIdentifies the target of a call transfer operation in a call details record.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.userSTRINGContains the user's phone number or identifier in various formats.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.extSTRINGContains additional call detail information in JSON format.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
payload.userSTRINGIdentifies the user associated with a call details record event.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

com.poly.lens.command.c10

Device capabilities indication.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payloadSTRINGContains device settings for a USB policy.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceEvent.deviceAttachment

Tracks devices connection and disconnection

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.attachmentStateNUMBERIndicates whether the device is attached.
payload.value.eventData.displayNameSTRINGIdentifies the display name of a device or attached peripheral.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceEvent.deviceHealthInfo

Contains general information about the health of the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.bluetoothConnectedBOOLEANIndicates whether a Bluetooth connection is currently established.
payload.value.eventData.cpu1CoreCelsiusTempNUMBERReports the temperature of the first CPU core in degrees Celsius.
payload.value.eventData.cpu2CoreCelsiusTempNUMBERReports the temperature of the second CPU core in degrees Celsius.
payload.value.eventData.cpuLevelNUMBERIndicates the current CPU usage level of a device.
payload.value.eventData.cpuLevelAvgNUMBERRepresents the average CPU usage level of a device.
payload.value.eventData.cpuThrottleInfoSTRING[]Reports CPU throttle information for device health monitoring events.
payload.value.eventData.crashedServicesSTRING[]Identifies services that have crashed on the device.
payload.value.eventData.deviceOrientationNormalBOOLEANIndicates whether the device orientation is normal or inverted.
payload.value.eventData.diskUtilizationSTRINGReports disk utilization percentages for various storage partitions and devices.
payload.value.eventData.ethernetErrors.rx_errorsNUMBERReports the total number of receive errors on an ethernet connection.
payload.value.eventData.ethernetErrors.tx_errorsNUMBERReports the total number of transmission errors on an ethernet connection.
payload.value.eventData.fanSpeedNUMBERIndicates the current speed of a device's fan in revolutions per minute.
payload.value.eventData.gpuCoreCelsiusTempNUMBERReports the current temperature of the GPU core in degrees Celsius.
payload.value.eventData.internalAmbientCelsiusTempNUMBERReports the internal ambient temperature in degrees Celsius.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.memoryUtilizationNUMBERReports the current memory utilization of a device in bytes.
payload.value.eventData.memoryUtilizationAvgNUMBERReports the average memory utilization of a device.
payload.value.eventData.memoryUtilizationAvgPctNUMBERReports the average percentage of memory utilization for device health monitoring purposes.
payload.value.eventData.memoryUtilizationPctNUMBERReports the percentage of memory utilized by the device.
payload.value.eventData.networkLoadNUMBERRepresents the network load value as a numeric measurement.
payload.value.eventData.openFileCountNUMBERIndicates the number of open files on a device during a health information event.
payload.value.eventData.polyCpuUsedNUMBERRepresents the percentage of CPU usage
payload.value.eventData.polyMemUsageOBJECT[]See payload.value.eventData.polyMemUsage[] definition
payload.value.eventData.swapUtilizationSTRINGRepresents the swap utilization of a device in kilobytes.
payload.value.eventData.tombstonesSTRING[]List of tombstone files generated on the device
payload.value.eventData.uptimeSTRINGIndicates the duration a device has been continuously operational.
payload.value.eventData.usbPeripheralsSTRING[]Names of the usb devices that are connected to the device
payload.value.eventData.wifiCelsiusTempNUMBERRepresents the current WiFi temperature in degrees Celsius.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceEvent.deviceHealthInfo: payload.value.eventData.polyMemUsage[]

Field NameData TypeDescription
processNameSTRINGIdentifies the process name for memory usage in device health information events.
usedMemoryNUMBERReports the amount of used memory

DeviceEvent.deviceMediaEvent

Tracks a media event

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.LOG_TAGSTRINGIdentifies the log tag for device media events.
payload.value.eventData.mediaSessionIDSTRINGIdentifies a unique media session identifier for device media events.
payload.value.eventData.mediaSourceSTRINGIdentifies the source of media played on a device.
payload.value.eventData.mediaStatusSTRINGIndicates the status of media playback on a device.
payload.value.eventData.screenResolutionSTRINGSpecifies the screen resolution of a device in various formats.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceEvent.DfuFailure

Contains information about a Device Firmware Update (DFU) failure.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.archiveFileSTRINGSpecifies the path to the archive file for device firmware updates.
payload.value.eventData.deviceIdSTRINGIdentifies the device with a unique identifier.
payload.value.eventData.failureReasonSTRINGIndicates the reason for device firmware update failure.
payload.value.eventData.percentageCompleteSTRINGIndicates the percentage of completion for a device firmware update event.
payload.value.eventData.pidSTRINGA Unique identifier that identifies the product associated with device information updates and primary device events.
payload.value.eventData.subFileSTRINGContains additional data related to device firmware update failure events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.AcousticAggregates

Contains aggregated acoustic exposure information.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.batchedDataOBJECT[]See payload.value.eventData.batchedData[] definition
payload.value.eventData.lensDeviceIdSTRINGIdentifies the device associated with the event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.AcousticAggregates: payload.value.eventData.batchedData[]

Field NameData TypeDescription
audioLevelAfterLimitingNUMBERRepresents the audio level after limiting in acoustic-related events.
audioLevelBeforeLimitingNUMBERRepresents the audio level before limiting in acoustic events.
callIdSTRINGIdentifies a unique call identifier for various device information events.
durationNUMBERRepresents the duration of acoustic data in milliseconds.
durationThresholdNUMBERRepresents the duration threshold value for acoustic events and device data.
incidentTimeSTRINGRepresents the timestamp of an incident or event occurrence.
lineTypeSTRINGIdentifies the type of line for various device-related events and analytics.
periodicityNUMBERIndicates the time interval between data batches in milliseconds.

DeviceInfo.AcousticIncident

Reports that an acoustic incident occurred.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.batchedDataOBJECT[]See payload.value.eventData.batchedData[] definition
payload.value.eventData.lensDeviceIdSTRINGIdentifies the device associated with the event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.AcousticIncident: payload.value.eventData.batchedData[]

Field NameData TypeDescription
activeLimitersSTRING[]Identifies active limiters in acoustic incident device information events.
audioLevelAfterLimitingNUMBERRepresents the audio level after limiting in acoustic-related events.
audioLevelBeforeLimitingNUMBERRepresents the audio level before limiting in acoustic events.
callIdSTRINGIdentifies a unique call identifier for various device information events.
durationThresholdNUMBERRepresents the duration threshold value for acoustic events and device data.
gainThresholdNUMBERRepresents the minimum sound level required to trigger an acoustic incident detection event.
incidentDurationNUMBERRepresents the duration of an incident in numeric format.
incidentTimeSTRINGRepresents the timestamp of an incident or event occurrence.
limiterBitMaskNUMBERIndicates a bitmask value for limiting device functionality during acoustic incidents.

DeviceInfo.Analytics

Contains information about detected objects.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.updateTimeSTRINGRepresents the timestamp of an event update in numeric string format.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.AppActive

Indicates an event triggered when the currently active application on the system changes.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.appNameSTRINGIdentifies the name of the application currently running on the device.
payload.value.eventData.entranceReasonSTRINGSpecifies the reason for entering the application's active state.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.AppInfo

Tracks the applications installed on device

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.appsOBJECT[]See payload.value.eventData.apps[] definition
payload.value.eventData.lastUpdatedOnSTRINGRepresents the timestamp of the last update of an app.
payload.value.eventData.providerSTRINGIdentifies the persona set on the device
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.AppInfo: payload.value.eventData.apps[]

Field NameData TypeDescription
appNameSTRINGIdentifies the name of an application installed on a device.
appSizeNUMBERRepresents the size of an application in bytes.
isEnabledBOOLEANIndicates whether an application is enabled or disabled on the device.
isPrimaryBOOLEANIndicates whether an application is the selected provider app.
lastUpdatedOnSTRINGStores the timestamp of the last update for an application.
packageNameSTRINGIdentifies the package name of an application installed on a device.
versionInfoSTRINGSpecifies the version information of installed applications on a device.

DeviceInfo.AppState

Indicates change in the state of the app on device. For e.g Device is IN_MEETING,INCOMING_CALL etc.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.appNameSTRINGIdentifies the name of the application currently running on the device.
payload.value.eventData.appStateSTRINGIndicates the current application state of a device.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.callConnection

Tracks a call event

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.callDirectionSTRINGIndicates the direction of a call.
payload.value.eventData.callIdSTRINGIdentifies a unique call identifier for various device events and call detail records.
payload.value.eventData.callIDSTRINGIdentifies a unique call identifier for various telecommunication events.
payload.value.eventData.callSpeedSTRINGRepresents the speed of a call in bits per second.
payload.value.eventData.callStatusSTRINGIndicates the current status of a phone call or connection.
payload.value.eventData.eventTimeSTRINGRepresents the timestamp of an event in ISO format.
payload.value.eventData.lensDeviceIdSTRINGIdentifies the device associated with the event.
payload.value.eventData.lineTypeSTRINGIdentifies the connection type for the call info
payload.value.eventData.protocolTypeSTRINGIdentifies the protocol used for voice or call connections and related events.
payload.value.eventData.sourceSTRINGIdentifies the source of event data for various device interactions.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.CallQoSInfo

Contains Quality of Service (QoS) information for a call.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.bitRateDataRx.audioJitterNUMBERMeasures the audio jitter bit rate received during a call.
payload.value.eventData.bitRateDataRx.audioPacketLossNUMBERMeasures the number of lost audio packets received during a call.
payload.value.eventData.bitRateDataRx.audioProtocolSTRINGIdentifies the audio protocol used for receiving bit rate data.
payload.value.eventData.bitRateDataRx.audioRateNUMBERRepresents the received audio bitrate in device call quality of service information events.
payload.value.eventData.bitRateDataRx.contentVideoFormatSTRINGSpecifies the video format of received content.
payload.value.eventData.bitRateDataRx.contentVideoFrameRateNUMBERRepresents the received video frame rate in bits per second.
payload.value.eventData.bitRateDataRx.contentVideoProtocolSTRINGSpecifies the video protocol used for receiving content.
payload.value.eventData.bitRateDataRx.contentVideoRateNUMBERRepresents the received video bitrate in call quality of service information events.
payload.value.eventData.bitRateDataRx.contentVideoRateUsedNUMBERRepresents the received video bitrate used in call quality of service information.
payload.value.eventData.bitRateDataRx.totalRateNUMBERRepresents the total received bitrate in a call quality of service information event.
payload.value.eventData.bitRateDataRx.videoFormatSTRINGSpecifies the video format of received bit rate data.
payload.value.eventData.bitRateDataRx.videoFrameRateNUMBERRepresents the video frame rate received by the device in bits per second.
payload.value.eventData.bitRateDataRx.videoJitterNUMBERMeasures the video jitter bit rate received during a call.
payload.value.eventData.bitRateDataRx.videoPacketLossNUMBERMeasures the number of video packets lost during reception.
payload.value.eventData.bitRateDataRx.videoProtocolSTRINGSpecifies the video protocol used for receiving bitrate data.
payload.value.eventData.bitRateDataRx.videoRateNUMBERRepresents the received video bitrate in device call quality of service information events.
payload.value.eventData.bitRateDataRx.videoRateUsedNUMBERRepresents the received video bitrate used in call quality of service information.
payload.value.eventData.bitRateDataTx.audioJitterNUMBERMeasures the audio jitter bit rate in transmit direction for call quality of service information.
payload.value.eventData.bitRateDataTx.audioPacketLossNUMBERRepresents the audio packet loss rate in bits per second during a call.
payload.value.eventData.bitRateDataTx.audioProtocolSTRINGIdentifies the audio protocol used for transmitting bit rate data.
payload.value.eventData.bitRateDataTx.audioRateNUMBERSpecifies the transmit audio bitrate in device call quality of service information events.
payload.value.eventData.bitRateDataTx.contentVideoFormatSTRINGSpecifies the video format of transmitted content.
payload.value.eventData.bitRateDataTx.contentVideoFrameRateNUMBERRepresents the video frame rate transmitted during a call.
payload.value.eventData.bitRateDataTx.contentVideoProtocolSTRINGSpecifies the video protocol used for transmitted content.
payload.value.eventData.bitRateDataTx.contentVideoRateNUMBERRepresents the transmitted video bitrate in call quality of service information events.
payload.value.eventData.bitRateDataTx.contentVideoRateUsedNUMBERRepresents the transmitted video rate used in call quality of service information events.
payload.value.eventData.bitRateDataTx.totalRateNUMBERRepresents the total transmission bit rate of a device during a call.
payload.value.eventData.bitRateDataTx.videoFormatSTRINGSpecifies the video format of transmitted data during a call.
payload.value.eventData.bitRateDataTx.videoFrameRateNUMBERRepresents the video frame rate transmitted during a call in bits per second.
payload.value.eventData.bitRateDataTx.videoJitterNUMBERMeasures the transmitted video jitter in bits per second for call quality monitoring.
payload.value.eventData.bitRateDataTx.videoPacketLossNUMBERRepresents the transmitted video packet loss rate in bits per second.
payload.value.eventData.bitRateDataTx.videoProtocolSTRINGSpecifies the video protocol used for transmitting video data.
payload.value.eventData.bitRateDataTx.videoRateNUMBERRepresents the transmitted video bitrate in bits per second for device calls.
payload.value.eventData.bitRateDataTx.videoRateUsedNUMBERRepresents the transmitted video bitrate in bytes per second.
payload.value.eventData.callDirectionSTRINGIndicates the direction of a call.
payload.value.eventData.callDurationSTRINGRepresents the duration of a call in hours, minutes, and seconds format.
payload.value.eventData.callIdSTRINGIdentifies a unique call identifier for various device events and call detail records.
payload.value.eventData.callStartTimeSTRINGRepresents the start time of a call in ISO format.
payload.value.eventData.callStatusSTRINGIndicates the current status of a phone call or connection.
payload.value.eventData.callTerminationBOOLEANIndicates whether a call was terminated normally or abnormally.
payload.value.eventData.callTypeSTRINGIdentifies the type of call in a device's call quality of service information.
payload.value.eventData.conferenceIdSTRINGIdentifies the conference identifier for call quality of service information.
payload.value.eventData.contentUsedBOOLEANIndicates whether content was used during a call quality of service event.
payload.value.eventData.destAddrSTRINGStores the destination address of a call or communication event.
payload.value.eventData.destNameSTRINGIdentifies the destination name or address in a call event.
payload.value.eventData.disconnectCauseCodeSTRINGIndicates the reason for a call disconnection with a specific code.
payload.value.eventData.encryptionUsedBOOLEANIndicates whether encryption was used for the call.
payload.value.eventData.precedenceLevelSTRINGIndicates the priority level of a call quality of service event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.cdrInfo

Contains a Call Detail Record (CDR) of a call.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.answeredInSoftphoneBOOLEANIndicates whether a call was answered using a softphone.
payload.value.eventData.callDirectionSTRINGIndicates the direction of a call.
payload.value.eventData.callDurationSTRINGRepresents the duration of a call in hours, minutes, and seconds format.
payload.value.eventData.callDurationMsNUMBERRepresents the duration of a call in milliseconds.
payload.value.eventData.callIdSTRINGIdentifies a unique call identifier for various device events and call detail records.
payload.value.eventData.callRateSTRINGSpecifies the call rate in bits per second for a call details record.
payload.value.eventData.dialStringSTRINGContains the dial string used to initiate a call in various communication events.
payload.value.eventData.disconnectInfoSTRINGDescribes the reason for a call disconnect or termination event.
payload.value.eventData.endTimeSTRINGRepresents the end time of an event in ISO format.
payload.value.eventData.experienceSummary.audioProtocolRxSTRINGSpecifies the audio protocol received by the device.
payload.value.eventData.experienceSummary.audioProtocolTxSTRINGSpecifies the audio protocol used for transmission in a call.
payload.value.eventData.experienceSummary.avgJitterRxNUMBERMeasures average jitter received in network communications.
payload.value.eventData.experienceSummary.avgJitterTxNUMBERMeasures average transmit jitter in network communications.
payload.value.eventData.experienceSummary.avgLatencyRxNUMBERMeasures the average latency received in network communications.
payload.value.eventData.experienceSummary.avgLatencyTxNUMBERRepresents the average transmit latency in network transactions.
payload.value.eventData.experienceSummary.avgPacketsLostRxNUMBERReports the average number of packets lost during reception.
payload.value.eventData.experienceSummary.avgPacketsLostTxNUMBERRepresents the average number of packets lost during transmission.
payload.value.eventData.experienceSummary.avgPercentPacketLossRxNUMBERMeasures average packet loss received as a percentage.
payload.value.eventData.experienceSummary.avgPercentPacketLossTxNUMBERMeasures average packet loss during transmission as a percentage value.
payload.value.eventData.experienceSummary.maxJitterRxNUMBERMeasures the maximum received jitter in network communications.
payload.value.eventData.experienceSummary.maxJitterTxNUMBERMeasures the maximum transmission jitter experienced during a call.
payload.value.eventData.experienceSummary.maxLatencyRxNUMBERMeasures the maximum latency received in a network experience.
payload.value.eventData.experienceSummary.maxLatencyTxNUMBERMeasures the maximum transmission latency in network communications.
payload.value.eventData.experienceSummary.precedenceLevelSTRINGIndicates the precedence level of the call.
payload.value.eventData.experienceSummary.totalH320ErrorsNUMBERCounts the total number of H320 errors in a call details record.
payload.value.eventData.experienceSummary.videoFormatRxSTRINGSpecifies the video format received by the device.
payload.value.eventData.experienceSummary.videoFormatTxSTRINGSpecifies the video transmission format used by the device.
payload.value.eventData.experienceSummary.videoProtocolRxSTRINGSpecifies the video protocol received by the device.
payload.value.eventData.experienceSummary.videoProtocolTxSTRINGIndicates the video transmission protocol used by the device.
payload.value.eventData.lensDeviceIdSTRINGIdentifies the device associated with the event.
payload.value.eventData.lineTypeSTRINGIdentifies the connection type for the call info
payload.value.eventData.local.nameSTRINGIdentifies a local name associated in a recent call entry
payload.value.eventData.local.uriSTRINGIdentifies the URI of the local endpoint in for a recent call entry
payload.value.eventData.nameSTRINGIndicates the status or action of a device event.
payload.value.eventData.pluginIdSTRINGIdentifies the plugin identifier associated with device information events.
payload.value.eventData.protocolTypeSTRINGIdentifies the protocol used for voice or call connections and related events.
payload.value.eventData.relatedDeviceEventSTRINGIndicates the type of event related to a device interaction or status change.
payload.value.eventData.remote.nameSTRINGIdentifies the remote name associated with a call details record event.
payload.value.eventData.remote.uriSTRINGIdentifies the remote uniform resource identifier for the given recent call entry
payload.value.eventData.remotePartySTRINGIdentifies the remote party in a call details record event.
payload.value.eventData.softphoneVersionSTRINGSpecifies the version of the softphone application in use.
payload.value.eventData.sourceSTRINGIdentifies the source of event data for various device interactions.
payload.value.eventData.startTimeSTRINGRepresents the start time of the event in ISO format.
payload.value.eventData.userActionSTRINGIdentifies the type of user action triggering the device event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.ConversationAnalytics

Contains acoustic information about the call environment.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.batchedDataOBJECT[]See payload.value.eventData.batchedData[] definition
payload.value.eventData.lensDeviceIdSTRINGIdentifies the device associated with the event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.ConversationAnalytics: payload.value.eventData.batchedData[]

Field NameData TypeDescription
callIdSTRINGIdentifies a unique call identifier for various device information events.
farTalkNUMBERMeasures the far talk time in conversation analytics events.
incidentTimeSTRINGRepresents the timestamp of an incident or event occurrence.
lineTypeSTRINGIdentifies the type of line for various device-related events and analytics.
nearTalkNUMBERMeasures the near-talk audio level in conversation analytics events.
overTalkNUMBERMeasures the duration of overlapping talk in a conversation.
periodicityNUMBERIndicates the time interval between data batches in milliseconds.
rxLevelInNUMBERRepresents the received signal strength level in a device's conversation analytics data.
rxLevelOutNUMBERMeasures the signal strength of received data in decibels.
rxNoiseInNUMBERRepresents the received noise level in decibels for wireless communication.
rxNoiseOutNUMBERMeasures the received noise level in decibels for wireless communication.
rxPeakInNUMBERRepresents the peak receive signal strength in a batch of data.
rxPeakOutNUMBERMeasures the peak receive signal strength in decibels.
rxVolumeNUMBERMeasures the volume of received audio signals in decibels.
sideToneVolumeNUMBERRepresents the volume of side tone audio in conversation analytics data.
txLevelInNUMBERRepresents the transmission level of a signal in a device conversation analytics event.
txLevelOutNUMBERRepresents the transaction level output in decibels for audio signals.
txNoiseInNUMBERRepresents the noise level measured in decibels during a transaction.
txNoiseOutNUMBERRepresents the noise level of outgoing transmissions in decibels.
txPeakInNUMBERRepresents the peak inbound transaction volume in a batch of network traffic data.
txPeakOutNUMBERRepresents the peak outgoing transmission power in decibels.
txVolumeNUMBERRepresents the transaction volume in a batch of event data.
typeSTRINGIdentifies the type of event data in a batched data record.

DeviceInfo.deviceConfigRecord

Contains configuration settings of the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.otherItemsOBJECT[]See payload.value.eventData.otherItems[] definition
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.deviceConfigRecord: payload.value.eventData.otherItems[]

Field NameData TypeDescription
isInitialBOOLEANIndicates whether an item is the initial configuration for the device.
keySTRINGIdentifies various device configuration settings and properties in a device information record.
valueSTRINGStores various device configuration data as string values.

DeviceInfo.deviceInfoState

Contains details of all connected devices.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.entitiesOBJECT[]See payload.value.eventData.entities[] definition
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.deviceInfoState: payload.value.eventData.entities[]

Field NameData TypeDescription
capabilitiesSTRING[]Lists the capabilities of a device.
connectedBOOLEANIndicates whether a device is currently connected.
connectionsOBJECT[]See payload.value.eventData.entities[].connections[] definition
connectionTypeToHostPcSTRINGRepresents an applications connection to a PC (used for room PC's)
deviceIdSTRINGIdentifies the device using a unique string identifier.
deviceNameSTRINGSpecifies the name of a device (defaults to the product name if not overridden by a user).
deviceSpecificInfo.buildCodeSTRINGIdentifies the device's build code.
deviceSpecificInfo.colorSTRINGSpecifies the color of a device.
deviceSpecificInfo.componentVersions.baseSTRINGSpecifies the base component version of a device.
deviceSpecificInfo.componentVersions.bluetoothSTRINGSpecifies the Bluetooth component version of a device.
deviceSpecificInfo.componentVersions.headsetSTRINGSpecifies the headset component version of a device.
deviceSpecificInfo.componentVersions.picSTRINGSpecifies the PIC component version of a device.
deviceSpecificInfo.componentVersions.tuningSTRINGSpecifies the tuning component version of a device.
deviceSpecificInfo.componentVersions.usbSTRINGSpecifies the USB component version of a device.
deviceSpecificInfo.formFactorSTRINGDescribes the physical form of a device, such as left or right earbud
deviceSpecificInfo.genesSerialNumberSTRINGIdentifies the internal serial number of a device.
deviceSpecificInfo.headsetTypeSTRINGIdentifies the type of headset connected.
deviceSpecificInfo.ipv4AddressSTRINGStores the IPv4 address of a device in various network events.
deviceSpecificInfo.macAddressSTRINGIdentifies the device's media access control (MAC) address.
deviceSpecificInfo.modelIdSTRINGIdentifies the device model.
deviceSpecificInfo.tattooSerialNumberSTRINGIdentifies a unique serial number for device tracking purposes.
deviceSpecificInfo.typeSTRINGIdentifies the type of device connected.
deviceSpecificInfo.versionHashSTRINGUnique version hash of device (if set in firmware)
deviceTypeSTRINGIdentifies the type of device.
hardwareModelSTRINGIdentifies the hardware model of a device in various events.
isUpdateAvailableBOOLEANIndicates whether a device update is available.
manufacturerSTRINGIdentifies the device manufacturer.
productIdSTRINGIdentifies the product identifier.
productNameSTRINGIdentifies the product name of a device.
proxyAgentSTRINGIdentifies the proxy agent used by a device.
proxyAgentIdSTRINGIdentifies the proxy agent associated with a device.
proxyAgentVersionSTRINGSpecifies the version of the proxy agent used by the device.
softwareVersionSTRINGSpecifies the version of software installed on a device.
stateSTRINGIndicates the current state of a device or entity.
updateVersionSTRINGIndicates the version of software update that is available for a device.
vendorIdSTRINGIdentifies the vendor of a device.

DeviceInfo.deviceInfoState: payload.value.eventData.entities[].connections[]

Field NameData TypeDescription
connectedBOOLEANIndicates whether a device connection is currently established or not.
fromSTRINGIdentifies the source entity in a connection.
fullNameSTRINGIdentifies a unique entity connection full name in device information events.
mailSTRINGIdentifies a unique mail connection entity in device information events.
protocolSTRINGSpecifies the protocol used for device connections.
stats.bitrateNUMBERRepresents the bitrate of a device connection.
stats.typeSTRINGIdentifies the statistics for device connections.
targetEntityTypeSTRINGIdentifies the type of target entity in a connection, such as device or user.
toSTRINGIdentifies the destination of a connection.
typeSTRINGIdentifies the type of connection for a device (e.g. bluetooth, usb, IP).
userNameSTRINGIndicates the user connected to the application.
viaSTRING[]Specifies the connection path for device communication.

DeviceInfo.deviceInfoUpdate

Contains details of changes to the connected devices.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.capabilitiesSTRING[]Lists device capabilities in a device information update event.
payload.value.eventData.connectedBOOLEANIndicates whether a device is currently connected or not.
payload.value.eventData.connectionsOBJECT[]See payload.value.eventData.connections[] definition
payload.value.eventData.deviceIdSTRINGIdentifies the device with a unique identifier.
payload.value.eventData.deviceNameSTRINGIdentifies the name of a device.
payload.value.eventData.deviceSpecificInfo.buildCodeSTRINGIdentifies the device's build code.
payload.value.eventData.deviceSpecificInfo.colorSTRINGRepresents the color of a device in various informational updates.
payload.value.eventData.deviceSpecificInfo.componentVersions.baseSTRINGSpecifies the device's base component version.
payload.value.eventData.deviceSpecificInfo.componentVersions.bluetoothSTRINGSpecifies the device's Bluetooth version.
payload.value.eventData.deviceSpecificInfo.componentVersions.headsetSTRINGSpecifies the device's headset component version.
payload.value.eventData.deviceSpecificInfo.componentVersions.picSTRINGSpecifies the device's PIC component version.
payload.value.eventData.deviceSpecificInfo.componentVersions.tuningSTRINGSpecifies the device's tuning component version.
payload.value.eventData.deviceSpecificInfo.componentVersions.usbSTRINGSpecifies the device's USB component version.
payload.value.eventData.deviceSpecificInfo.formFactorSTRINGIndicates the device's form factor, such as left or right.
payload.value.eventData.deviceSpecificInfo.genesSerialNumberSTRINGIdentifies a device by its unique serial number.
payload.value.eventData.deviceSpecificInfo.headsetTypeSTRINGSpecifies the type of headset connected to the application.
payload.value.eventData.deviceSpecificInfo.ipv4AddressSTRINGSpecifies the device's IPv4 address in various network configurations.
payload.value.eventData.deviceSpecificInfo.macAddressSTRINGIdentifies the device's media access control (MAC) address.
payload.value.eventData.deviceSpecificInfo.modelIdSTRINGIdentifies the device model using a unique identifier.
payload.value.eventData.deviceSpecificInfo.tattooSerialNumberSTRINGIdentifies a device by its unique external serial number.
payload.value.eventData.deviceSpecificInfo.typeSTRINGOptionally specifies a type of device connected to the application.
payload.value.eventData.deviceSpecificInfo.versionHashSTRINGUnique version hash of device (if set in firmware)
payload.value.eventData.deviceTypeSTRINGIndicates the family of the device connected to the application.
payload.value.eventData.isUpdateAvailableBOOLEANIndicates whether a device has a software update available.
payload.value.eventData.manufacturerSTRINGIdentifies the device manufacturer in various device information events.
payload.value.eventData.productIdSTRINGA Unique identifier that identifies the product associated with device information updates and primary device events.
payload.value.eventData.productNameSTRINGIdentifies the product name of a device.
payload.value.eventData.proxyAgentSTRINGIdentifies the proxy agent used for device information updates.
payload.value.eventData.proxyAgentIdSTRINGIdentifies a unique proxy agent identifier for the application.
payload.value.eventData.proxyAgentVersionSTRINGThe version of the application sending the message.
payload.value.eventData.softwareVersionSTRINGIndicates the version of software installed on the device.
payload.value.eventData.updateTypeSTRINGIndicates the type of update made to device information.
payload.value.eventData.updateVersionSTRINGIndicates the version of software update that is available for a device.
payload.value.eventData.vendorIdSTRINGIdentifies the vendor of a device.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.deviceInfoUpdate: payload.value.eventData.connections[]

Field NameData TypeDescription
connectedBOOLEANIndicates whether a device connection is currently established or not.
fromSTRING 
protocolSTRINGIdentifies the communication protocol used by a device connection.
stats.bitrateNUMBERReports the bitrate of a device connection in bits per second.
stats.typeSTRINGIdentifies the type of connection for device communication protocols.
targetEntityTypeSTRINGIdentifies whether this device is connected to another device or a software application.
toSTRINGIdentifies the device that this device is connected to.
typeSTRINGIdentifies the type of connection for devices paried to applications.
viaSTRING[]Identifies any intermediate devices in the path of connection.

DeviceInfo.FaceTracking

Contains information about how many people are detected.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
deviceIdSTRINGIdentifies the device associated with various events and analytics.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventdata.countSTRINGIndicates the number of events or occurrences in device face tracking data.
payload.value.eventData.countNUMBER | STRINGRepresents the number of events or items in the event data payload.
payload.value.eventData.deviceIdSTRINGIdentifies the device with a unique identifier.
payload.value.eventData.macSTRINGIdentifies the media access control (MAC) address of a device.
payload.value.eventData.smallestFaceHeightSTRINGSpecifies the minimum height of a detected face in pixels.
payload.value.eventdata.sourceIdNUMBERIdentifies the source of event in device face tracking data.
payload.value.eventData.sourceIdNUMBER | STRINGIdentifies the source of face tracking camera id
payload.value.eventdata.updateTimeNUMBERRepresents the event's timestamp of the last update in milliseconds since epoch time.
payload.value.eventData.updateTimeNUMBER | STRINGRepresents the timestamp of an event update in numeric string format.
payload.value.eventtimeSTRINGRepresents the event's timestamp when an event occurs in ISO format.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventtypeSTRINGIndicates the type of event triggered by a device.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventversionSTRINGSpecifies the version of the event being reported in device messages.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.networkInfo

Contains information about the network configuration of the device.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.interfacesOBJECT[]See payload.value.eventData.interfaces[] definition
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.networkInfo: payload.value.eventData.interfaces[]

Field NameData TypeDescription
802.1xStatusBOOLEAN | STRINGIndicates the status of 802.1x authentication for a network interface.
cdpStatusSTRINGIndicates the status of the Cisco Discovery Protocol in network information events.
connectionModeSTRINGIndicates the mode of connection for network interfaces.
connectionSpeedSTRINGIndicates the speed of the network connection in megabits per second.
connectionTypeSTRINGIndicates the type of network connection used by the device.
dnsAlternativeAddressSTRINGSpecifies an alternative DNS address for the device's network interface.
dnsDomainSTRINGIdentifies the DNS domain associated with a network interface.
dnsPrimaryAddressSTRINGSpecifies the primary DNS address of a device's network interface.
eapMethodSTRINGSpecifies the authentication method used for network connections.
ipv4AddressSTRINGSpecifies the IPv4 address of a network interface.
ipv4AddressSourceSTRINGSpecifies the source of the IPv4 address for network interfaces.
ipv4GatewaySTRINGSpecifies the IPv4 gateway address for network interfaces.
ipv4SubnetSTRINGSpecifies the IPv4 subnet mask for network interfaces.
ipv4VlanSTRINGSpecifies the IPv4 VLAN interface value for network information events.
ipv6AddressSourceSTRINGSpecifies the source of the IPv6 address for network interfaces.
ipv6GlobalAddressSTRINGContains the IPv6 global address of a network interface.
ipv6LinkLocalAddressSTRINGSpecifies the IPv6 link local address of an interface on a device.
ipv6ULASTRINGSpecifies the IPv6 Unique Local Address for network interfaces.
lldpLocationInformationSTRINGSpecifies location information received from Link Layer Discovery Protocol messages.
lldpNeighborsSTRINGIndicates neighboring device information received through Link Layer Discovery Protocol.
lldpStatusSTRINGIndicates the status of Link Layer Discovery Protocol on a network interface.
ntpServerSTRINGSpecifies the network time protocol server used for time synchronization.
pcPortStatusSTRINGIndicates the status of a PC port on a network interface.
provisioningProtocolSTRINGSpecifies the protocol used for provisioning network interfaces on devices.
securitySTRINGSpecifies the security protocol used by a network interface.
ssidSTRINGIdentifies the ssid of wireless network interfaces on devices.

DeviceInfo.primaryDeviceInfo

Contains basic identity information for the device.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.eventMonotonicMillisNUMBERRepresents the event timestamp in milliseconds since an arbitrary starting point.
payload.value.eventData.hardwaremodelSTRINGIdentifies the hardware model of a device.
payload.value.eventData.hardwareModelSTRINGIdentifies the hardware model of a device in various events.
payload.value.eventData.hardwarerevisionSTRINGIdentifies the hardware revision of a device.
payload.value.eventData.hardwareRevisionSTRINGIdentifies the hardware revision of a device.
payload.value.eventData.hostHardwareSTRINGDescribes host hardware details including manufacturer and architecture.
payload.value.eventData.hostNameSTRINGIdentifies the hostname of a device in various network events.
payload.value.eventData.hostOSSTRINGIdentifies the operating system of the device or application.
payload.value.eventData.hostOSBuildSTRINGSpecifies the operating system build version of the device or application.
payload.value.eventData.hostOSVersionSTRINGStores the operating system version of the device or application.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.macaddressSTRINGIdentifies the media access control (MAC) address of a device.
payload.value.eventData.macAddressSTRINGIdentifies the media access control (MAC) address of a device.
payload.value.eventData.manufacturerSTRINGIdentifies the device manufacturer in various device information events.
payload.value.eventData.offsetgmtSTRINGIndicates the device's timezone offset from Greenwich Mean Time.
payload.value.eventData.offsetGMTSTRINGRepresents the timezone offset from Greenwich Mean Time.
payload.value.eventData.productfamilySTRINGIdentifies the product family of a device.
payload.value.eventData.productFamilySTRINGIdentifies the product family of a device in various events.
payload.value.eventData.productIdSTRINGA Unique identifier that identifies the product associated with device information updates and primary device events.
payload.value.eventData.proxyAgentSTRINGIdentifies the proxy agent used for device information updates.
payload.value.eventData.proxyAgentIdSTRINGIdentifies a unique proxy agent identifier for the application.
payload.value.eventData.proxyAgentVersionSTRINGThe version of the application sending the message.
payload.value.eventData.serialnumberSTRINGIdentifies the device's unique serial number in various events.
payload.value.eventData.serialNumberSTRINGIdentifies a device by its unique serial number.
payload.value.eventData.softwarebuildSTRINGIdentifies the software build version of a device.
payload.value.eventData.softwareBuildSTRINGIdentifies the software build version of a device.
payload.value.eventData.softwarereleaseSTRINGIndicates the software release version of a device.
payload.value.eventData.softwareReleaseSTRINGIdentifies the software release version of a device.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.remoteAccessInfo

Indicates remote access telemetry

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.bytesReceivedNUMBERRepresents the total number of bytes received during a remote access event.
payload.value.eventData.bytesSentNUMBERRepresents the total number of bytes sent during a remote access event.
payload.value.eventData.durationMsNUMBERRepresents the duration of remote access session in milliseconds.
payload.value.eventData.endedBySTRINGIndicates the entity that ended a remote access session.
payload.value.eventData.endReasonSTRINGIndicates the reason for ending a remote access session or connection.
payload.value.eventData.endTimeSTRINGRepresents the end time of an event in ISO format.
payload.value.eventData.localIceCandidateSTRINGContains local ICE candidate information for remote access events.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.remoteAdminVersionSTRINGStores the version of the remote administration software.
payload.value.eventData.remoteIceCandidateSTRINGStores remote ice candidate details for remote access communication.
payload.value.eventData.sessionIdSTRINGIdentifies a unique session for remote access information.
payload.value.eventData.startResponseTimeSTRINGRepresents the start response time for remote access events in ISO format.
payload.value.eventData.startTimeSTRINGRepresents the start time of the event in ISO format.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.secondaryDeviceInfo

Contains information about secondary devices connected to the primary device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.attachedDevicesOBJECT[]See payload.value.eventData.attachedDevices[] definition
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

DeviceInfo.secondaryDeviceInfo: payload.value.eventData.attachedDevices[]

Field NameData TypeDescription
attachmentStateSTRINGIndicates the state of device attachment for various events.
CECEnabledSTRINGIndicates whether Consumer Electronics Control is enabled for a device.
connectionTypeSTRINGIndicates the connection type of attached devices to the system.
displayNameSTRINGIdentifies the display name of an attached device.
ipAddressSTRINGSpecifies the IP address of a connected device.
macAddressSTRINGIdentifies the media access control address of an attached device.
peripheralTypeSTRINGIdentifies the type of peripheral device attached to a system.
refreshRateSTRINGSpecifies the refresh rate of attached devices in device information events.
resolutionSTRINGSpecifies the screen resolution of attached devices in device information events.
serialNumberSTRINGIdentifies the serial number of an attached device.
softwareVersionSTRINGIndicates the software version of attached devices.
statusSTRINGIndicates the status of devices attached to a secondary device.
TouchableSTRINGIndicates whether a device has a touch interface capability.
vendorSTRINGIdentifies the manufacturer of an attached device.

DeviceInfo.serviceInfo

Tracks registration to a service

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.authTypeSTRINGSpecifies the authentication type used for device service information events.
payload.value.eventData.baseDNSTRINGIdentifies the base distinguished name in directory services.
payload.value.eventData.defaultGroupSTRINGSpecifies the default group identifier for service information events.
payload.value.eventData.displayNameSTRINGIdentifies the display name of a device or attached peripheral.
payload.value.eventData.domainSTRINGIdentifies the domain associated with the service information.
payload.value.eventData.emailSTRINGStores the email address associated with the service.
payload.value.eventData.enabledBOOLEANIndicates whether a device service is enabled or disabled.
payload.value.eventData.enableSSLBOOLEANIndicates whether SSL is enabled for the device's service information.
payload.value.eventData.expiryNUMBERIndicates the expiration value for device service information.
payload.value.eventData.extensionSTRINGContains additional event data as a string for device information service events.
payload.value.eventData.failureReasonSTRINGIndicates the reason for device firmware update failure.
payload.value.eventData.globalServerSTRINGSpecifies the global server configuration for device information service events.
payload.value.eventData.lineIdSTRINGIdentifies the line identifier for device service information events.
payload.value.eventData.lineTypeSTRINGIdentifies the connection type for the call info
payload.value.eventData.outboundProxySTRINGSpecifies the outbound proxy server address for SIP communications.
payload.value.eventData.outboundProxyTransportSTRINGSpecifies the transport protocol used by the outbound proxy.
payload.value.eventData.regTypeSTRINGIdentifies the registration type of a device in various service information events.
payload.value.eventData.serverAddrSTRINGSpecifies the server address for various device-related events and communications.
payload.value.eventData.serverPortSTRINGIdentifies the server port used by the device for communication.
payload.value.eventData.sipAccountNameSTRINGIdentifies the SIP account name associated with a device.
payload.value.eventData.sipAddrSTRINGContains the SIP address associated with a device or service.
payload.value.eventData.sipDomainNameSTRINGIdentifies the domain name associated with a session initiation protocol event.
payload.value.eventData.sipPortNUMBERIndicates the SIP port number used by the device.
payload.value.eventData.sipTranportSTRINGSpecifies the transport protocol used for SIP communications.
payload.value.eventData.sipUsernameSTRINGIdentifies the SIP username associated with a device's service information.
payload.value.eventData.srvPlatformSTRINGIdentifies the sip registration server type
payload.value.eventData.statusSTRINGIndicates the status of a device or service in various operational states.
payload.value.eventData.userIdSTRINGIdentifies the user associated with a particular device or service event.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DeviceInfo.ztpInfo

Indicates zero-touch provisioning info event.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.value.eventData.m_typeSTRINGIdentifies the type of device event data being reported in various device-related events.
payload.value.eventData.oobSucceededBOOLEANIndicates whether out-of-box was successful for device.
payload.value.eventData.ztpEnabledAppsSTRING[]Lists enabled personas on devices.
payload.value.eventData.ztpPersonaStateSTRINGIndicates the state of the persona discovery process
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DO_REBOOT

Sends a request to the device to reboot

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.errorSTRINGIndicates the error message for various device operation failures.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
payload.successBOOLEANIndicates whether the requested operation was successful or not.
status.codeNUMBERIndicates the status code of device operations and responses.
status.errorSTRINGIndicates the error status of a device or connection attempt.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DO_RESET

Represents a factory reset or configuration reset

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.errorSTRINGIndicates the error message for various device operation failures.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
payload.successBOOLEANIndicates whether the requested operation was successful or not.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

DO_SYNC

Event triggers provisioning sync on device. (Currently not supported on Poly Touch Controller)

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
status.codeNUMBERIndicates the status code of device operations and responses.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

END_REMOTE_SESSION

Indicates end of a remote session.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.errorCodeNUMBERIndicates the error code for various remote session related events.
payload.messageSTRINGDescribes the reason for the remote session termination.
payload.sessionIdSTRINGIdentifies a unique session for remote access information.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

GET_OOB_PARAMS

Indicates out-of-box information received from Lens.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

GET_PIN

Requests the PIN required to onboard a device to a Lens tenant

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

GET_REMOTE_SESSION_STATUS

Indicates the remote session status

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.sessionsOBJECT[]See payload.sessions[] definition
payload.stateSTRINGIndicates the current state of a remote session.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

GET_REMOTE_SESSION_STATUS: payload.sessions[]

Field NameData TypeDescription
sessionIdSTRINGIdentifies a unique session in remote session status requests.

GRAPHQL

No Description

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.querySTRINGContains the query string for GraphQL requests.
payload.tokenSTRINGContains authentication token for GraphQL requests.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

HTTP_API

Umbrella for events related to HTTP REST API on the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.body.activePersonaSTRINGIdentifies the current active application persona running on the system. May differ from appPersona in some scenarios.
payload.body.appSTRINGIdentifies the current provider application name of the system.
payload.body.appLockedBOOLEANIndicates whether the system is locked to the current application persona.
payload.body.appPersonaSTRINGIdentifies the current provider application persona of the system.
payload.body.ecoModeBOOLEANIndicates whether the device is operating in eco mode.
payload.body.foregroundPersonaSTRINGIdentifies the current application persona in foreground. May differ from appPersona and activePersona in some scenarios.
payload.body.idSTRINGIdentifies a unique identifier for the payload body in API requests.
payload.body.modeSTRINGSpecifies the operating mode for API requests and responses.
payload.body.polyCallControlBOOLEANIndicates whether polycom call control is enabled or disabled.
payload.body.rebootNeededBOOLEANIndicates whether a device reboot is required for changes to one or more configuration variables to take effect.
payload.body.resultBOOLEANIndicates whether the HTTP API request was successful.
payload.body.stateSTRINGIndicates the current state of a resource or entity in an HTTP API request.
payload.body.statusNUMBERIndicates the HTTP status code returned by the API.
payload.body.titleSTRINGContains the title of an HTTP API response body.
payload.body.typeSTRINGIdentifies the type of HTTP response payload body.
payload.body.varsOBJECT[]See payload.body.vars[] definition
payload.bodyOBJECT[]See payload.body[] definition
payload.contentTypeSTRINGSpecifies the format of the payload in HTTP API requests.
payload.dataSTRINGContains various error messages and device information in string format.
payload.headersSTRINGContains HTTP headers with metadata such as date and content type.
payload.responseCodeNUMBERIndicates the HTTP response code for API transactions.
status.errorSTRINGIndicates the error status of a device or connection attempt.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

HTTP_API: payload.body.vars[]

Field NameData TypeDescription
errorParamsSTRINGContains error details for API requests.
isEditableBOOLEANSpecifies whether a field in the HTTP API request or response payload is editable.
isHiddenBOOLEANIndicates whether a variable is hidden in the HTTP API payload.
isSecureBOOLEANIndicates whether a variable is secure and their value will be obfuscated in the HTTP API payload.
nameSTRINGIdentifies variable names in HTTP API payload body.
optionsSTRINGStores available options for a field in HTTP API requests and responses, if applicable.
optionsSTRING[]Stores available options for a field in HTTP API requests and responses, if applicable.
requestedValueSTRINGSpecifies the requested value when setting the configuration variable.
resultSTRINGIndicates the result of an HTTP API operation with a specific status code.
valueSTRINGContains a string value of variable in HTTP API requests and responses.

HTTP_API: payload.body[]

Field NameData TypeDescription
appNameSTRINGIdentifies the application name.
appPackageNameSTRINGIdentifies the package name of applications in HTTP API events.
appSizeNUMBERRepresents the size of an application in bytes.
callOnHoldBOOLEANIndicates whether a call is currently on hold during an API interaction.
capabilities.canAcquireChairBOOLEANIndicates whether a device can acquire a chair capability.
capabilities.canAcquireFloorBOOLEANIndicates whether a device can acquire the floor in a communication session.
capabilities.canAddTerminalBOOLEANIndicates whether a terminal can be added to a device or system.
capabilities.canAddVideoBOOLEANIndicates whether video addition is supported in the request payload.
capabilities.canBlastDialBOOLEANIndicates whether blast dialing is supported in the current session.
capabilities.canEscalateCallBOOLEANIndicates whether a call can be escalated to a higher level of support.
capabilities.canGetRosterBOOLEANIndicates whether the device can retrieve a roster of contacts or not.
capabilities.canHangupConferenceBOOLEANIndicates whether a conference can be hung up.
capabilities.canHoldConfBOOLEANIndicates whether a device can hold conference calls.
capabilities.canJoinCCCPBOOLEANIndicates whether a device can join a common control and command protocol.
capabilities.canJoinChairControlConfBOOLEANIndicates whether a user can join a chair control conference.
capabilities.canJoinInternalConfBOOLEANIndicates whether a user can join internal conferences.
capabilities.canJoinMRCBOOLEANIndicates whether a user can join a multi-party conference.
capabilities.canLeaveConferenceBOOLEANIndicates whether a user can leave a conference.
capabilities.canMuteConferenceBOOLEANIndicates whether a conference can be muted.
capabilities.canMuteTerminalBOOLEANIndicates whether the terminal can be muted.
capabilities.cannotJoinConfBOOLEANIndicates whether a user is unable to join a conference.
capabilities.canPresentBOOLEANIndicates whether a device can present certain capabilities.
capabilities.canRemoveTerminalBOOLEANIndicates whether a terminal can be removed from the system.
capabilities.canShowCloseWideBOOLEANIndicates whether a close button is displayed for wide screens.
capabilities.canSupportSecurityClassificationBOOLEANIndicates whether security classification is supported by the device or system.
connectionsOBJECT[]See payload.body[].connections[] definition
connectionTypeSTRINGIndicates the type of connection used for the HTTP API request.
deviceCategorySTRINGIdentifies the category of device associated with the event payload.
deviceStateSTRINGIndicates the current state of a device in various network interactions.
deviceTypeSTRINGIdentifies the type of device in HTTP API requests.
durationNUMBERRepresents the length of time an operation or event took to complete in seconds.
ecoModeBOOLEANIndicates whether the device is operating in eco mode.
holdStartTimeNUMBERSpecifies the start time of a hold period in seconds.
holdStateSTRINGIndicates whether a resource is currently being held or not.
humanReadableVersionSTRINGContains the human-readable version of the system's software in the update availability request.
idSTRINGIdentifies a unique identifier for items in the payload body.
incomingCallBOOLEANIndicates whether an incoming call is present in the payload.
inLocalPresentationBOOLEANIndicates whether the payload body is in local presentation format.
inLocalWhiteboardBOOLEANIndicates whether the payload body is in a local whiteboard or not.
inMeetingBOOLEANIndicates whether a user is currently in a meeting or not.
inPhoneCallBOOLEANIndicates whether the user is currently engaged in a phone call.
ipSTRINGSpecifies the IP address associated with the request.
isActiveBOOLEANIndicates whether a specific entity is currently active or not.
isHoldingBOOLEANIndicates whether a resource is being held in a request.
isMuteBOOLEANIndicates whether the payload body item is muted or not.
isSvcConferenceBOOLEANIndicates whether a service conference is in progress for the current API request.
isWaitingInLobbyBOOLEANIndicates whether a user is waiting in a lobby during an API interaction.
langtagSTRINGIdentifies the language tag for specific API request payload elements.
lastUpdatedOnNUMBERStores the timestamp of the last update in milliseconds since epoch.
macAddressSTRINGIdentifies the media access control (MAC) address of a device.
mediaServerControlEventSTRINGIndicates the type of media server control event that occurred.
mediaServerTypeSTRINGIdentifies the type of media server used in the API transaction.
modUidSTRINGIdentifies a unique module ID that corresponds to the system's peripherals as part of the update availability request.
nameSTRINGIdentifies the name of the configuration.
networkInterfaceSTRINGIdentifies the network interface used for the HTTP API request.
outgoingCallBOOLEANIndicates whether the call is outgoing in API requests.
packageNameSTRINGIdentifies the name of the install package.
personaNameSTRINGIdentifies the name of the persona set on the system.
polyCallControlBOOLEANIndicates whether poly call control is enabled or disabled.
productNameSTRINGIdentifies the product name in HTTP API payload data.
serialNumberSTRINGIdentifies the serial number of a device.
sessionExtraInfo.dialledAddressSTRINGIdentifies the dialled address in a session for HTTP API events.
sessionExtraInfo.serverSTRINGIdentifies the server used in the HTTP API session.
sessionExtraInfo.serverTypeSTRINGIdentifies the type of server used in the session extra information.
sessionExtraInfo.sessionIDSTRINGIdentifies a unique session for HTTP API transactions and events.
sessionExtraInfo.systemNameSTRINGIdentifies the system name associated with a session or meeting event.
sessionExtraInfo.systemUriSTRINGIdentifies the system uniform resource identifier for various session interactions.
softwareKeyRequiredBOOLEANIndicates whether a software key is required as part of the update availability request.
softwareVersionSTRINGIndicates the software version of a device or application.
startTimeNUMBERRepresents the start time of a specific event or transaction in unix epoch milliseconds.
stateListSTRING[]Indicates the states of a system service as up, down, off or unknown.
supportCertMgmtBOOLEANIndicates whether certificate management is supported in the request.
systemNameSTRINGIdentifies the system name.
terminalsOBJECT[]See payload.body[].terminals[] definition
uidSTRINGIdentifies a unique user identifier in API request payloads.
urlSTRINGSpecifies the update URL in the update availability request.
usbPromptBOOLEANIndicates whether a USB prompt is required as part of the update availability request.
versionSTRINGSpecifies the software version in the update availability request.
versionCheckFailureSTRINGIndicates the cause of a version check failure during the update availability request.
versionCheckResultSTRINGIndicates the result of a software version check operation with various possible outcomes.
versionInfoSTRINGContains version information of application in string format.
videoMutedBOOLEANIndicates whether the video stream is muted in the payload.

HTTP_API: payload.body[].connections[]

Field NameData TypeDescription
addressSTRINGIdentifies the address of a connection in a payload body.
answerableBOOLEANIndicates whether a connection is answerable or not in API responses.
authStateSTRINGIndicates the authentication state of a connection in an HTTP API event.
callInfoSTRINGIdentifies the protocol used for a specific call in the HTTP API event.
callTypeSTRINGIdentifies the protocol used for a specific call in the HTTP API event.
canAddVideoBOOLEANIndicates whether video can be added to a connection.
causeCodeNUMBERIndicates the reason for a connection termination or failure.
durationNUMBERRepresents the duration of a connection in seconds.
encryptedBOOLEANIndicates whether the connection uses encryption.
groupnameSTRINGIdentifies the group name associated with a connection in an HTTP API event.
grouptypeSTRINGIndicates the group type of a connection in an HTTP API event payload.
idSTRINGIdentifies a unique connection identifier in API requests.
incomingBOOLEANIndicates whether an incoming connection is established for the API request.
mediaCountNUMBERIndicates the number of media items in a connection.
mediaTypeSTRINGIndicates the type of media used in a connection.
parentConfIdSTRINGIdentifies the parent conference identifier for a connection in an HTTP API event.
percentConnectedNUMBERRepresents the percentage of successful connections in a given payload.
rateNUMBERSpecifies the data transfer rate in bits per second for network connections.
referredBySTRINGIdentifies the referrer of a connection in API requests.
startTimeNUMBERRepresents the start time of a connection in milliseconds since epoch.
stateSTRINGIndicates the current state of a network connection.
terminalsOBJECT[]See payload.body[].connections[].terminals[] definition
typeSTRINGIdentifies the connection type for API requests and responses.
videoEscalationStateSTRINGIndicates the video escalation state of a connection in an HTTP API event.

HTTP_API: payload.body[].connections[].terminals[]

Field NameData TypeDescription
hrefSTRINGIdentifies the hyperlink reference to a specific terminal in a conference.
relSTRINGSpecifies the relationship of a terminal in a connection.

HTTP_API: payload.body[].terminals[]

Field NameData TypeDescription
addressSTRINGSpecifies the address of a terminal in a communication session.
callerIDSTRINGIdentifies the caller's ID in various formats, including IP addresses and usernames.
canSupportMediaStatusBOOLEANIndicates whether a terminal can support media status.
fullDescriptionBOOLEANIndicates whether a terminal has a detailed description in HTTP API events.
holdStateSTRINGIndicates the hold status of a terminal in an HTTP API request.
idSTRINGIdentifies a unique terminal identifier in API requests.
mediaServerTypeSTRINGIdentifies the type of media server used in the HTTP API event.
mutedBOOLEANIndicates whether a terminal is muted or not in the payload.
muteLockedBOOLEANIndicates whether the terminal's mute state is locked or not.
nameSTRINGIdentifies the name of a terminal in a payload body.
parentConfIdSTRINGIdentifies the parent conference identifier for a terminal in an HTTP API event.
parentConnectionIdSTRINGIdentifies the parent connection identifier for a terminal in an HTTP API event.
streamsStateSTRINGIndicates the state of video streams for terminal devices.
systemIDSTRINGIdentifies the system ID of various conferencing and communication platforms.
termTypeSTRINGIdentifies the type of terminal in a network communication transaction.

IMPORT

Represents the initiation or completion of a import of device configuration, firmware, and user profile.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.resultSTRINGContains the result of processing a request, including any errors or version information.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

INIT

Indicates the initialization event from device to Lens.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.accountCodeSTRINGIdentifies the account code associated with the payload.
payload.caCertFolderSTRINGSpecifies the directory path for system's certificate authority certificates.
payload.caCertPathSTRINGSpecifies the file path to the certificate issued by a Certificate Authority (CA).
payload.cookieStorageSTRINGStores the file path of cookie storage for device initialization.
payload.deviceCertKeyPathSTRINGSpecifies the file path to the device's certificate private key.
payload.deviceCertPathSTRINGSpecifies the file path of the device's certificate for secure communication.
payload.deviceIdSTRINGIdentifies the device with a unique string identifier.
payload.deviceNameSTRINGIdentifies the name of the device sending the message.
payload.deviceSignatureSTRINGIdentifies the device signature for initialization events.
payload.globalDirectoryUrlSTRINGSpecifies the scope id of the Lens environment to connect for device initialization. Default empty connects to production .
payload.hardwareModelSTRINGIdentifies the hardware model of the device in initialization events.
payload.hardwarePNSTRINGIdentifies the hardware product number of a device.
payload.hardwareRevisionSTRINGIdentifies the hardware revision of the device during initialization.
payload.http_server_exclusiveBOOLEANIndicates whether the HTTP server is exclusive to the device.
payload.http_server_urlSTRINGSpecifies the URL of the HTTP server for initialization purposes.
payload.loglevelNUMBER | STRINGIndicates the logging level for initialization events.
payload.m_typeSTRINGIdentifies the type of message payload in various device and activity events.
payload.macAddressSTRINGIdentifies the media access control address of a device.
payload.manufacturerSTRINGIdentifies the device manufacturer in various system events.
payload.NAMESTRINGIdentifies the name of a specific action or state in various device and activity events.
payload.offsetGMTSTRINGRepresents the timezone offset from Greenwich Mean Time.
payload.orgidSTRINGIdentifies the organization.
payload.pkey_idSTRINGIdentifies a unique key for keystore engine grant operations.
payload.powerSourceSTRINGIndicates the device's current power source type.
payload.productFamilySTRINGIdentifies the product family of a device during initialization.
payload.proxySTRINGSpecifies the proxy server used for the connection.
payload.proxyAgentSTRINGIdentifies the entity used to communicate to the cloud.
payload.proxyAgentIdSTRINGThe unique identifier for the application sending the event.
payload.proxyAgentVersionSTRINGIdentifies the version of the entity connecting to the cloud.
payload.proxynameSTRINGIdentifies the proxy server name in initialization events.
payload.proxyNameSTRINGIdentifies the proxy service name used during initialization events.
payload.proxypasswordSTRINGStores the proxy password for initialization events.
payload.proxyPasswordSTRINGStores the password used for proxy authentication during initialization.
payload.roomidSTRINGIdentifies the room name during initialization.
payload.serialNumberSTRINGIdentifies the device's unique serial number in initialization events.
payload.siteidSTRINGIdentifies the site location during initialization.
payload.softwareBuildSTRINGIdentifies the software build version during initialization events.
payload.softwareReleaseSTRINGSpecifies the software release version of the device.
payload.updaterVersionSTRINGIndicates the version of the updater component in the system.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Labs.Lease.Request

A request the device sends to the cloud to request a lease for a specific Labs feature

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.featureSTRINGThe feature identifier the lease is being requested for.
payload.sessionSTRINGIdentifies a unique session for various system events and requests.
payload.timestampSTRINGRepresents the timestamp when the event payload was generated or recorded.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Labs.State.Report

An event indicating a state of the labs feature from the device

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.enrolledBOOLEANIndicates if enrolled in Poly Labs
payload.featuresOBJECT[]See payload.features[] definition
payload.sessionSTRINGIdentifies a unique session for various system events and requests.
payload.timestampSTRINGRepresents the timestamp when the event payload was generated or recorded.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

Labs.State.Report: payload.features[]

Field NameData TypeDescription
activatedBOOLEANIndicates whether a specific feature is currently activated or not on the device
availableBOOLEANRepresents if the feature is available on the device and visible to the customer
idSTRINGThe Poly Labs feature identifier
params.acousticfenceradiusSTRINGConfig parameter that specifies the acoustic fence radius for the relevant labs feature
params.enableacousticfenceSTRINGConfig parameter that indicates whether the acoustic fence feature is enabled or disabled for the relevant labs feature
params.noiseblockaioptionsSTRINGConfig parameter that specifies the noise block AI options for the relevant labs feature

Labs.Telemetry.labs_clxti8l6i000108l2en4ndztv

Represents a Poly Labs Telemetry Event for this specific Feature ID

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.featureSTRINGIdentifies a specific feature in telemetry event data for this labs feature
payload.value.eventData.sessionSTRINGIdentifies a unique session for the labs feature
payload.value.eventData.telemetry.backgroundNUMBERRepresents a numeric telemetry value collected in the background.
payload.value.eventData.telemetry.overallNUMBERRepresents the overall telemetry value as a numeric measurement.
payload.value.eventData.telemetry.voiceNUMBERRepresents the voice telemetry value as a numeric measurement.
payload.value.eventData.typeSTRINGIdentifies the type of event data in telemetry messages.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

ni

Contains information about the network configuration of the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.802.1xStatusSTRINGIndicates the status of 802.1x authentication.
payload.data.cdpStatusSTRINGIndicates the current status of the device's CDP configuration.
payload.data.connectionModeSTRINGIndicates the mode of connection (duplex) for network interface events.
payload.data.connectionSpeedSTRINGIndicates the speed of the network connection or its current status.
payload.data.connectionTypeSTRINGIndicates the type of network connection used for data transmission.
payload.data.dnsAlternativeAddressSTRINGSpecifies an alternative DNS address for the device or network connection.
payload.data.dnsDomainSTRINGIdentifies the domain name associated with a network interaction.
payload.data.dnsPrimaryAddressSTRINGSpecifies the primary DNS server address for network interface events.
payload.data.eapErrorSTRINGIndicates the error message for the EAP error that has occurred during network authentication
payload.data.eapErrorCountSTRINGIndicates the number of EAP errors that have occurred during network authentication
payload.data.eapMethodSTRINGIdentifies the authentication method used in network interactions.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.interfaceNameSTRINGIdentifies the network interface name associated with the event. Default: wlan0
payload.data.ipv4AddressSTRINGSpecifies the IPv4 address of a device in network events.
payload.data.ipv4AddressSourceSTRINGSpecifies the source of the IPv4 address for network interface events.
payload.data.ipv4GatewaySTRINGSpecifies the IPv4 gateway address for network interface events.
payload.data.ipv4SubnetSTRINGSpecifies the IPv4 subnet address for network interface events.
payload.data.ipv6AddressSourceSTRINGSpecifies the source of the IPv6 address configuration.
payload.data.ipv6GlobalAddressSTRINGContains the IPv6 global address of a device in network interface events.
payload.data.ipv6LinkLocalAddressSTRINGSpecifies the IPv6 link local address of a network interface.
payload.data.ipv6ULASTRINGContains the IPv6 Unique Local Address for network interface events.
payload.data.lldpLocationInformationSTRINGStores location information for network devices in a human-readable format.
payload.data.lldpNeighborsSTRINGStores neighboring device identifiers for network discovery events.
payload.data.lldpStatusSTRINGIndicates the current status of the Link Layer Discovery Protocol.
payload.data.micErrorCountSTRINGIndicates the number of microphone errors encountered during device operation.
payload.data.ntpServerSTRINGSpecifies the NTP server used for time synchronization purposes.
payload.data.pcPortStatusSTRINGIndicates the current status of a network port connection.
payload.data.provisioningProtocolSTRINGSpecifies the network protocol used for device provisioning and configuration.
payload.data.regulatoryDomainSTRINGIndicates the country code for radio frequencies
payload.data.rssiNUMBERIndicates the received signal strength in wireless communication events.
payload.data.signalStrengthSTRINGIndicates the signal strength of the Wi-Fi network
payload.data.ssidSTRINGIdentifies the wireless network SSID (Service Set Identifier) associated with a device.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.data.VLANSTRINGIdentifies the virtual local area network associated with a network event.
payload.data.wifiChannelSTRINGIndicates the frequency range used to transmit data
payload.data.wifiStatusSTRINGIndicates the current wifi connection status of a device.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

pdi

Contains basic identity information for the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.featureVariationSTRINGIdentifies the variation of a specific feature in the payload data.
payload.data.hardwareModelSTRINGIdentifies the hardware model of a device in various events.
payload.data.hardwarePNSTRINGIdentifies the hardware product number of a device.
payload.data.hardwareRevisionSTRINGIdentifies the hardware revision of a device in various events.
payload.data.macAddressSTRINGIdentifies the device network interface's MAC (media access control) address in various network events.
payload.data.manufacturerSTRINGIdentifies the device manufacturer in various IoT events and messages.
payload.data.offsetGMTSTRINGSpecifies the timezone offset from Coordinated Universal Time.
payload.data.pcsAccountCodeSTRINGIdentifies a unique account code for various cloud services and applications.
payload.data.powerSourceSTRINGIndicates the device's current power source type.
payload.data.productFamilySTRINGIdentifies the product family of a device in various events.
payload.data.rebootTypeSTRINGIndicates the type of device reboot that occurred.
payload.data.regionCodeSTRINGIdentifies the geographic region associated with the event data.
payload.data.selfNoteSTRINGContains a self-note string for various event types and data processing purposes.
payload.data.serialNumberSTRINGIdentifies the device's unique serial number
payload.data.softwareReleaseSTRINGIdentifies the software release version of the device.
payload.data.updaterVersionSTRINGSpecifies the version of the updater used in the event.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.data.wifiMacAddressSTRINGIdentifies the wifi device's mac address in various network events.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
properties.tenantUUIDSTRINGIdentifies the tenant associated with a particular event or transaction.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

PERMISSION_DENIED

Indicates the error during remote session.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.errorSTRINGIndicates the error message for various device operation failures.
payload.errorCodeNUMBERIndicates the error code for various remote session related events.
payload.sessionIdSTRINGIdentifies a unique session for remote access information.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

push-device-policy-capabilities

A request for the an admin configured policy from the cloud.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.deviceIdSTRINGIdentifies the device with a unique string identifier.
payload.productIdSTRINGThe product id (pid) of the device.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

REMOTE_SESSION_ICE_CANDIDATE

Indicates the ICE candidate shared during a remote session.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.candidateSTRINGContains ICE candidate information for remote session establishment.
payload.sdpMidSTRINGIdentifies the SDP media stream for ICE candidate messages.
payload.sdpMLineIndexNUMBERIdentifies the index of the SDP media line for ICE candidate messages.
payload.sessionIdSTRINGIdentifies a unique session for remote access information.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

SCREENCAPTURE

No Description

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.blobNameSTRINGIdentifies the name of the blob containing the screen capture image.
payload.containerNameSTRINGIdentifies the container name for storing device upload data.
payload.correlationIdSTRINGIdentifies a unique correlation identifier for screen capture events.
payload.dataSTRINGContains various error messages and device information in string format.
payload.hostNameSTRINGIdentifies the hostname of the server hosting the payload.
payload.sasTokenSTRINGContains a shared access signature token for secure resource access.
payload.statusCodeNUMBERIndicates the status code of the screen capture operation.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

sdi

Contains information about secondary devices connected to the primary device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.attachedDevicesOBJECT[]See payload.data.attachedDevices[] definition
payload.data.attachmentStateBOOLEAN | STRINGIndicates the state of an attachment in a message or event.
payload.data.connectionTypeSTRINGIndicates the type of network connection used for data transmission.
payload.data.displayNameSTRINGIdentifies a device or entity by its unique display name.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.macAddressSTRINGIdentifies the device network interface's MAC (media access control) address in various network events.
payload.data.pcPortModeSTRINGIndicates the mode of the network connection.
payload.data.pcPortSpeedSTRINGIndicates the speed of the PC port in megabits per second.
payload.data.pcPortStatusSTRINGIndicates the current status of a network port connection.
payload.data.peripheralTypeSTRINGIdentifies the type of peripheral device connected to the system.
payload.data.powerSourceSTRINGIndicates the device's current power source type.
payload.data.serialNumberSTRINGIdentifies the device's unique serial number
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

sdi: payload.data.attachedDevices[]

Field NameData TypeDescription
attachmentStateBOOLEAN | STRINGIndicates the state of device attachment as a boolean or numeric string value.
bluetoothAddressSTRINGIdentifies the Bluetooth address of an attached device.
connectedDevicesSTRINGContains information about secondary devices attached to a device.
connectionTypeSTRINGIndicates the connection method used by attached devices.
displayNameSTRINGIdentifies the display name of attached devices.
eventMonotonicTimeSTRINGRepresents the event time in a monotonic format as a string value.
macAddressSTRINGIdentifies the media access control address of attached devices.
pcPortModeSTRINGIndicates the port mode of attached devices.
pcPortSpeedSTRINGIndicates the speed of the PC port for attached devices in network events.
pcPortStatusSTRINGIndicates the status of a PC port on an attached device.
peripheralTypeSTRINGIdentifies the type of peripheral device attached to the system.
powerSourceSTRINGIndicates the power source of a secondary device attached to a phone.
serialNumberSTRINGIdentifies the serial number of an attached device in an event.
softwareVersionSTRINGIndicates the software version of secondary devices attached to the phone

service

Settings hosted on your service provider\’s provisioning service or the Poly Lens device management service

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.authenticationTypeSTRINGSpecifies the method used for authenticating a service request.
payload.data.displayNameSTRINGIdentifies a device or entity by its unique display name.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.expirySTRINGSpecifies the expiration value associated with a service event.
payload.data.failureReasonSTRINGSpecifies the reason for a service request failure.
payload.data.lineIdSTRINGIdentifies the line identifier in service-related messages.
payload.data.lineTypeSTRINGIndicates whether a line is private or shared in service events.
payload.data.outboundProxySTRINGSpecifies the outbound proxy server address for service events.
payload.data.outboundProxyPortSTRINGSpecifies the port number used for outbound proxy communications.
payload.data.outboundProxyTransportSTRINGSpecifies the transport protocol used for outbound proxy communications.
payload.data.registeredIPSTRINGStores the IP address where a service is registered.
payload.data.registeredPortSTRINGIdentifies the registered port used for service events.
payload.data.regTypeSTRINGIdentifies the registration type used for service events.
payload.data.saExpirySTRINGIndicates the expiry time of the service authorization in seconds.
payload.data.serverAddrSTRINGSpecifies the server address for communication and connection purposes.
payload.data.sipAddrSTRINGContains the SIP address associated with a service event.
payload.data.sipPortSTRINGSpecifies the port number used for Session Initiation Protocol communication.
payload.data.sipRegistrationTypeSTRINGSpecifies the method used for SIP registration.
payload.data.SipTlsProtocolSTRINGIndicates the protocol used for secure SIP communications.
payload.data.sipTranportSTRINGSpecifies the transport protocol used for SIP communications.
payload.data.srvPlatformSTRINGIdentifies the server platform used for the service event.
payload.data.statusSTRINGIndicates the current status of a service in various states.
payload.data.stsURISTRINGSpecifies the URI of the certificate provisioning service.
payload.data.triedIPListSTRINGStores a list of IP addresses that were attempted during a service event.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.userIdSTRINGIdentifies the user associated with the service event.
payload.data.userInitiatedUnRegistrationSTRINGIndicates whether a service unregistration was initiated by the user.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.data.wadStatusSTRINGIndicates the status of the wide area discovery process.
payload.extSTRINGContains additional call detail information in JSON format.
payload.rtoNUMBER | STRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

START_REMOTE_SESSION

Indicates the start of a remote session.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.answer.sdpSTRINGContains Session Description Protocol answer to an offer received from peer to establish communication sessions.
payload.answer.typeSTRINGIndicates the type of answer in remote session start events.
payload.dataChannelsOBJECT[]See payload.dataChannels[] definition
payload.sessionIdSTRINGIdentifies a unique session for remote access information.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

START_REMOTE_SESSION: payload.dataChannels[]

Field NameData TypeDescription
idNUMBERIdentifies a unique data channel identifier for remote sessions.
protocolSTRINGIdentifies the subprotocol in use for remote session data channels.

START_UPLOAD

Indicates the initiation of an upload session, typically involving logs, configuration files, call quality metrics, or firmware status.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

STOP_UPLOAD

Indicates conclusion of the upload session, indicating either successful completion or interruption due to network or system conditions.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

UCSAPI

Umbrella for events related to UCS API on the device.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.data.data.device.dhcp.bootSrvUseOpt.SourceSTRINGSpecifies the source of the DHCP boot server option.
payload.data.data.device.dhcp.bootSrvUseOpt.ValueSTRINGIndicates whether the device uses boot server options for DHCP configuration.
payload.data.data.pcc.url.SourceSTRINGSpecifies the source URL of the payload data in API requests.
payload.data.data.pcc.url.ValueSTRINGSpecifies the URL value for the pcc in API requests.
payload.data.dataOBJECT[]See payload.data.data[] definition
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.StatusSTRINGIndicates the status of the API request or response.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

UCSAPI: payload.data.data[]

Field NameData TypeDescription
Media DirectionSTRINGIndicates the direction of media transmission for a call.
Remote Connection IPSTRINGStores the IP address of the remote connection.
CallHandleSTRINGIdentifies a unique handle for a call in various communication events.
CallSequenceSTRINGIdentifies the sequence of calls in a communication session.
CallStateSTRINGIndicates the current state of a voice call in various stages of connection and disconnection.
Channel.LabelSTRINGIdentifies the channel label for specific API events.
Channel.ModeSTRINGIndicates the operating mode of a communication channel.
Channel.NumberSTRINGIdentifies the channel number associated with a specific data payload.
Channel.StateSTRINGIndicates the current state of a communication channel.
DurationSecondsSTRINGRepresents the duration of an event in seconds as a string value.
LabelSTRINGIdentifies a label associated with a phone number or extension in various formats.
LineIDSTRINGIdentifies a specific line in a communication session.
LineNumberSTRINGIdentifies the line number associated with a specific data record.
LineTypeSTRINGIndicates whether a line is private or shared in a communication system.
MutedSTRINGIndicates whether a call or session is muted or not.
PortSTRINGIdentifies the port number used for communication in various network transactions.
ProtocolSTRINGIdentifies the communication protocol used in the message payload.
ProxyAddressSTRINGSpecifies the proxy server address used in communication transactions.
RegistrationStatusSTRINGIndicates the status of a device or user registration.
RemotePartyNameSTRINGIdentifies the remote party's name or phone number in a call.
RemotePartyNumberSTRINGContains the remote party's phone number in various formats, including extensions.
RingingSTRINGIndicates whether a call is ringing or not.
RTCPPortSTRINGSpecifies the port used for Real-Time Control Protocol communication.
RTPPortSTRINGIdentifies the port used for Real-time Transport Protocol communications.
SIPAddressSTRINGContains the session initiation protocol address for communication events.
StartTimeSTRINGSpecifies the start time of a particular event or activity in a standardized format.
TypeSTRINGIndicates the direction of a call or message in various events.
UIAppearanceIndexSTRINGIndicates the user interface appearance index for various application states.
UserIDSTRINGIdentifies the user associated with the event data.

uianalytics

Records keypress events of different hardware keys and menu options

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.data.ArrowDownSTRINGIndicates the number of times the down arrow key was pressed by the user.
payload.data.data.ArrowLeftSTRINGRepresents a numeric value associated with user interface analytics events.
payload.data.data.ArrowRightSTRINGContains a numeric string value for user interface analytics events.
payload.data.data.ArrowUpSTRINGIndicates the number of times the up arrow key is pressed in user interface interactions.
payload.data.data.BackSTRINGStores a numeric string value representing a specific user interaction or event data point.
payload.data.data.Dialpad0STRINGContains dialpad input values for user interface analytics.
payload.data.data.Dialpad1STRINGContains a numeric string value representing a dialpad input.
payload.data.data.Dialpad2STRINGContains a numeric string value representing a specific dialpad input.
payload.data.data.Dialpad3STRINGContains a numeric string value representing a dialpad input.
payload.data.data.Dialpad4STRINGContains a numeric string value representing a specific dialpad entry.
payload.data.data.Dialpad5STRINGContains a numeric string value representing a dialpad input.
payload.data.data.Dialpad6STRINGContains a numeric string representing a dialed keypad value.
payload.data.data.Dialpad7STRINGContains a numeric string value representing a dialed key.
payload.data.data.Dialpad8STRINGContains a numeric string representing a dialed number or code.
payload.data.data.Dialpad9STRINGContains a numeric string value representing a dialed key.
payload.data.data.DialpadPoundSTRINGRepresents a dialpad input value in user interface analytics events.
payload.data.data.DialpadStarSTRINGRepresents a dialpad star code entered by the user.
payload.data.data.FeatureAnonymousCallRejectSTRINGIndicates whether anonymous call rejection is enabled as a feature.
payload.data.data.FeatureApplicationsSTRINGIndicates the feature application identifier for analytics events.
payload.data.data.FeatureBluetoothSTRINGIndicates the status of the Bluetooth feature in the device.
payload.data.data.FeatureBluetoothSettingsSTRINGStores Bluetooth settings as a string value in UI analytics events.
payload.data.data.FeatureCallTransferSTRINGIndicates the feature code for call transfer in UI analytics events.
payload.data.data.FeatureConferenceSTRINGIndicates the feature conference identifier for UI analytics events.
payload.data.data.FeatureContactDirectorySTRINGIndicates the number of contacts in the feature contact directory.
payload.data.data.FeatureCorporateDirectorySTRINGIndicates the corporate directory feature status as a numerical value.
payload.data.data.FeatureDoNotDisturbSTRINGIndicates the device's Do Not Disturb feature status as a numeric string value.
payload.data.data.FeatureEthernetSTRINGIndicates the Ethernet feature configuration for user interface analytics.
payload.data.data.FeatureFavoritesSTRINGStores user preferences for favorite features as numeric identifiers.
payload.data.data.FeatureForwardSTRINGIndicates the feature forward status as a numeric string value.
payload.data.data.FeatureMessagesSTRINGContains feature-related messages as numeric strings in UI analytics events.
payload.data.data.FeatureNetworkStatisticsSTRINGContains network statistics feature data as a string value.
payload.data.data.FeatureNewCallSTRINGIndicates the feature code for new call events in analytics data.
payload.data.data.FeaturePhoneInfoSTRINGStores phone feature information as a string value.
payload.data.data.FeatureRecentCallsSTRINGStores the number of recent calls for user interface analytics.
payload.data.data.FeatureScreenCleanSTRINGIndicates whether the feature screen is clean or not.
payload.data.data.FeatureTCPIPParametersSTRINGSpecifies the TCP/IP parameters feature configuration value as a string.
payload.data.data.FeatureWarningsSTRINGIndicates feature warnings with numeric codes in analytics events.
payload.data.data.FeatureWiFiSTRINGIndicates the WiFi feature status as a string value.
payload.data.data.HandsfreeSTRINGIndicates the handsfree status with various numeric codes.
payload.data.data.HeadsetSTRINGIndicates the headset identifier associated with a user interaction event.
payload.data.data.HoldSTRINGIndicates the hold status with a numeric string value.
payload.data.data.HomeSTRINGRepresents a home-related data value in various analytics events.
payload.data.data.HookDownSTRINGIndicates the hook down value as a string in various analytics events.
payload.data.data.HookUpSTRINGIndicates the hook up data for user interface analytics events.
payload.data.data.Line1STRINGRepresents a line number in the user interface analytics event data.
payload.data.data.Line10STRINGStores a specific line number value as part of user interface analytics data.
payload.data.data.Line11STRINGContains a specific line number associated with user interface analytics data.
payload.data.data.Line12STRINGContains a specific line item value from the user interface analytics data.
payload.data.data.Line13STRINGStores a specific line number in the user interface analytics data.
payload.data.data.Line14STRINGContains a specific line number from the user interface analytics data.
payload.data.data.Line2STRINGRepresents a line number in the user interface analytics event data.
payload.data.data.Line3STRINGContains a specific line number associated with user interface analytics data.
payload.data.data.Line4STRINGContains a line number associated with user interface analytics data.
payload.data.data.Line5STRINGContains a specific line number for user interface analytics events.
payload.data.data.Line6STRINGStores a specific line number in the user interface analytics event data.
payload.data.data.Line7STRINGIndicates a specific line number in the user interface analytics data.
payload.data.data.Line8STRINGContains a specific line number for user interface analytics events.
payload.data.data.Line9STRINGRepresents a specific line item value in the user interface analytics data.
payload.data.data.MessagesSTRINGContains the number of messages in the payload data for analytics events.
payload.data.data.MicMuteSTRINGIndicates the microphone mute status as a numeric string value.
payload.data.data.SelectSTRINGStores a selected data value as a string for analytics purposes.
payload.data.data.SoftKey1STRINGRepresents a soft key value associated with user interface interactions.
payload.data.data.SoftKey2STRINGStores a specific soft key value associated with user interface interactions.
payload.data.data.SoftKey3STRINGRepresents a specific soft key value associated with user interface interactions.
payload.data.data.SoftKey4STRINGRepresents a specific soft key identifier in user interface analytics events.
payload.data.data.SoftKey5STRINGRepresents a soft key press with a numeric value.
payload.data.data.TransferSTRINGContains data transfer information as a string value in various events.
payload.data.data.VolDownSTRINGIndicates the volume down event data in user interface analytics.
payload.data.data.VolUpSTRINGIndicates the volume increase value in user interface analytics events.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

UNKNOWN

A catch-all event that may be a response to a specific API request. The text 'UNKNOWN' does not actually appear in the event body.

Field NameData TypeDescription
_iothub.iothub-connection-device-idSTRINGIdentifies the device connected to the IoT hub.
_iothub.iothub-enqueuedtimeSTRINGSpecifies the time the message was enqueued by the IoT hub.
datasourceSTRINGIdentifies the source of the data for various events.
datasourceformatSTRINGSpecifies the format of the data source for various events
deviceidSTRINGUniquely Identifies a device by its ID.
eventdata.callstatusSTRINGIndicates the current status of a call in various events.
eventoriginSTRINGIdentifies the source of an event, such as a device.
eventtimeSTRINGRepresents the timestamp of an event
eventtypeSTRINGIdentifies the type of event that occurred on the device.
eventversionSTRINGSpecifies the version of the event being reported.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
macSTRINGIdentifies a device by its unique media access control (MAC) address.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.dataSTRINGContains various error messages and device information in string format.
payload.statusNUMBERIndicates the status code of various device operations and API requests.
realipSTRINGThe first public facing IP address for the device that sent the event.
tidSTRINGThe ID of the tenant associated with the device that sent the event
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

unregister-device

Disassociate a device with an account.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.deviceIdSTRINGIdentifies the device with a unique string identifier.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

uptime

Indicates the details of the uptime connection of the device with the configured url

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.dataOBJECT[]See payload.data.data[] definition
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Definitions

uptime: payload.data.data[]

Field NameData TypeDescription
eventMonotonicTimeSTRINGRepresents the event's monotonic time in hours, minutes, seconds, and milliseconds.
statusSTRINGIndicates the status of an operation with a specific error or success condition.
timestampSTRINGRepresents the timestamp of a specific event or data point in ISO format.
typeSTRINGIdentifies the type of data in the payload for various services.
urlSTRINGSpecifies the URL associated with device provisioning and management activities.
userSTRINGIdentifies the user associated with the event data.

vq

Contains voice quality information.

Field NameData TypeDescription
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.data.callIdSTRINGIdentifies a unique call identifier for various telecommunication events.
payload.data.eventMonotonicTimeSTRINGRepresents the elapsed time in hours, minutes, seconds, and milliseconds.
payload.data.localTagSTRINGIdentifies a unique local tag for various call events and records.
payload.data.remoteTagSTRINGIdentifies a unique remote tag for various network events and records.
payload.data.report.localMetrics.burstGapLoss.bdSTRINGRepresents the burst gap loss metric in bytes for voice quality events.
payload.data.report.localMetrics.burstGapLoss.bldSTRINGRepresents the burst gap loss metric in local metrics reports.
payload.data.report.localMetrics.burstGapLoss.gdSTRINGRepresents the burst gap loss metric value in the local metrics report.
payload.data.report.localMetrics.burstGapLoss.gldSTRINGMeasures the gap loss during network bursts in voice quality events.
payload.data.report.localMetrics.burstGapLoss.gminSTRINGIndicates the minimum burst gap loss in voice quality events.
payload.data.report.localMetrics.delay.esdSTRINGRepresents the end-to-end delay in milliseconds for voice quality events.
payload.data.report.localMetrics.delay.iajSTRINGRepresents the inter-arrival jitter delay in local metrics reports.
payload.data.report.localMetrics.delay.owdSTRINGRepresents the one-way delay metric value as a string.
payload.data.report.localMetrics.delay.rtdSTRINGRepresents the round-trip delay in real-time metrics reports.
payload.data.report.localMetrics.jitterBuffer.jbaSTRINGIndicates the jitter buffer average value in voice quality events.
payload.data.report.localMetrics.jitterBuffer.jbmSTRINGRepresents the jitter buffer metric value in voice quality events.
payload.data.report.localMetrics.jitterBuffer.jbnSTRINGRepresents the jitter buffer size in milliseconds for voice quality events.
payload.data.report.localMetrics.jitterBuffer.jbrSTRINGIndicates the jitter buffer size in the voice quality event report.
payload.data.report.localMetrics.jitterBuffer.jbxSTRINGRepresents the jitter buffer size in milliseconds for voice quality events.
payload.data.report.localMetrics.packetLoss.jdrSTRINGRepresents the packet loss metric as a decimal value string.
payload.data.report.localMetrics.packetLoss.nlrSTRINGRepresents the packet loss ratio as a numeric string value.
payload.data.report.localMetrics.qualityEst.moscqSTRINGRepresents the estimated mean opinion score for voice quality.
payload.data.report.localMetrics.qualityEst.moslqSTRINGIndicates the estimated mean opinion score for voice quality.
payload.data.report.localMetrics.qualityEst.rcqSTRINGRepresents the estimated call quality as a numerical value.
payload.data.report.localMetrics.qualityEst.rlqSTRINGRepresents the estimated voice quality rating as a numerical string value.
payload.data.report.localMetrics.sessionDesc.ppsSTRINGReports the packets per second value for a session.
payload.data.report.localMetrics.sessionDesc.ptSTRINGContains a numeric code describing the session description point in a voice quality event.
payload.data.report.localMetrics.sessionDesc.ssupSTRINGIndicates the status of the SSUP feature in a session.
payload.data.report.localMetrics.signal.rerlSTRINGRepresents the received signal level in a voice quality event.
payload.data.report.localMetrics.timeStamps.startSTRINGRepresents the start time of a local metrics report in ISO format.
payload.data.report.localMetrics.timeStamps.stopSTRINGRepresents the stop timestamp in a specific metric report.
payload.data.report.remoteMetrics.burstGapLoss.bdSTRINGIndicates the burst gap loss for remote metrics in voice quality events.
payload.data.report.remoteMetrics.burstGapLoss.bldSTRINGRepresents the burst gap loss in a voice quality event.
payload.data.report.remoteMetrics.burstGapLoss.gdSTRINGRepresents the burst gap loss metric value in remote metrics reports.
payload.data.report.remoteMetrics.burstGapLoss.gldSTRINGIndicates the burst gap loss for remote metrics reporting in voice quality events.
payload.data.report.remoteMetrics.burstGapLoss.gminSTRINGIndicates the minimum burst gap loss in remote metrics reports.
payload.data.report.remoteMetrics.delay.esdSTRINGRepresents the delay in esd remote metrics as a string value.
payload.data.report.remoteMetrics.delay.iajSTRINGRepresents the interarrival jitter delay in remote metrics reports.
payload.data.report.remoteMetrics.delay.rtdSTRINGRepresents the round-trip delay in remote metrics reports.
payload.data.report.remoteMetrics.jitterBuffer.jbaSTRINGIndicates the jitter buffer average in voice quality events.
payload.data.report.remoteMetrics.jitterBuffer.jbmSTRINGIndicates the jitter buffer metric value in voice quality events.
payload.data.report.remoteMetrics.jitterBuffer.jbnSTRINGIndicates the jitter buffer size in milliseconds for voice quality events.
payload.data.report.remoteMetrics.jitterBuffer.jbrSTRINGIndicates the jitter buffer size in remote metrics reports.
payload.data.report.remoteMetrics.jitterBuffer.jbxSTRINGIndicates the jitter buffer size in milliseconds for voice quality events.
payload.data.report.remoteMetrics.packetLoss.jdrSTRINGIndicates the packet loss rate as a decimal value string.
payload.data.report.remoteMetrics.packetLoss.nlrSTRINGIndicates the measured packet loss rate as a numeric string value.
payload.data.report.remoteMetrics.qualityEst.extriSTRINGIndicates the estimated external quality metric value as a string.
payload.data.report.remoteMetrics.qualityEst.moscqSTRINGRepresents the estimated mean opinion score for voice quality.
payload.data.report.remoteMetrics.qualityEst.moslqSTRINGIndicates the estimated mean opinion score for voice quality.
payload.data.report.remoteMetrics.qualityEst.rcqSTRINGRepresents the estimated remote connection quality as a numerical score.
payload.data.report.remoteMetrics.sessionDesc.ppsSTRINGDescribes the packets per second metric in a session description report.
payload.data.report.remoteMetrics.sessionDesc.ptSTRINGDescribes the session description metric for remote video quality events.
payload.data.report.remoteMetrics.sessionDesc.ssupSTRINGIndicates the status of the SSUP feature in a session.
payload.data.report.remoteMetrics.signal.nlSTRINGRepresents the signal strength in a network metrics report.
payload.data.report.remoteMetrics.signal.rerlSTRINGIndicates the received signal strength in remote metrics reports.
payload.data.report.remoteMetrics.signal.slSTRINGRepresents the signal strength level in remote metrics reports.
payload.data.report.remoteMetrics.timeStamps.startSTRINGRepresents the start time of remote metrics in ISO format.
payload.data.report.remoteMetrics.timeStamps.stopSTRINGRepresents the stop timestamp in a remote metrics report.
payload.data.uploadTimeSTRINGRepresents the time data was uploaded in ISO format with timezone offset.
payload.data.versionInfoSTRINGIndicates the version information of the application.
payload.data.vqReportTypeSTRINGSpecifies the type of voice quality report being generated.
payload.rtoSTRINGSpecifies the response timeout value in various application and call events.
payload.typeSTRINGIdentifies the type of payload in various events and messages.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.

Zoo.entityUpdate

Message that communicates device or application settings to the cloud.

Field NameData TypeDescription
appNameSTRINGIdentifies the application associated with the event.
frameIdSTRINGUnique Id of the message. Autogenerated by default.
nameSTRINGIdentifies the type of event or action being performed or reported.
payload.attrSTRINGContains additional attributes for various device and activity events.
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.constraints.optionsSTRING[]Indicates whether acoustic fence functionality is enabled or disabled.
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.mutableBOOLEANIndicates whether acoustic fence feature can be modified
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.readableBOOLEANIndicates whether the acoustic fence feature can be read.
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.valueSTRINGIndicates whether acoustic fence is enabled or disabled.
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.constraints.optionsSTRING[]Specifies the possible values for acoustic fence sensitivity options.
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.mutableBOOLEANIndicates whether acoustic fence sensitivity can be modified.
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.readableBOOLEANIndicates whether acoustic fence sensitivity can be read.
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.valueNUMBER | STRINGSpecifies the acoustic fence sensitivity value for entity updates.
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.constraints.optionsSTRING[]Specifies the acoustic fence options for entity updates.
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.mutableBOOLEANIndicates where the acoustic fence property can be modified.
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.readableBOOLEANIndicates whether acoustic fence data is readable for entity updates.
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.valueSTRINGRepresents acoustic fence data values in entity update events.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.constraints.optionsSTRING[]Specifies available advanced audio noise cancellation options.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.mutableBOOLEANIndicates whether active noise cancellation advance is mutable.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.readableBOOLEANIndicates whether active noise cancellation is readable.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.valueSTRINGSpecifies the advanced active noise cancellation for a device.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.constraints.optionsSTRING[]Specifies available audio noise cancellation options.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.mutableBOOLEANIndicates whether active noise cancellation is mutable.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.readableBOOLEANIndicates whether active noise cancellation is readable.
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.valueSTRINGSpecifies the noise cancellation level for a device.
payload.value.eventData.data.com.poly.audio.anc_timeout._data.constraints.optionsSTRING[]Specifies Active Noise Cancellation (ANC) timeout options.
payload.value.eventData.data.com.poly.audio.anc_timeout._data.mutableBOOLEANIndicates whether the Active Noise Cancellation (ANC) timeout data is mutable.
payload.value.eventData.data.com.poly.audio.anc_timeout._data.readableBOOLEANIndicates whether the Active Noise Cancellation (ANC) timeout data is readable.
payload.value.eventData.data.com.poly.audio.anc_timeout._data.valueSTRINGRepresents the amount of time Active Noise Cancellation (ANC) stays on while a headset is idle.
payload.value.eventData.data.com.poly.audio.anti_startle._data.constraints.optionsSTRING[]Specifies the possible values for anti-startle options.
payload.value.eventData.data.com.poly.audio.anti_startle._data.mutableBOOLEANIndicates whether anti-startle can be modified.
payload.value.eventData.data.com.poly.audio.anti_startle._data.readableBOOLEANIndicates whether anti-startle can be read.
payload.value.eventData.data.com.poly.audio.anti_startle._data.valueSTRINGIndicates whether the anti-startle feature is enabled or disabled.
payload.value.eventData.data.com.poly.audio.audio_quality._data.constraints.optionsSTRING[]Specifies options for optimizing audio quality
payload.value.eventData.data.com.poly.audio.audio_quality._data.mutableBOOLEANIndicates whether the audio quality is mutable.
payload.value.eventData.data.com.poly.audio.audio_quality._data.readableBOOLEANIndicates whether the audio quality is readable.
payload.value.eventData.data.com.poly.audio.audio_quality._data.valueSTRINGSpecifies the audio quality setting.
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.constraints.optionsSTRING[]Specifies options for the auto-pause music setting.
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.mutableBOOLEANIndicates whether auto-pause music is mutable.
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.readableBOOLEANIndicates whether auto-pause music is readable.
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.valueSTRINGIndicates whether music should automatically pause when streaming from a device when you remove your headset.
payload.value.eventData.data.com.poly.audio.bass._data.constraints.optionsSTRING[]Specifies the available bass options for audio configuration.
payload.value.eventData.data.com.poly.audio.bass._data.mutableBOOLEANIndicates whether the bass setting can be modified.
payload.value.eventData.data.com.poly.audio.bass._data.readableBOOLEANIndicates whether the bass setting can be read.
payload.value.eventData.data.com.poly.audio.bass._data.valueSTRINGRepresents the bass audio level as a numeric string value.
payload.value.eventData.data.com.poly.audio.extended_range._data.constraints.optionsSTRING[]Specifies extended range audio capabilities.
payload.value.eventData.data.com.poly.audio.extended_range._data.mutableBOOLEANIndicates whether the audio extended range can be modified.
payload.value.eventData.data.com.poly.audio.extended_range._data.readableBOOLEANIndicates whether the audio extended range can be read.
payload.value.eventData.data.com.poly.audio.extended_range._data.valueSTRINGIndicates the audio extended range value.
payload.value.eventData.data.com.poly.audio.g616._data.constraints.optionsSTRING[]Specifies options for G616 Anti-Startle Protection.
payload.value.eventData.data.com.poly.audio.g616._data.mutableBOOLEANIndicates whether the G616 Anti-Startle Protection is mutable.
payload.value.eventData.data.com.poly.audio.g616._data.readableBOOLEANIndicates whether the G616 Anti-Startle Protection is readable.
payload.value.eventData.data.com.poly.audio.g616._data.valueSTRINGSpecifies current G616 audio mode.
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.constraints.optionsSTRING[]Specifies the daily phone usage constraints for Noise Exposure.
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.mutableBOOLEANIndicates whether hours on phone per day data can be modified.
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.readableBOOLEANIndicates whether hours on phone per day data can be read.
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.valueSTRINGRepresents the total hours spent on phone calls per day.
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.constraints.optionsSTRING[]Specifies possible values for independent volume control.
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.mutableBOOLEANIndicates whether independent volume control can be modified.
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.readableBOOLEANIndicates whether independent volume control can be read.
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.valueSTRINGIndicates whether independent volume control is enabled or disabled.
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.constraints.optionsSTRING[]Specifies the available options for noise block AI advanced.
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.mutableBOOLEANIndicates whether the noise block AI advanced setting can be modified.
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.readableBOOLEANIndicates whether the noise block AI advanced setting can be read.
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.valueSTRINGStores advanced audio noise block data for entity updates.
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.constraints.optionsSTRING[]Specifies incoming audio noise block AI options.
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.mutableBOOLEANIndicates whether incoming audio noise block AI is modifiable.
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.readableBOOLEANIndicates whether incoming audio noise block AI is readable.
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.valueSTRINGIndicates whether incoming audio noise reduction is enabled or disabled.
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.constraints.optionsSTRING[]Specifies outgoing audio noise block AI options.
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.mutableBOOLEANIndicates whether outgoing audio noise block AI data can be modified.
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.readableBOOLEANIndicates whether outgoing audio noise block AI data is readable.
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.valueSTRINGIndicates whether outgoing audio noise reduction is enabled or disabled.
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.constraints.optionsSTRING[]Specifies the available options for noise block AI.
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.mutableBOOLEANIndicates whether noise block AI can be modified.
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.readableBOOLEANIndicates whether noise block AI can be read.
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.valueSTRINGIndicates the current noise block AI value.
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.constraints.optionsSTRING[]Specifies available noise control mode options for entity updates.
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.mutableBOOLEANIndicates whether noise control mode is enabled or disabled.
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.readableBOOLEANIndicates whether noise control mode is enabled or disabled for the device.
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.valueSTRINGSpecifies the current noise control mode of an audio device.
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.constraints.optionsSTRING[]Specifies the noise exposure limit options for audio settings.
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.mutableBOOLEANIndicates whether the noise exposure limit is modifiable.
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.readableBOOLEANIndicates whether the noise exposure limit is readable.
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.valueSTRINGSpecifies the noise exposure limit value for a headset.
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.constraints.optionsSTRING[]Specifies the primary audio volume options for a device.
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.mutableBOOLEANIndicates whether the primary audio volume is mutable or not.
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.readableBOOLEANIndicates whether the primary audio volume is readable or not.
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.valueSTRINGRepresents the current primary audio volume level as a string value.
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.constraints.optionsSTRING[]Indicates whether acoustic event reporting is enabled or disabled.
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.mutableBOOLEANIndicates whether acoustic events are reported for entity updates.
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.readableBOOLEANIndicates whether acoustic event data is in a readable format.
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.valueBOOLEAN | STRINGIndicates whether acoustic events are reported for entity updates.
payload.value.eventData.data.com.poly.audio.stereo._data.constraints.optionsSTRING[]Specifies audio stereo data constraints options for entity updates.
payload.value.eventData.data.com.poly.audio.stereo._data.mutableBOOLEANIndicates whether the audio is in stereo format or not.
payload.value.eventData.data.com.poly.audio.stereo._data.readableBOOLEANIndicates whether audio data is in a readable format for processing.
payload.value.eventData.data.com.poly.audio.stereo._data.valueSTRINGContains audio data for entity updates in various IoT events.
payload.value.eventData.data.com.poly.audio.streaming_audio._data.constraints.optionsSTRING[]Specifies audio streaming options for entity updates.
payload.value.eventData.data.com.poly.audio.streaming_audio._data.mutableBOOLEANIndicates whether audio streaming is enabled or disabled.
payload.value.eventData.data.com.poly.audio.streaming_audio._data.readableBOOLEANIndicates whether audio data is in a readable format for processing and analysis purposes.
payload.value.eventData.data.com.poly.audio.streaming_audio._data.valueSTRINGContains audio data for entity updates in various IoT events.
payload.value.eventData.data.com.poly.audio.tone_control._data.constraints.optionsSTRING[]Specifies available tone control options for audio settings.
payload.value.eventData.data.com.poly.audio.tone_control._data.mutableBOOLEANIndicates whether tone control is enabled or disabled for audio settings.
payload.value.eventData.data.com.poly.audio.tone_control._data.readableBOOLEANIndicates whether tone control data is readable for entity updates.
payload.value.eventData.data.com.poly.audio.tone_control._data.valueSTRINGStores audio tone control data for entity updates.
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.constraints.optionsSTRING[]Specifies audio transparency mode advanced options constraints.
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.mutableBOOLEANIndicates whether advanced audio transparency mode is enabled or disabled.
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.readableBOOLEANIndicates whether advanced transparency mode is enabled for audio.
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.valueSTRINGIndicates the transparency mode advanced audio setting for entity updates.
payload.value.eventData.data.com.poly.audio.transparency_mode._data.constraints.optionsSTRING[]Specifies audio transparency mode options for entity updates.
payload.value.eventData.data.com.poly.audio.transparency_mode._data.mutableBOOLEANIndicates whether audio transparency mode is enabled or disabled.
payload.value.eventData.data.com.poly.audio.transparency_mode._data.readableBOOLEANIndicates whether audio transparency mode is enabled or disabled.
payload.value.eventData.data.com.poly.audio.transparency_mode._data.valueSTRINGIndicates the current audio transparency mode setting for device configuration updates.
payload.value.eventData.data.com.poly.audio.treble._data.constraints.optionsSTRING[]Specifies the available treble options for audio configuration.
payload.value.eventData.data.com.poly.audio.treble._data.mutableBOOLEANIndicates whether the treble setting is mutable or not.
payload.value.eventData.data.com.poly.audio.treble._data.readableBOOLEANIndicates whether the treble setting is readable or not.
payload.value.eventData.data.com.poly.audio.treble._data.valueSTRINGIndicates the current treble setting as a string value.
payload.value.eventData.data.com.poly.audio.volume_alerts._data.constraints.optionsSTRING[]Specifies audio volume alert options.
payload.value.eventData.data.com.poly.audio.volume_alerts._data.mutableBOOLEANIndicates whether audio volume alerts can be modified.
payload.value.eventData.data.com.poly.audio.volume_alerts._data.readableBOOLEANIndicates whether audio volume alerts can be read.
payload.value.eventData.data.com.poly.audio.volume_alerts._data.valueSTRINGSpecifies the type of announcement heard when volume minimum and volume maximum are reached.
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.constraints.optionsSTRING[]Specifies volume level indicator options.
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.mutableBOOLEANIndicates whether volume level indicators can be modified.
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.readableBOOLEANIndicates whether volume level indicators are readable.
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.valueSTRINGSpecifies the volume level indicator setting for audio events.
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.constraints.optionsSTRING[]Specifies audio handling options for active calls in various events.
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.mutableBOOLEANIndicates whether the active call audio is currently muted or not.
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.readableBOOLEANIndicates whether the active call audio is in a readable format.
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.valueSTRINGSpecifies the current audio action for an active call.
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.constraints.optionsSTRING[]Specifies whether an audio prompt is played when answering a voice call.
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.mutableBOOLEANIndicates whether a voice prompt is played when answering a call.
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.readableBOOLEANIndicates whether a voice prompt is readable during a call control event.
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.valueSTRINGIndicates whether a voice prompt is played when answering a call.
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.constraints.optionsSTRING[]Specifies the available options for the answering call prompt.
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.mutableBOOLEANIndicates if the answering call prompt value can be modified.
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.readableBOOLEANIndicates if the answering call prompt value can be read.
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.valueSTRINGIndicates whether a prompt or tone is played when answering a call.
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.constraints.optionsSTRING[]Indicates a tone is played when adjusting audio.
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.mutableBOOLEANIndicates whether the audio channel tone can be modified.
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.readableBOOLEANIndicates whether the audio channel tone can be read.
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.valueSTRINGIndicates if a tone is played when adjusting audio.
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.constraints.optionsSTRING[]Specifies audio prompt volume options for entity updates.
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.mutableBOOLEANIndicates whether the audio prompt volume is mutable.
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.readableBOOLEANIndicates whether the audio prompt volume is in a readable format.
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.valueSTRINGSpecifies the audio prompt volume for call control events.
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.constraints.optionsSTRING[]Specifies audio sensing constraints options for entity updates.
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.mutableBOOLEANIndicates whether audio sensing is enabled for call control.
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.readableBOOLEANIndicates whether audio sensing data is in a readable format.
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.valueSTRINGContains audio sensing data for entity updates.
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.constraints.optionsSTRING[]Indicates whether auto-answer cradle is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.mutableBOOLEANIndicates whether auto answer is enabled for cradle call control.
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.readableBOOLEANIndicates whether auto answer cradle is enabled for call control.
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.valueSTRINGIndicates whether auto answer is enabled for call control.
payload.value.eventData.data.com.poly.call_control.auto_answer._data.constraints.optionsSTRING[]Specifies the available options for auto-answer.
payload.value.eventData.data.com.poly.call_control.auto_answer._data.mutableBOOLEANIndicates whether auto-answer is mutable.
payload.value.eventData.data.com.poly.call_control.auto_answer._data.readableBOOLEANIndicates whether auto-answer is readable.
payload.value.eventData.data.com.poly.call_control.auto_answer._data.valueSTRINGIndicates whether a headset will automatically answer an incoming call when the headset is removed from the charge cradle. Set to false to answer incoming calls by pressing the call control button.
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.constraints.optionsSTRING[]Specifies constraints for auto-connecting mobile devices in certain events.
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.mutableBOOLEANIndicates whether mobile auto-connect is enabled for call control.
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.readableBOOLEANIndicates whether auto connect mobile is enabled for call control.
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.valueSTRINGIndicates automatic mobile connection settings for call control events.
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.constraints.optionsSTRING[]Specifies options for automatic call disconnection when a cradle is used.
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.mutableBOOLEANIndicates whether a call is automatically disconnected when the cradle is used.
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.readableBOOLEANIndicates whether a call control feature is enabled for automatic disconnection.
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.valueSTRINGIndicates whether a call is automatically disconnected when the cradle is used.
payload.value.eventData.data.com.poly.call_control.auto_mute._data.constraints.optionsSTRING[]Specifies options for automatic mute control in certain events.
payload.value.eventData.data.com.poly.call_control.auto_mute._data.mutableBOOLEANIndicates whether automatic mute is enabled for call control.
payload.value.eventData.data.com.poly.call_control.auto_mute._data.readableBOOLEANIndicates whether auto-mute is enabled for a call.
payload.value.eventData.data.com.poly.call_control.auto_mute._data.valueSTRINGIndicates automatic mute status for call control events.
payload.value.eventData.data.com.poly.call_control.call_announcement._data.constraints.optionsSTRING[]Indicates whether a call announcement option is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.call_announcement._data.mutableBOOLEANIndicates whether a call announcement is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.call_announcement._data.readableBOOLEANIndicates whether call announcement data is in a readable format.
payload.value.eventData.data.com.poly.call_control.call_announcement._data.valueSTRINGIndicates whether a call announcement is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.constraints.optionsSTRING[]Specifies allowed options for call button lock constraints in entity update events.
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.mutableBOOLEANIndicates whether the call control button is locked or unlocked.
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.readableBOOLEANIndicates whether the call button lock is in a readable state.
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.valueSTRINGIndicates the status of call control button lock functionality.
payload.value.eventData.data.com.poly.call_control.caller_id._data.constraints.optionsSTRING[]Specifies caller identification constraints for certain entity updates.
payload.value.eventData.data.com.poly.call_control.caller_id._data.mutableBOOLEANIndicates whether the caller id is mutable in a call control event.
payload.value.eventData.data.com.poly.call_control.caller_id._data.readableBOOLEANIndicates whether the caller's identity is visible to the call recipient.
payload.value.eventData.data.com.poly.call_control.caller_id._data.valueSTRINGIndicates whether the caller id is enabled or disabled for the call.
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.constraints.optionsSTRING[]Specifies conversation limitation options as a string value.
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.mutableBOOLEANIndicates whether a conversation has reached its closure limit.
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.readableBOOLEANIndicates whether a conversation has reached its closing limit.
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.valueSTRINGIndicates the level of conversation limiting applied to a call.
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.constraints.optionsSTRING[]Specifies audio bandwidth constraints for computer audio options.
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.mutableBOOLEANIndicates whether computer audio bandwidth is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.readableBOOLEANIndicates whether the computer audio bandwidth is readable or not.
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.valueSTRINGSpecifies the computer audio bandwidth for call control events.
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.constraints.optionsSTRING[]Specifies the available ringtone sound options for computer calls.
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.mutableBOOLEANIndicates whether the computer ringtone is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.readableBOOLEANIndicates whether the computer ringtone is in a readable state.
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.valueSTRINGSpecifies the computer ringtone sound used for entity updates.
payload.value.eventData.data.com.poly.call_control.computer_volume._data.constraints.optionsSTRING[]Specifies the available volume control options for computer audio output.
payload.value.eventData.data.com.poly.call_control.computer_volume._data.mutableBOOLEANIndicates whether the computer volume is currently muted or not.
payload.value.eventData.data.com.poly.call_control.computer_volume._data.readableBOOLEANIndicates whether the computer volume is readable as a boolean value.
payload.value.eventData.data.com.poly.call_control.computer_volume._data.valueSTRINGIndicates the current computer volume setting as a string value.
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.constraints.optionsSTRING[]Specifies the available phone line options for call control events.
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.mutableBOOLEANIndicates whether the default phone line is enabled or disabled for call control.
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.readableBOOLEANIndicates whether the phone line is in a readable state or not.
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.valueSTRINGIndicates the default phone line type used for call control operations.
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.constraints.optionsSTRING[]Specifies the options available for default ringtone.
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.mutableBOOLEANIndicates whether a default ringtone is modifiable.
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.readableBOOLEANIndicates whether the default ringtone is readable.
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.valueSTRINGIndicates whether the default ringtone is enabled or disabled for call control.
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.constraints.optionsSTRING[]Specifies audio bandwidth constraints for desk phone calls.
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.mutableBOOLEANIndicates whether the desk phone audio bandwidth is mutable or not.
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.readableBOOLEANIndicates whether the audio bandwidth is readable for the desk phone.
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.valueSTRINGSpecifies the audio bandwidth for desk phone calls in entity update events.
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.constraints.optionsSTRING[]Specifies available options for desk phone ringtone configuration settings.
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.mutableBOOLEANIndicates whether the desk phone ringtone is currently muted or not.
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.readableBOOLEANIndicates whether the desk phone ringtone is in a readable format or not.
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.valueSTRINGSpecifies the desk phone ringtone data for entity updates.
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.constraints.optionsSTRING[]Specifies the available volume control options for a desk phone.
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.mutableBOOLEANIndicates whether the desk phone volume is muted or not.
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.readableBOOLEANIndicates whether the desk phone volume is in a readable state.
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.valueSTRINGIndicates the current volume setting of a desk phone.
payload.value.eventData.data.com.poly.call_control.dialtone._data.constraints.optionsSTRING[]Specifies the valid options for the dialtone setting.
payload.value.eventData.data.com.poly.call_control.dialtone._data.mutableBOOLEANIndicates whether a dialtone is mutable.
payload.value.eventData.data.com.poly.call_control.dialtone._data.readableBOOLEANIndicates whether a dialtone is readable.
payload.value.eventData.data.com.poly.call_control.dialtone._data.valueSTRINGIndicates whether a dialtone will be heard for a VoIP call when a user presses the headset's call button.
payload.value.eventData.data.com.poly.call_control.hd_voice._data.constraints.optionsSTRING[]Specifies available options for hd voice.
payload.value.eventData.data.com.poly.call_control.hd_voice._data.mutableBOOLEANIndicates whether hd voice is modifiable.
payload.value.eventData.data.com.poly.call_control.hd_voice._data.readableBOOLEANIndicates whether hd voice is readable.
payload.value.eventData.data.com.poly.call_control.hd_voice._data.valueSTRINGEnable hd voice / wideband audio to enhance speech clarity if the phone and service carrier also support the feature.
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.constraints.optionsSTRING[]Indicates whether a hold reminder option is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.mutableBOOLEANIndicates whether a call hold reminder is active or not.
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.readableBOOLEANIndicates whether a call hold reminder is active or not.
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.valueSTRINGIndicates whether a call hold reminder is active or not.
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.constraints.optionsSTRING[]Specifies options for adjusting headset volume during a call.
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.mutableBOOLEANIndicates whether to increase the headset volume during a call.
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.readableBOOLEANIndicates whether the headset volume can be increased.
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.valueSTRINGRepresents the value associated with a specific call control event.
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.constraints.optionsSTRING[]Specifies available ringtone options for mobile phone call control events.
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.mutableBOOLEANIndicates whether the mobile phone ringtone is muted or not.
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.readableBOOLEANIndicates whether the mobile phone ringtone data is readable.
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.valueSTRINGStores the mobile phone ringtone data for entity updates.
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.constraints.optionsSTRING[]Specifies the available volume control options for mobile phone devices.
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.mutableBOOLEANIndicates whether the mobile phone volume is muted or not.
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.readableBOOLEANIndicates whether the mobile phone volume is in a readable state.
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.valueSTRINGRepresents the mobile phone volume setting as a string value.
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.constraints.optionsSTRING[]Specifies the available options for mobile voice commands in certain events.
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.mutableBOOLEANIndicates whether mobile voice commands are enabled or disabled.
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.readableBOOLEANIndicates whether mobile voice commands data is readable or not.
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.valueSTRINGIndicates whether mobile voice commands are enabled or disabled.
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.constraints.optionsSTRING[]Specifies the type of mute alert for call control events.
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.mutableBOOLEANIndicates whether a mute alert is active or not in a call control event.
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.readableBOOLEANIndicates whether a call control mute alert type is readable or not.
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.valueSTRINGIndicates the type of mute alert for call control events.
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.constraints.optionsSTRING[]Specifies the available audio options for mute alerts.
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.mutableBOOLEANIndicates whether mute alert is configurable.
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.readableBOOLEANIndicates whether mute alert is readable.
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.valueSTRINGIndicates the type of tone or audio alert used for mute notifications.
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.constraints.optionsSTRING[]Specifies audio alert options for entity updates.
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.mutableBOOLEANIndicates whether the call control mute off alert is active or not.
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.readableBOOLEANIndicates whether the call control mute off alert is active or not.
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.valueSTRINGIndicates whether the call control mute off alert is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.constraints.optionsSTRING[]Specifies the available audio options for a mute reminder.
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.mutableBOOLEANIndicates whether mute reminder can be modified.
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.readableBOOLEANIndicates whether mute reminder is readable.
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.valueSTRINGIndicates the how the user will be notified of a mute reminder.
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.constraints.optionsSTRING[]Specifies the available options for mute reminder timing.
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.mutableBOOLEANIndicates whether a mute reminder timing is modifiable.
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.readableBOOLEANIndicates whether a mute reminder timing is readable
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.valueSTRINGSpecifies the timing for mute reminders.
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.constraints.optionsSTRING[]Specifies the available volume options for mute reminder notifications.
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.mutableBOOLEANIndicates whether the mute reminder volume is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.readableBOOLEANIndicates whether the mute reminder volume is readable in certain entity update events.
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.valueSTRINGIndicates the volume level for mute reminders in call control events.
payload.value.eventData.data.com.poly.call_control.notification_tones._data.constraints.optionsSTRING[]Specifies the available options for notification tones.
payload.value.eventData.data.com.poly.call_control.notification_tones._data.mutableBOOLEANIndicates whether the notification tones setting is modifiable.
payload.value.eventData.data.com.poly.call_control.notification_tones._data.readableBOOLEANIndicates whether the notification tones setting is readable.
payload.value.eventData.data.com.poly.call_control.notification_tones._data.valueSTRINGEnables notification tones from other connected devices while streaming audio.
payload.value.eventData.data.com.poly.call_control.online_indicator._data.constraints.optionsSTRING[]Specifies the available options for online indicator.
payload.value.eventData.data.com.poly.call_control.online_indicator._data.mutableBOOLEANIndicates whether the online indicator is modifiable.
payload.value.eventData.data.com.poly.call_control.online_indicator._data.readableBOOLEANIndicates whether the online indicator is readable.
payload.value.eventData.data.com.poly.call_control.online_indicator._data.valueSTRINGindicates whether the LED indicator on a device is enabled while on a call.
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.constraints.optionsSTRING[]Specifies options for over-the-air subscription constraints in entity update events.
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.mutableBOOLEANIndicates whether an over-the-air subscription is mutable or not.
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.readableBOOLEANIndicates whether the call control subscription data is readable over the air.
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.valueSTRINGContains call control data for entity updates.
payload.value.eventData.data.com.poly.call_control.range._data.constraints.optionsSTRING[]Specifies options for call control range constraints in entity update events.
payload.value.eventData.data.com.poly.call_control.range._data.mutableBOOLEANIndicates whether call control range data is mutable or not.
payload.value.eventData.data.com.poly.call_control.range._data.readableBOOLEANIndicates whether call control data is in a readable format.
payload.value.eventData.data.com.poly.call_control.range._data.valueSTRINGContains call control range data for entity updates.
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.constraints.optionsSTRING[]Specifies options for ring vibration settings in device configurations.
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.mutableBOOLEANIndicates whether the device is set to vibrate during an incoming call.
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.readableBOOLEANIndicates whether the ring vibration setting is in a readable state.
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.valueSTRINGIndicates the ring or vibration status of a call.
payload.value.eventData.data.com.poly.call_control.rocket_button._data.constraints.optionsSTRING[]Specifies the available options for the custom action button.
payload.value.eventData.data.com.poly.call_control.rocket_button._data.mutableBOOLEANIndicates whether the custom action button is modifiable.
payload.value.eventData.data.com.poly.call_control.rocket_button._data.readableBOOLEANIndicates whether the custom action button is readable.
payload.value.eventData.data.com.poly.call_control.rocket_button._data.valueSTRINGAssign the function for the custom action button.
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.constraints.optionsSTRING[]Specifies the available handling options for incoming calls from a second source.
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.mutableBOOLEANIndicates whether a second incoming call is modifiable or not.
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.readableBOOLEANIndicates whether a second incoming call is readable or not.
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.valueSTRINGSpecifies the handling of ring behavior for incoming calls from a second source.
payload.value.eventData.data.com.poly.call_control.sidetone._data.constraints.optionsSTRING[]Specifies the available audio constraint options for the sidetone control.
payload.value.eventData.data.com.poly.call_control.sidetone._data.mutableBOOLEANIndicates whether the sidetone data is modifiable or not.
payload.value.eventData.data.com.poly.call_control.sidetone._data.readableBOOLEANIndicates whether the sidetone data is readable or not.
payload.value.eventData.data.com.poly.call_control.sidetone._data.valueSTRINGIndicates the volume of the speaker's voice heard when speaking.
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.constraints.optionsSTRING[]Specifies audio transfer options for smart call control functionality.
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.mutableBOOLEANIndicates whether smart audio transfer is enabled or disabled.
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.readableBOOLEANIndicates whether smart audio transfer data is readable or not.
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.valueSTRINGContains data related to smart audio transfer in entity update events.
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.constraints.optionsSTRING[]Specifies wearable device configuration options for entity updates.
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.mutableBOOLEANIndicates whether a wearable device is being worn or not.
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.readableBOOLEANIndicates whether the wearing preference data is in a readable format.
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.valueSTRINGStores the user's wearing preference for call control events.
payload.value.eventData.data.com.poly.device.pid._data.constraints.optionsSTRING[]Specifies data constraints for a device pid.
payload.value.eventData.data.com.poly.device.pid._data.mutableBOOLEANIndicates whether device pid is mutable.
payload.value.eventData.data.com.poly.device.pid._data.readableBOOLEANIndicates whether device pid is readable.
payload.value.eventData.data.com.poly.device.pid._data.valueNUMBERIdentifies a unique device product identifier.
payload.value.eventData.data.com.poly.device.serial_number._data.constraints.optionsSTRING[]Specifies data constraints for a device serial number.
payload.value.eventData.data.com.poly.device.serial_number._data.mutableBOOLEANIndicates whether the device serial number is mutable.
payload.value.eventData.data.com.poly.device.serial_number._data.readableBOOLEANIndicates whether a device's serial number is readable.
payload.value.eventData.data.com.poly.device.serial_number._data.valueSTRINGIdentifies a unique serial number for a device.
payload.value.eventData.data.com.poly.device.software_version._data.constraints.optionsSTRING[]Specifies data constraints for a device's software version.
payload.value.eventData.data.com.poly.device.software_version._data.mutableBOOLEANIndicates whether the device software version data is mutable.
payload.value.eventData.data.com.poly.device.software_version._data.readableBOOLEANIndicates whether the device software version is readable.
payload.value.eventData.data.com.poly.device.software_version._data.valueSTRINGSpecifies the software version of a device.
payload.value.eventData.data.com.poly.general.battery_charging._data.constraints.optionsSTRING[]Specifies available battery charging options for entity updates.
payload.value.eventData.data.com.poly.general.battery_charging._data.mutableBOOLEANIndicates whether the device's battery is currently being charged.
payload.value.eventData.data.com.poly.general.battery_charging._data.readableBOOLEANIndicates whether the device's battery is currently being charged.
payload.value.eventData.data.com.poly.general.battery_charging._data.valueSTRINGIndicates the device's battery charging status as a string value.
payload.value.eventData.data.com.poly.general.battery_level._data.constraints.optionsSTRING[]Specifies possible values for the battery level data field in entity update events.
payload.value.eventData.data.com.poly.general.battery_level._data.mutableBOOLEANIndicates whether the device battery level is mutable or not.
payload.value.eventData.data.com.poly.general.battery_level._data.readableBOOLEANIndicates whether the battery level is readable or not.
payload.value.eventData.data.com.poly.general.battery_level._data.valueSTRINGRepresents the current battery level of a device in various entity update messages.
payload.value.eventData.data.com.poly.general.battery_status_alert._data.constraints.optionsSTRING[]Specifies available options for battery status.
payload.value.eventData.data.com.poly.general.battery_status_alert._data.mutableBOOLEANIndicates whether a battery status alert is mutable.
payload.value.eventData.data.com.poly.general.battery_status_alert._data.readableBOOLEANIndicates whether a battery status alert is readable.
payload.value.eventData.data.com.poly.general.battery_status_alert._data.valueSTRINGIndicates whether to hear a device's battery status when powered on.
payload.value.eventData.data.com.poly.general.charge_vibration._data.constraints.optionsSTRING[]Specifies available vibration options for device configuration.
payload.value.eventData.data.com.poly.general.charge_vibration._data.mutableBOOLEANIndicates whether vibration charge data is mutable.
payload.value.eventData.data.com.poly.general.charge_vibration._data.readableBOOLEANIndicates whether vibration charge data is readable.
payload.value.eventData.data.com.poly.general.charge_vibration._data.valueSTRINGSpecifies if the headset will vibrate to confirm that it is charging.
payload.value.eventData.data.com.poly.general.is_online._data.constraints.optionsSTRING[]Specifies online status options for entity updates in various events.
payload.value.eventData.data.com.poly.general.is_online._data.mutableBOOLEANIndicates whether a device or entity is currently online or not.
payload.value.eventData.data.com.poly.general.is_online._data.readableBOOLEANIndicates whether a device or entity is currently online or not.
payload.value.eventData.data.com.poly.general.is_online._data.valueSTRINGIndicates whether a device or entity is currently online or not.
payload.value.eventData.data.com.poly.general.language._data.constraints.optionsSTRING[]Specifies language options for entity updates in various events.
payload.value.eventData.data.com.poly.general.language._data.mutableBOOLEANIndicates whether language data is mutable in entity update events.
payload.value.eventData.data.com.poly.general.language._data.readableBOOLEANIndicates whether language data is readable in entity update events.
payload.value.eventData.data.com.poly.general.language._data.valueSTRINGStores language data for entity updates in various IoT events.
payload.value.eventData.data.com.poly.general.restore_defaults._data.constraints.optionsSTRING[]Specifies configuration options for device restore defaults operations.
payload.value.eventData.data.com.poly.general.restore_defaults._data.mutableBOOLEANIndicates whether device settings have been restored to default values.
payload.value.eventData.data.com.poly.general.restore_defaults._data.readableBOOLEANIndicates whether device settings have been restored to default values.
payload.value.eventData.data.com.poly.general.restore_defaults._data.valueSTRINGStores data related to restoring default settings in entity update events.
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.constraints.optionsSTRING[]Specifies available options for sensor settings in entity update events.
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.mutableBOOLEANIndicates whether sensor settings are enabled or disabled.
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.readableBOOLEANIndicates whether sensor settings are enabled and readable.
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.valueSTRINGIndicates whether sensor settings are enabled for a device or entity.
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.constraints.optionsSTRING[]Specifies options for HP Camera Control (hpcc) on a Lens Room system.
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.mutableBOOLEANIndicates whether HP Camera Control (hpcc) is mutable.
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.readableBOOLEANIndicates whether HP Camera Control (hpcc) is readable.
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.valueBOOLEANSpecifies if hpcc is enabled or disabled.
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.mutableBOOLEANIndicates whether the HP Camera Control (hpcc) version data is mutable.
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.readableBOOLEANIndicates whether the HP Camera Control (hpcc) version data is readable.
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.valueSTRINGspecifies the HP Camera Control (hpcc) version.
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.constraints.optionsSTRING[]Indicates the settings available to postpone device firmware updates.
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.mutableBOOLEANIndicates whether firmware update postponement is allowed for a device.
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.readableBOOLEANIndicates whether firmware update postponement can be read from a device.
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.valueNUMBERIndicates if device firmware update can be postponed.
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.constraints.optionsSTRING[]Specifies the allowed times for postponing software updates.
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.mutableBOOLEANIndicates whether software updates can be postponed at a later time.
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.readableBOOLEANIndicates whether software update postponement times are allowed to be read.
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.valueNUMBERSpecifies the number of times a software update can be postponed.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.constraints.optionsSTRING[]Specifies data constraints for the software update window end time.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.mutableBOOLEANIndicates whether the software update end time is mutable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.readableBOOLEANIndicates whether the software update end time is readable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.valueSTRINGSpecifies the end time for the software update window.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.constraints.optionsSTRING[]Specifies data constraints for the software update check interval.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.mutableBOOLEANIndicates whether the software update policy timeframe interval is mutable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.readableBOOLEANIndicates whether the software update policy timeframe interval is readable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.valueSTRINGSpecifies how often the system should check for software updates in the update window.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.constraints.optionsSTRING[]Specifies data constraints for the software update window start time.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.mutableBOOLEANIndicates whether the software update policy start time is mutable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.readableBOOLEANIndicates whether the software update start time is readable.
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.valueSTRINGSpecifies the start time for the software update window.
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.constraints.optionsSTRING[]Specifies data constraints for the disable software update property.
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.mutableBOOLEANIndicates whether the disable software update policy property is mutable.
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.readableBOOLEANIndicates whether the disable software update policy property is readable.
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.valueBOOLEANSpecifies whether software updates are enabled or disabled.
payload.value.eventData.data.com.poly.video.anti_flicker._data.constraints.optionsSTRING[]Specifies video anti-flicker options for a video device.
payload.value.eventData.data.com.poly.video.anti_flicker._data.mutableBOOLEANIndicates whether anti-flicker is modifiable.
payload.value.eventData.data.com.poly.video.anti_flicker._data.readableBOOLEANIndicates whether anti-flicker is readable.
payload.value.eventData.data.com.poly.video.anti_flicker._data.valueSTRINGIndicates the anti-flicker setting value for a video device.
payload.value.eventData.data.com.poly.video.back_light_compensation._data.constraints.optionsSTRING[]Specifies the available back light compensation options for video settings.
payload.value.eventData.data.com.poly.video.back_light_compensation._data.mutableBOOLEANIndicates whether back light compensation is mutable.
payload.value.eventData.data.com.poly.video.back_light_compensation._data.readableBOOLEANIndicates whether back light compensation is mutable.
payload.value.eventData.data.com.poly.video.back_light_compensation._data.valueSTRINGIndicates whether back light compensation is enabled or disabled.
payload.value.eventData.data.com.poly.video.brightness._data.constraints.optionsSTRING[]Specifies the available brightness options for video settings.
payload.value.eventData.data.com.poly.video.brightness._data.mutableBOOLEANIndicates whether the video brightness is adjustable.
payload.value.eventData.data.com.poly.video.brightness._data.readableBOOLEANIndicates whether video brightness data is readable or not.
payload.value.eventData.data.com.poly.video.brightness._data.valueSTRINGRepresents the brightness level of a video device.
payload.value.eventData.data.com.poly.video.camera_movement._data.constraints.optionsSTRING[]Specifies video camera movement options.
payload.value.eventData.data.com.poly.video.camera_movement._data.mutableBOOLEANIndicates whether camera movement is mutable.
payload.value.eventData.data.com.poly.video.camera_movement._data.readableBOOLEANIndicates whether camera movement is readable.
payload.value.eventData.data.com.poly.video.camera_movement._data.valueSTRINGIndicates the camera movement behavior.
payload.value.eventData.data.com.poly.video.contrast._data.constraints.optionsSTRING[]Specifies video contrast options.
payload.value.eventData.data.com.poly.video.contrast._data.mutableBOOLEANIndicates whether the video contrast setting is mutable or not.
payload.value.eventData.data.com.poly.video.contrast._data.readableBOOLEANIndicates whether video contrast data is readable.
payload.value.eventData.data.com.poly.video.contrast._data.valueSTRINGRepresents the video contrast setting as a numeric string value.
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.constraints.optionsSTRING[]Indicates options for auto video exposure.
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.mutableBOOLEANIndicates whether automatic exposure is mutable.
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.readableBOOLEANIndicates whether automatic exposure is readable.
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.valueBOOLEAN | STRINGIndicates whether auto exposure is enabled for video capture.
payload.value.eventData.data.com.poly.video.exposure._data.constraints.optionsSTRING[]Specifies video exposure constraints.
payload.value.eventData.data.com.poly.video.exposure._data.mutableBOOLEANIndicates whether video exposure is mutable.
payload.value.eventData.data.com.poly.video.exposure._data.readableBOOLEANIndicates whether video exposure data is readable.
payload.value.eventData.data.com.poly.video.exposure._data.valueSTRINGIndicates the video exposure value.
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.constraints.optionsSTRING[]Specifies auto focus constraints.
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.mutableBOOLEANIndicates whether auto focus for video is mutable.
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.readableBOOLEANIndicates whether auto focus for video is readable.
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.valueBOOLEAN | STRINGIndicates whether auto focus is enabled for video.
payload.value.eventData.data.com.poly.video.focus._data.constraints.optionsSTRING[]Specifies video focus constraints.
payload.value.eventData.data.com.poly.video.focus._data.mutableBOOLEANIndicates whether the video focus mutable.
payload.value.eventData.data.com.poly.video.focus._data.readableBOOLEANIndicates whether the video focus readable.
payload.value.eventData.data.com.poly.video.focus._data.valueSTRINGSpecifies the video focus value.
payload.value.eventData.data.com.poly.video.frame_size._data.constraints.optionsSTRING[]Specifies video frame size constraints.
payload.value.eventData.data.com.poly.video.frame_size._data.mutableBOOLEANIndicates whether the video frame size data is mutable.
payload.value.eventData.data.com.poly.video.frame_size._data.readableBOOLEANIndicates whether video frame size data is readable.
payload.value.eventData.data.com.poly.video.frame_size._data.valueSTRINGSpecifies the video frame size.
payload.value.eventData.data.com.poly.video.gain._data.constraints.optionsSTRING[]Specifies the available video gain options.
payload.value.eventData.data.com.poly.video.gain._data.mutableBOOLEANIndicates whether the video gain is mutable.
payload.value.eventData.data.com.poly.video.gain._data.readableBOOLEANIndicates whether video gain data is readable.
payload.value.eventData.data.com.poly.video.gain._data.valueSTRINGSpecifies the video gain value.
payload.value.eventData.data.com.poly.video.gamma._data.constraints.optionsSTRING[]Specifies the available gamma correction options.
payload.value.eventData.data.com.poly.video.gamma._data.mutableBOOLEANIndicates whether video gamma correction is mutable.
payload.value.eventData.data.com.poly.video.gamma._data.readableBOOLEANIndicates whether video gamma correction is readable.
payload.value.eventData.data.com.poly.video.gamma._data.valueSTRINGSpecifies the gamma value for video settings.
payload.value.eventData.data.com.poly.video.hue._data.constraints.optionsSTRING[]Specifies the available options for video hue.
payload.value.eventData.data.com.poly.video.hue._data.mutableBOOLEANIndicates whether video hue is mutable.
payload.value.eventData.data.com.poly.video.hue._data.readableBOOLEANIndicates whether video hue is readable.
payload.value.eventData.data.com.poly.video.hue._data.valueSTRINGSpecifies the hue value.
payload.value.eventData.data.com.poly.video.image_flip._data.constraints.optionsSTRING[]Specifies the image flip options.
payload.value.eventData.data.com.poly.video.image_flip._data.mutableBOOLEANIndicates whether video image flip is mutable.
payload.value.eventData.data.com.poly.video.image_flip._data.readableBOOLEANIndicates whether video image flip is readable.
payload.value.eventData.data.com.poly.video.image_flip._data.valueSTRINGIndicates whether video image flip is enabled or disabled.
payload.value.eventData.data.com.poly.video.max_zoom._data.constraints.optionsSTRING[]Specifies the maximum zoom options..
payload.value.eventData.data.com.poly.video.max_zoom._data.mutableBOOLEANIndicates whether the maximum zoom level is mutable.
payload.value.eventData.data.com.poly.video.max_zoom._data.readableBOOLEANIndicates whether the maximum zoom value is readable.
payload.value.eventData.data.com.poly.video.max_zoom._data.valueSTRINGSpecifies the maximum zoom level for video.
payload.value.eventData.data.com.poly.video.pan._data.constraints.optionsSTRING[]Specifies the video pan constraints.
payload.value.eventData.data.com.poly.video.pan._data.mutableBOOLEANIndicates whether video pan data is modifiable or not.
payload.value.eventData.data.com.poly.video.pan._data.readableBOOLEANIndicates whether video pan data is readable or not.
payload.value.eventData.data.com.poly.video.pan._data.valueSTRINGSpecifies the video pan value.
payload.value.eventData.data.com.poly.video.participant_count._data.constraints.optionsSTRING[]Specifies constraints for video participant count.
payload.value.eventData.data.com.poly.video.participant_count._data.mutableBOOLEANIndicates whether the video participant count is mutable.
payload.value.eventData.data.com.poly.video.participant_count._data.readableBOOLEANIndicates whether the video participant count is readable.
payload.value.eventData.data.com.poly.video.participant_count._data.valueSTRINGSpecifies if video participant count is enabled or disabled.
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.constraints.optionsSTRING[]Specifies constraints for Poly perimeter configuration.
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.mutableBOOLEANIndicates whether the Poly perimeter depth is mutable.
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.readableBOOLEANIndicates whether the Poly perimeter depth is readable.
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.valueSTRINGSpecifies the depth value of the Poly perimeter.
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.constraints.optionsSTRING[]Specifies data constraints for Poly perimeter enabled.
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.mutableBOOLEANIndicates whether the Poly perimeter enabled data is mutable.
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.readableBOOLEANIndicates whether the Poly perimeter enabled data is readable.
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.valueBOOLEAN | STRINGSpecifies whether the Poly perimeter is enabled or disabled.
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.constraints.optionsSTRING[]Specifies data constraints for Poly perimeter front value.
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.mutableBOOLEANIndicates whether the Poly perimeter front is mutable.
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.readableBOOLEANIndicates whether the Poly perimeter front is readable.
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.valueSTRINGSpecifies the Poly perimeter front value.
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.constraints.optionsSTRING[]Specifies the unit of measure options for Poly perimeter
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.mutableBOOLEANIndicates whether a Poly perimeter metric is mutable.
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.readableBOOLEANIndicates whether a Poly perimeter metric is readable.
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.valueSTRINGSpecifies the unit of measure for Poly perimeter.
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.constraints.optionsSTRING[]Specifies data constraints for Poly perimeter width.
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.mutableBOOLEANIndicates whether a Poly perimeter width is mutable.
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.readableBOOLEANIndicates whether a Poly perimeter width is readable.
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.valueSTRINGSpecifies the width of the Poly perimeter.
payload.value.eventData.data.com.poly.video.saturation._data.constraints.optionsSTRING[]Specifies video saturation options.
payload.value.eventData.data.com.poly.video.saturation._data.mutableBOOLEANIndicates whether video saturation is mutable.
payload.value.eventData.data.com.poly.video.saturation._data.readableBOOLEANIndicates whether video saturation is readable.
payload.value.eventData.data.com.poly.video.saturation._data.valueSTRINGSpecifies the video saturation level.
payload.value.eventData.data.com.poly.video.sharpness._data.constraints.optionsSTRING[]Specifies video sharpness options.
payload.value.eventData.data.com.poly.video.sharpness._data.mutableBOOLEANIndicates whether video sharpness is configurable.
payload.value.eventData.data.com.poly.video.sharpness._data.readableBOOLEANIndicates whether video sharpness data is readable.
payload.value.eventData.data.com.poly.video.sharpness._data.valueSTRINGSpecifies the video sharpness level as a numeric string value.
payload.value.eventData.data.com.poly.video.tilt._data.constraints.optionsSTRING[]Specifies the available tilt options for video devices.
payload.value.eventData.data.com.poly.video.tilt._data.mutableBOOLEANIndicates whether video tilt is modifiable.
payload.value.eventData.data.com.poly.video.tilt._data.readableBOOLEANIndicates whether video tilt is readable.
payload.value.eventData.data.com.poly.video.tilt._data.valueSTRINGRepresents the tilt value of a video device.
payload.value.eventData.data.com.poly.video.tracking_mode._data.constraints.optionsSTRING[]Specifies video tracking mode options
payload.value.eventData.data.com.poly.video.tracking_mode._data.mutableBOOLEANIndicates whether video tracking mode is modifiable.
payload.value.eventData.data.com.poly.video.tracking_mode._data.readableBOOLEANIndicates whether video tracking mode is readable.
payload.value.eventData.data.com.poly.video.tracking_mode._data.valueSTRINGSpecifies the current video tracking mode in use.
payload.value.eventData.data.com.poly.video.tracking_speed._data.constraints.optionsSTRING[]Specifies available video tracking speed options.
payload.value.eventData.data.com.poly.video.tracking_speed._data.mutableBOOLEANIndicates whether video tracking speed can be modified.
payload.value.eventData.data.com.poly.video.tracking_speed._data.readableBOOLEANIndicates whether video tracking speed is readable.
payload.value.eventData.data.com.poly.video.tracking_speed._data.valueSTRINGSpecifies the the video tracking speed setting.
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.constraints.optionsSTRING[]Specifies options for automatic white balance.
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.mutableBOOLEANIndicates whether automatic white balance can be modified.
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.readableBOOLEANIndicates whether automatic white balance is readable.
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.valueBOOLEAN | STRINGIndicates whether automatic white balance is enabled for a camera.
payload.value.eventData.data.com.poly.video.white_balance._data.constraints.optionsSTRING[]Specifies available white balance options.
payload.value.eventData.data.com.poly.video.white_balance._data.mutableBOOLEANIndicates whether video white balance is mutable.
payload.value.eventData.data.com.poly.video.white_balance._data.readableBOOLEANIndicates whether video white balance is readable.
payload.value.eventData.data.com.poly.video.white_balance._data.valueSTRINGRepresents the white balance value for a camera.
payload.value.eventData.data.com.poly.video.zoom._data.constraints.optionsSTRING[]Specifies the available zoom options for video.
payload.value.eventData.data.com.poly.video.zoom._data.mutableBOOLEANIndicates whether video zoom is modifiable.
payload.value.eventData.data.com.poly.video.zoom._data.readableBOOLEANIndicates whether video zoom is readable.
payload.value.eventData.data.com.poly.video.zoom._data.valueSTRINGRepresents the video zoom level.
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.constraints.optionsSTRING[]Specifies options for clearing trusted devices in entity update events.
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.mutableBOOLEANIndicates whether trusted devices should be cleared from the system configuration.
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.readableBOOLEANIndicates whether trusted devices have been cleared from the system.
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.valueSTRINGContains data for clearing trusted devices in entity update events.
payload.value.eventData.data.com.poly.wireless.connection_indication._data.constraints.optionsSTRING[]Specifies possible values for wireless connection indication.
payload.value.eventData.data.com.poly.wireless.connection_indication._data.mutableBOOLEANIndicates whether the wireless connection data is mutable.
payload.value.eventData.data.com.poly.wireless.connection_indication._data.readableBOOLEANIndicates whether the wireless connection data is readable.
payload.value.eventData.data.com.poly.wireless.connection_indication._data.valueSTRINGIndicates the connection status of a wireless device.
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.constraints.optionsSTRING[]Specifies configuration options for maintaining wireless link connectivity.
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.mutableBOOLEANIndicates whether the link should remain active for entity updates.
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.readableBOOLEANIndicates whether the keep link up feature is enabled or disabled.
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.valueSTRINGStores data related to keeping a wireless link active and up.
payload.value.eventData.entity_idSTRINGA unique identifier for the device.
payload.value.eventTimeSTRINGRepresents the timestamp of an event occurrence in ISO format.
payload.value.eventTypeSTRINGIdentifies the type of event occurring on a device or system.
payload.value.eventVersionSTRINGSpecifies the version of the event being reported or tracked.
payload.versionSTRINGIndicates the version of the payload in various device and activity events.
typeSTRINGIndicates the event or message classification as request, response, or telemetry data.