Supported APIs
Platform Management
| API | Description | Type | Required Arguments |
|---|---|---|---|
acceptUserInvite | Accept a user invite. | Mutation | code (user invite ID) |
cancelUserInvite | Cancel a user invite. | Mutation | code (user invite ID) |
createTenant | Creates a new tenant in Poly Lens. | Mutation | name |
deleteTenant | Deletes a tenant in Poly Lens. | Mutation | tenantId |
inviteUser | Invite one or more users to join a tenant. | Mutation | role, tenantId, emails |
rejectUserInvite | Reject a user invite. | Mutation | code (user invite ID) |
resendUserInvite | Resend a user invite. | Mutation | code (user invite ID) |
tenant | Returns tenant details for a given ID. | Query | tenantId |
tenantCount | Returns the total number of tenants for given user from Poly Lens. | Query | n/a |
tenants | Returns a list of tenant details. | Query | n/a |
updateTenant | Updates a tenant in Poly Lens. | Mutation | tenantId |
user | Returns a user for the specified user id. | Query | userID |
userInvitesByTenant | Returns all user invites associated with the specified tenantId. | Query | tenantId |
users | Returns a list of users according to the input parameters. | Query | UserSearchGrant>resourceID (tenantId) |
Inventory Reporting
| API | Description | Type | Required Arguments |
|---|---|---|---|
catalogModels | Returns the hardware product information for the products in the product catalog. | Query | n/a |
countDevices | Returns the total number of devices the requesting user has permission to view, across all tenants that the user can access. | Query | n/a |
createSubnetRule | Creates a new subnet rule. | Mutation | siteId, publicCidr |
deleteRooms | Deletes an existing room or sets of rooms. | Mutation | tenantId, ids |
deleteSites | Deletes an existing site or set of sites. | Mutation | tenantId, ids |
deleteSubnetRule | Deletes an existing subnet rule. | Mutation | ruleId |
deviceAggregations | Grouping the devices based on their geographical location. | Query | n/a |
deviceSearch | Searches for devices using query parameters. Supports pagination and finding results of more than 10K entries. Note: The pageSize should be limited to 5000 entries or less (default 10). Also, pageSize parameter of subsequent page calls must be idential to the first, or an error will be returned. | Query | n/a |
getSubnetRules | Get subnet rules for a given site. | Query | siteId |
getSubnetRuleValidity | Check if site subnet rules are valid. | Query | tenantId, siteId, publicCidr |
hardwareModel | Hardware Model level details for an item in the product catalog. | Query | hardwareModelId |
room | Gets detailed data for a specified room. | Query | roomId |
roomData | Retrieves room data for a specified tenant. | Query | tenantId |
site | Gets the geographical location of the device. | Query | siteId |
siteData | Retrieves site data for a specified tenant. | Query | tenantId |
switchSite | Switches a room to another site. | Mutation | tenantId, siteId, roomId |
updateSubnetRule | Updates an existing subnet rule. | Mutation | publicCidr, ruleId |
upsertRoom | Creates a new room or updates an existing room if applicable. | Mutation | tenantId, siteId |
upsertSite | Creates a new site or updates an existing site if applicable. | Mutation | tenantId, name |
Device Controls
| API | Description | Type | Required Arguments |
|---|---|---|---|
activeCalls | Returns an object containing all active calls on a specified device. | Query | deviceId |
device | Returns device details for a given ID. | Query | deviceId |
factoryReset | This will perform a factory reset on a device where all settings and current connections to Poly Lens for it will be reset. | Mutation | deviceId |
leaveCall | Ends a call on a specified device. | Mutation | callId, deviceId |
registerDevice | Register a device in Poly Lens. | Mutation | registrationCode, tenantId |
rebootDevice | This will reboot the device, all active calls will be terminated and the device will be offline for several minutes. Note: Poly TC8/TC10 are currently not supported with the includeIinkedDevices argument. | Mutation | deviceId |
rebootDevicesBySiteId | This reboots the devices associated with the siteId and all the devices rebooted will be offline for several minutes. | Mutation | siteId |
startCall | Begins a call on a specified device. | Mutation | dialString, deviceId |
unregisterDevice | Unregister a device in Poly Lens. | Mutation | deviceId |
updateDevice | Updates the device's name, site, and room. Prioritizes site/room name over site/room UUID. If the site/room name does not exist then will create a new site/room, otherwise matches to an existing site/room. | Mutation | deviceId |
Device and Room Insights
| API | Description | Type | Required Arguments | Requires Poly+ Enterprise |
|---|---|---|---|---|
charts | Extract Device usage insights from Poly Lens. topic include: Call Usage, Devices used, Devices unused, Devices out of service, Offline devices. | Query | tenantId, chartsId, locationScope, timeScope, timeStart, topic | |
charts | Extract Room usage insights from Poly Lens. topic include: Average meeting size, room usage, Rooms scheduled but not used, Recurring meetings with no participants, Unscheduled room usage, Meetings that run long, Meetings that start late. | Query | tenantId, chartsId, locationScope, timeScope, timeStart, topic | X |