This object defines a voice or video device which can either register with the Polycom Call Server through H.323 and/or SIP or be manually added. Currently this includes both hard and soft endpoint and MCUs. While the intent of this module is for devices which register themselves with the Call Server, it also allows for endpoint and MCUs which are manually added to the Call Server, but not registered through H.323 or SIP. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmPolyEvoIdentity | PlcmPolyEvoIdentity | See Definition of PlcmPolyEvoIdentity | |
| deviceAdmissionPolicy | PlcmDeviceAdmissionPolicyEnum | ||
| callForwardingRuleList | PlcmCallForwardingRuleList | ||
| plcmDeviceStatus | PlcmDeviceStatus | See Definition of PlcmDeviceStatus | |
| atomLinkList | Array of Link | See Definition of Link | |
| plcmMcuIdentity | PlcmMcuIdentity | See Definition of PlcmMcuIdentity | |
| plcmSipIdentityV2 | PlcmSipIdentityV2 | See Definition of PlcmSipIdentityV2 | |
| plcmIsdnIdentity | PlcmIsdnIdentity | See Definition of PlcmIsdnIdentity | |
| plcmH323IdentityV2 | PlcmH323IdentityV2 | See Definition of PlcmH323IdentityV2 | |
| plcmServiceClassV2 | PlcmServiceClassV2 | See Definition of PlcmServiceClassV2 | |
| deviceIdentifier | DeviceIdentifier | The Call Server device identifier. This is read-only for clients. | |
| deviceName | string | Indicates device name. | |
| deviceOwner | string | The user account associated with the device, i.e the device owner. | |
| ownerDomain | string | The domain of the user account. | |
| deviceModel | string | Model of the device. | |
| deviceVersion | string | Device software version. | |
| registrationIdentifier | string | Unique identifier of the devices registration with the call server. | |
| allowInactivityDeletion | boolean | Allow the device to be automatically deleted if its registration is inactive for a prolonged period of time. The amount of time a device must be inactive for is based on the settings of the Call Server's registration policy. This will be set to true by default when a new device is created. | |
| registrationDirection | RegistrationDirection | Direction of the device registration. This value is read-only for clients. | |
| overrideDefaultServiceClass | boolean | When true, plcm-service-class-v2 must be specified in the request. When false, plcm-service-class-v2 value will be determined by the system default. | |
| supportsH323 | boolean | Flag indicating if the device supports H.323. | |
| supportsIsdn | boolean | Flag indicating if the device supports ISDN. | |
| supportsSip | boolean | Flag indicating if the device supports SIP | |
| supportsPolyEvo | boolean | Flag indicating if the device supports Poly EVO. | |
| hasMcuCapabilities | boolean | Flag indicating if the device has MCU capabilities. | |
| ipAddress | string | Device IP address. | |
| areaIdentifier | string | Indicates to which area device belongs to. | |
| schedulerDevice | boolean | Indicates if device can be scheduled or not. | |
| passback | Passback | User defined value for that is opaque to the system | |
| passthru | Passthru | User defined value that that is opaque to the system. Note: that this parameter can be used to pass through to other, internal, persistent areas of the system such as Call Data Records. | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. | |
| deviceType | string | Device type, only available from Resource Manager | |
| manageMode | string | Manage mode: VC2 mode or blank, only available from Resource Manager | |
| serialNumber | string | Serial Number, only available from Resource Manager. | |
| site | string | Site name. | |
| isIndirect | boolean | A value of true indicates the device is behind an edge device like a VBP, SBC, RPAD, etc. This is read-only for clients. | |
| deviceAuthentication | boolean | Device authentication value. | Mandatory |
| neverDeleteDueToInactivity | boolean | Prevents the registration from ever expiring. Only considered while updating any device. | |
| alertOnRegistrationLoss | boolean | If the device unregisters from the Call Server or its registration expires, an informational alert is triggered. Only considered while updating any device. | |
| complianceLevel | ComplianceLevel | Indicates whether the device is compliant or noncompliant with the applicable registration policy script | |
| territory | string | Territory name. | |
| registrationPolicyException | string | Shows any exceptions with which the device was flagged as a result of applying a registration policy. | |
| activeCalls | int | Indicates number of calls of a device. | |
| ownerUserUuid | string | The uuid of the user account. | |
| ownerRoomUuid | string | The uuid of the room account. | |
| pathHeader | Array of string | Path header | |
| sipUsername | string | Sip Username | |
| authenticationName | string | Authentication Name | |
| provisioned | boolean | True if the device has been provisioned. | |
| sharedRegistration | boolean | Flag for Shared Registration |
| Name | Type | Restrictions |
|---|---|---|
| ComplianceLevel | string | Value must be one of:
|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| Passthru | string | Length of value must be >=1 Length of value must be <=512 |
| Passback | string | Length of value must be >=1 Length of value must be <=512 |
| RegistrationDirection | string | Value must be one of:
|
| DeviceIdentifier | string | Length of value must be >=1 Length of value must be <=36 |