Webex

Webex Device

The Webex Device APIs provide endpoints for managing and monitoring Webex devices, including registration, configuration, status retrieval, workspace…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Webex Device APIs provide endpoints for managing and monitoring Webex devices, including registration, configuration, status retrieval, workspace assignment, and firmware management. These APIs support automation of device onboarding, health monitoring, remote troubleshooting, and bulk configuration updates. Integration scenarios include custom device dashboards, proactive alerting, and seamless workspace management for meeting rooms and shared spaces. The APIs are essential for IT teams managing large fleets of Webex devices across distributed environments.

Endpoints 101

Device Call Settings

  • GETGet Device Members/telephony/config/devices/:deviceId/membersGet the list of all the members of the device including primary and secondary users. A device member can be either a person or a workspace. An admin can…
  • PUTUpdate Members on the device/telephony/config/devices/:deviceId/membersModify member details on the device. A device member can be either a person, virtual line or a workspace. An admin can access the list of member details,…
  • GETSearch Members/telephony/config/devices/:deviceId/availableMembersSearch members that can be assigned to the device. A device member can be either a person or a workspace. A admin can access the list of member details,…
  • GETGet Count of Members/telephony/config/devices/:deviceId/availableMembers/countGet the count of members that can be assigned to the device. A device member can be either a person or a workspace. This requires a full or read-only…
  • GETGet Count of Available Members/telephony/config/devices/availableMembers/countGet the count of members that can be assigned to devices. A device member can be either a person or a workspace. This requires a full or read-only…
  • POSTApply Changes for a specific device/telephony/config/devices/:deviceId/actions/applyChanges/invokeIssues request to the device to download and apply changes to the configuration. Applying changes for a specific device requires a full administrator auth…
  • GETGet Device Settings/telephony/config/devices/:deviceId/settingsGet override settings for a device. Device settings lists all the applicable settings for MPP, ATA and Wifi devices at the device level. An admin can also…
  • PUTUpdate device settings/telephony/config/devices/:deviceId/settingsModify override settings for a device. Device settings list all the applicable settings for an MPP and an ATA devices at the device level. Admins can also…
  • GETGet Location Device Settings/telephony/config/locations/:locationId/devices/settingsGet device override settings for a location. This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
  • GETGet Webex Calling Device Details/telephony/config/devices/:deviceId<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div> Retrieves Webex Calling device details that include information…
  • PUTUpdate Third Party Device/telephony/config/devices/:deviceId<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div> Modify a device's sipPassword. Updating sipPassword on the…
  • GETGet Person Devices/telephony/config/people/:personId/devicesGet all devices for a person. This requires a full or read-only administrator or location administrator auth token with a scope of…
  • PUTModify Hoteling Settings for a Person's Primary Devices/telephony/config/people/:personId/devices/settings/hotelingModify hoteling login configuration on a person's Webex Calling Devices which are in effect when the device is the user's primary device and device type is…
  • GETGet Workspace Devices/telephony/config/workspaces/:workspaceId/devicesGet all devices for a workspace. This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
  • PUTModify Workspace Devices/telephony/config/workspaces/:workspaceId/devicesModify devices for a workspace. Modifying devices for a workspace requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
  • GETRead the device override settings for a organization/telephony/config/devices/settingsGet device override settings for an organization. Retrieving this list requires a full or read-only administrator auth token with a scope of…
  • GETRead the list of Line Key Templates/telephony/config/devices/lineKeyTemplatesList all Line Key Templates available for this organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a…
  • POSTCreate a Line Key Template/telephony/config/devices/lineKeyTemplatesCreate a Line Key Template in this organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk…
  • GETGet details of a Line Key Template/telephony/config/devices/lineKeyTemplates/:templateIdGet detailed information about a Line Key Template by template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys…
  • PUTModify a Line Key Template/telephony/config/devices/lineKeyTemplates/:templateIdModify a Line Key Template by its template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of…
  • DELETEDelete a Line Key Template/telephony/config/devices/lineKeyTemplates/:templateIdDelete a Line Key Template by its template ID in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a…
  • POSTPreview Apply Line Key Template/telephony/config/devices/actions/previewApplyLineKeyTemplate/invokePreview the number of devices that will be affected by the application of a Line Key Template or when resetting devices to their factory Line Key settings.…
  • GETGet List of Apply Line Key Template jobs/telephony/config/jobs/devices/applyLineKeyTemplateGet the list of all apply line key templates jobs in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides…
  • POSTApply a Line Key Template/telephony/config/jobs/devices/applyLineKeyTemplateApply a Line Key Template or reset devices to their factory Line Key settings. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on…
  • GETGet the job status of an Apply Line Key Template job/telephony/config/jobs/devices/applyLineKeyTemplate/:jobIdGet the status of an apply line key template job by its job ID. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a…
  • GETGet job errors for an Apply Line Key Template job/telephony/config/jobs/devices/applyLineKeyTemplate/:jobId/errorsGET job errors for an apply Line Key Template job in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides…
  • GETRead the DECT device type list - Deprecated/telephony/config/devices/dects/supportedDevices<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> <div><Callout type="warning">The REST path for this API has…
  • GETRead the DECT device type list/telephony/config/devices/dectNetworks/supportedDevices<div><Callout type="warning">Not supported for Webex for Government (FedRAMP).</Callout></div> Get DECT device type list with base stations and line ports…
  • POSTValidate a list of MAC address/telephony/config/devices/actions/validateMacs/invokeValidate a list of MAC addresses. Validating this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_write.
  • GETList Change Device Settings Jobs/telephony/config/jobs/devices/callDeviceSettingsList change device settings jobs. Lists all the jobs for jobType calldevicesettings for the given organization in order of most recent one to oldest one…
  • POSTChange Device Settings Across Organization Or Location Job/telephony/config/jobs/devices/callDeviceSettingsChange device settings across organization or locations jobs. Performs bulk and asynchronous processing for all types of device settings initiated by…
  • GETGet Change Device Settings Job Status/telephony/config/jobs/devices/callDeviceSettings/:jobIdGet change device settings job status. Provides details of the job with jobId of jobType calldevicesettings. This API requires a full or read-only…
  • GETList Change Device Settings Job Errors/telephony/config/jobs/devices/callDeviceSettings/:jobId/errorsList change device settings job errors. Lists all error details of the job with jobId of jobType calldevicesettings. This API requires a full or read-only…
  • GETGet Device Layout by Device ID/telephony/config/devices/:deviceId/layoutGet layout information of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any…
  • PUTModify Device Layout by Device ID/telephony/config/devices/:deviceId/layoutModify the layout of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached…
  • GETList Rebuild Phones Jobs/telephony/config/jobs/devices/rebuildPhones<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div>. Get the list of all Rebuild Phones jobs in an organization.…
  • POSTRebuild Phones Configuration/telephony/config/jobs/devices/rebuildPhones<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div>. Rebuild all phone configurations for the specified location.…
  • GETGet the Job Status of a Rebuild Phones Job/telephony/config/jobs/devices/rebuildPhones/:jobId<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div>. Get the details of a rebuild phones job by its job ID. Rebuild…
  • GETGet Job Errors for a Rebuild Phones Job/telephony/config/jobs/devices/rebuildPhones/:jobId/errors<div><Callout type="warning">Not supported for Webex for Government (FedRAMP)</Callout></div>. Get errors for a rebuild phones job in an organization. Rebuild…
  • GETGet Device Settings for a Person/telephony/config/people/:personId/devices/settingsDevice settings list the compression settings for a person. Device settings customize a device's behavior and performance. The compression field optimizes…
  • PUTUpdate Device Settings for a Person/telephony/config/people/:personId/devices/settingsUpdate device settings modifies the compression settings for a person. Device settings customize a device's behavior and performance. The compression field…
  • GETGet Device Settings for a Workspace/telephony/config/workspaces/:workspaceId/devices/settingsDevice settings list the compression settings for a workspace. Device settings customize a device's behavior and performance. The compression field optimizes…
  • PUTUpdate Device Settings for a Workspace/telephony/config/workspaces/:workspaceId/devices/settingsUpdate device settings modifies the compression settings for a workspace. Device settings customize a device's behavior and performance. The compression field…
  • GETRead the List of Background Images/telephony/config/devices/backgroundImagesGets the list of device background images for an organization. Webex Calling supports the upload of up to 100 background image files for each org. These image…
  • DELETEDelete Device Background Images/telephony/config/devices/backgroundImagesDelete the list of designated device background images for an organization. Maximum is 10 images per request. Deleting a device background image requires a…
  • POSTUpload a Device Background Image/telephony/config/devices/:deviceId/actions/backgroundImageUpload/invokeConfigure a device's background image by uploading an image with file format, .jpeg or .png, encoded image file. Maximum image file size allowed to upload is…
  • GETGet User Devices Count/telephony/config/people/:personId/devices/countGet the total device and application count for a person. The device count can be used to determine if more devices can be added for users with a device count…

Device Call Settings With Device Dynamic Settings

  • GETRead the List of Supported Devices/telephony/config/supportedDevicesGets the list of supported devices for an organization. Retrieving this list requires a full or read-only administrator auth token with a scope of…
  • GETGet Settings Groups/telephony/config/devices/dynamicSettings/settingsGroupsThis API returns the settingsGroups that define the structure and association of tags for device dynamic settings. The settingsGroups are used to organize the…
  • POSTGet Customer Device Dynamic Settings/telephony/config/lists/devices/dynamicSettings/actions/getSettings/invoke?familyOrModelDisplayName=PolyRetrieve dynamic settings for specific device tags at customer level, allowing filters by familyOrModelDisplayName and tag identifier. This API lets you…
  • POSTGet Location Device Dynamic Settings/telephony/config/lists/locations/:locationId/devices/dynamicSettings/actions/getSettings/invoke?familyOrModelDisplayName=PolyRetrieve dynamic settings for specific device tags at the specified location level, allowing filters by familyOrModelDisplayName and tag identifier. This API…
  • POSTGet Device Dynamic Settings/telephony/config/lists/devices/:deviceId/dynamicSettings/actions/getSettings/invokeRetrieve settings for a specified device. This API retrieves device settings based on the specified tags; if the tags field is empty or missing, all settings…
  • PUTUpdate Device Dynamic Settings/telephony/config/devices/:deviceId/dynamicSettingsModify dynamic settings for a specified device. This API updates device settings based on the specified tags. If the tags field is empty, the request has no…
  • GETList Device Dynamic Settings Jobs/telephony/config/jobs/devices/dynamicDeviceSettingsList device dynamic settings jobs. Lists all the jobs for job type dynamicdevicesettings for the given organization in order of most recent one to oldest one…
  • POSTUpdate Device Dynamic Settings Across Organization or Location/telephony/config/jobs/devices/dynamicDeviceSettingsCreates a job to update device settings at location or organization level. The job runs asynchronously and persistently, applying the requested settings in…
  • GETGet Device Dynamic Settings Job Status/telephony/config/jobs/devices/dynamicDeviceSettings/:jobIdGet device dynamic settings job status. Provides details of the job with jobId of jobType dynamicdevicesettings. This API requires a full or read-only…
  • GETList Device Dynamic Settings Job Errors/telephony/config/jobs/devices/dynamicDeviceSettings/:jobId/errorsList Update device dynamic settings job errors. Lists all error details of the job with jobId of jobType dynamicdevicesettings. This API requires a full or…

Beta Device Call Settings With Dynamic Device Settings

  • GETGet Validation Schema/telephony/config/devices/dynamicSettings/validationSchemaThis API returns the validation schema for tags of all or specific familyOrModelDisplayName. The schema is used to validate the tag for devices in the Webex…

Device Configurations

  • GETList Device Configurations for device/deviceConfigurations?deviceId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization.
  • PATCHUpdate Device Configurations/deviceConfigurations?deviceId=Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=Edit configurations for the device specified by device ID.

Devices

  • GETList Devices/devicesLists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the spark:devices_read scope.…
  • POSTCreate a Device by MAC Address/devicesCreate a phone by its MAC address in a specific workspace or for a person. Specify the mac, model and either workspaceId or personId. * You can get the model…
  • GETGet Device Details/devices/:deviceIdShows details for a device, by ID. This requires an auth token with the spark:devices_read scope to see your own device, or spark-admin:devices_read to see…
  • DELETEDelete a Device/devices/:deviceIdDeletes a device, by ID. Deleting your own device requires an auth token with the spark:devices_write scope. Deleting any other device in the organization…
  • PATCHModify Device Tags/devices/:deviceIdCreate, delete or update tags on a device. For your own device, this requires an auth token with the spark:devices_write scope. An auth token with the…
  • POSTCreate a Device Activation Code/devices/activationCodeGenerate an activation code for a device in a specific workspace by workspaceId or for a person by personId. This requires an auth token with the…

Hot Desk

  • GETList Sessions/hotdesk/sessionsList hot desk sessions. Use query parameters to filter the response. The orgId parameter is for use by partner administrators acting on a managed…
  • DELETEDelete Session/hotdesk/sessions/:sessionIdDelete a hot desk session.

Locations

  • GETList Locations/locationsList locations for an organization. * Use query parameters to filter the result set by location name, ID, or organization. * Long result sets will be split…
  • POSTCreate a Location/locationsCreate a new Location for a given organization. Only an admin in the organization can create a new Location. * Creating a location in your organization…
  • GETGet Location Details/locations/:locationIdShows details for a location, by ID. * Specify the location ID in the locationId parameter in the URI. * Use query parameter orgId to filter the result set by…
  • PUTUpdate a Location/locations/:locationIdUpdate details for a location, by ID. * Updating a location in your organization requires a full administrator or location administrator auth token with a…
  • DELETEDelete Location/locations/:locationIdDelete a location, by ID. * Specify the location ID in the locationId parameter in the URI. * Deleting a location in your organization requires a full…
  • GETList Location Floors/locations/:locationId/floorsList location floors. Requires an administrator auth token with the spark-admin:locations_read scope.
  • POSTCreate a Location Floor/locations/:locationId/floorsCreate a new floor in the given location. The displayName parameter is optional, and omitting it will result in the creation of a floor without that value…
  • GETGet Location Floor Details/locations/:locationId/floors/:floorIdShows details for a floor, by ID. Specify the floor ID in the floorId parameter in the URI. Requires an administrator auth token with the…
  • PUTUpdate a Location Floor/locations/:locationId/floors/:floorIdUpdates details for a floor, by ID. Specify the floor ID in the floorId parameter in the URI. Include all details for the floor returned by a previous call to…
  • DELETEDelete a Location Floor/locations/:locationId/floors/:floorIdDeletes a floor, by ID. Requires an administrator auth token with the spark-admin:locations_write scope.

Workspace Locations

  • GETList Workspace Locations/workspaceLocationsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • POSTCreate a Workspace Location/workspaceLocationsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • GETGet a Workspace Location Details/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • PUTUpdate a Workspace Location/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • DELETEDelete a Workspace Location/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • GETList Workspace Location Floors/workspaceLocations/:locationId/floorsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • POSTCreate a Workspace Location Floor/workspaceLocations/:locationId/floorsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • GETGet a Workspace Location Floor Details/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • PUTUpdate a Workspace Location Floor/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
  • DELETEDelete a Workspace Location Floor/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…

Workspace Metrics

  • GETWorkspace Metrics/workspaceMetrics?workspaceId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&metricName=temperatureGet metric data for the specified workspace and metric name, optionally aggregated over a specified time period. * The workspaceId and metricName parameters…
  • GETWorkspace Duration Metrics/workspaceDurationMetrics?workspaceId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWEGet metrics for how much time a workspace has been in the state given by the measurement parameter. For example, if the measurement is timeBooked then the…

Workspace Personalization

  • POSTPersonalize a Workspace/workspaces/:workspaceId/personalizeInitializes the personalization for a given workspace for the user email provided. The personalization process is asynchronous and thus a background task is…
  • GETGet Personalization Task/workspaces/:workspaceId/personalizationTaskReturns the status of a personalization task for a given workspace. Whilst in progress the endpoint will return Accepted and provide a Retry-After header…

Workspaces

  • GETList Workspaces/workspacesList workspaces. Use query parameters to filter the response. The orgId parameter can only be used by admin users of another organization (such as partners).…
  • POSTCreate a Workspace/workspacesCreate a workspace. The locationId, workspaceLocationId, floorId, indoorNavigation, capacity, type, notes and hotdeskingStatus parameters are optional, and…
  • GETGet Workspace Details/workspaces/:workspaceIdShows details for a workspace, by ID. The locationId, workspaceLocationId, floorId, indoorNavigation, capacity, type and notes fields will only be present if…
  • PUTUpdate a Workspace/workspaces/:workspaceIdUpdates details for a workspace by ID. Specify the workspace ID in the workspaceId parameter in the URI. Include all details for the workspace that are…
  • DELETEDelete a Workspace/workspaces/:workspaceIdDeletes a workspace by ID. Also deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID…
  • GETGet Workspace Capabilities/workspaces/:workspaceId/capabilitiesShows the capabilities for a workspace by ID. Returns a set of capabilities, including whether or not the capability is supported by any device in the…

xAPI

  • GETQuery Status/xapi/status?deviceId=Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM&name=audio.volumeQuery the current status of the Webex RoomOS Device. You specify the target device in the deviceId parameter in the URI. The target device is queried for…
  • GETQuery Schema/xapi/schema?deviceId=Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDMQuery the schema for statuses and commands of Webex RoomOS Devices. You specify the target devices in the deviceId parameter in the URI. Querying command…
  • POSTExecute Command/xapi/command/:commandNameExecutes a command on the Webex RoomOS Device. Specify the command to execute in the commandName URI parameter. See the xAPI section of the Device Developers…

API details

Authentication
A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
Operations
101 operations on 67 pathsGET 54POST 21PUT 15DELETE 9PATCH 2
10 marked deprecated
Main resources
Device Call Settings 47Device Call Settings With Device Dynamic Settings 10Locations 10Workspace Locations 10Devices 6Workspaces 6xAPI 3Device Configurations 2Hot Desk 2Workspace Metrics 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0

How to test the Webex Device in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Device collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Device Members” (GET /telephony/config/devices/:deviceId/members), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webex Device?

The Webex Device APIs provide endpoints for managing and monitoring Webex devices, including registration, configuration, status retrieval, workspace… It is listed under Communication and has 101 endpoints.

Who publishes the Webex Device?

It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Webex Device?

It accepts 2 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow).

How many endpoints does the Webex Device have?

101 operations on 67 paths (54 GET, 21 POST, 15 PUT, 9 DELETE, 2 PATCH). The largest groups are Device Call Settings, Device Call Settings With Device Dynamic Settings, Locations, Workspace Locations.

Is forking the Webex Device free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.