{ "opencollection": "1.0.0", "info": { "name": "Webex Device", "version": "1.0.0" }, "items": [ { "info": { "name": "Device Call Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Device Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/members", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieves the list of all members of the device in this organization." } ] }, "docs": "Get the list of all the members of the device including primary and secondary users.\n\nA device member can be either a person or a workspace. An admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Members on the device", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/members", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify members on the device in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify member details on the device.\n\nA device member can be either a person, virtual line or a workspace. An admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nModifying members on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Search Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/availableMembers", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieves the list of available members on the device in this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Specifies the offset from the first result that you want to fetch." }, { "name": "max", "value": "100", "type": "query", "description": "Specifies the maximum number of records that you want to fetch." }, { "name": "memberName", "value": "John", "type": "query", "description": "Search (Contains) numbers based on member name." }, { "name": "phoneNumber", "value": "9828282867", "type": "query", "description": "Search (Contains) based on number." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the location." }, { "name": "extension", "value": "1234", "type": "query", "description": "Search (Contains) based on extension." }, { "name": "usageType", "value": "SHARED_LINE", "type": "query", "description": "Search for members eligible to become the owner of the device, or share line on the device." }, { "name": "order", "value": "lname", "type": "query", "description": "Sort the list of available members on the device in ascending order by name, use either last name `lname` or first name `fname`. Default: last name in ascending order." } ] }, "docs": "Search members that can be assigned to the device.\n\nA device member can be either a person or a workspace. A admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Count of Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/availableMembers/count", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieves the count of available members on the device in this organization." }, { "name": "memberName", "value": "John", "type": "query", "description": "Search (Contains) numbers based on member name." }, { "name": "phoneNumber", "value": "9828282867", "type": "query", "description": "Search (Contains) based on number." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw", "type": "query", "description": "Unique identifier for the location." }, { "name": "extension", "value": "1234", "type": "query", "description": "Search (Contains) based on extension." }, { "name": "usageType", "value": "SHARED_LINE", "type": "query", "description": "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device." } ] }, "docs": "Get the count of members that can be assigned to the device.\n\nA device member can be either a person or a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Count of Available Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/availableMembers/count", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieves the count of available members in this organization." }, { "name": "memberName", "value": "John", "type": "query", "description": "Search (Contains) numbers based on member name." }, { "name": "phoneNumber", "value": "9828282867", "type": "query", "description": "Search (Contains) based on number." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw", "type": "query", "description": "Unique identifier for the location." }, { "name": "extension", "value": "1234", "type": "query", "description": "Search (Contains) based on extension." }, { "name": "usageType", "value": "SHARED_LINE", "type": "query", "description": "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device." }, { "name": "excludeVirtualLine", "value": "true", "type": "query", "description": "If true, filters out virtual lines from the available members list." }, { "name": "deviceLocationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw", "type": "query", "description": "Unique identifier for the device's location. When specified, filters available members to those in the same location as the device." } ] }, "docs": "Get the count of members that can be assigned to devices.\n\nA device member can be either a person or a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Apply Changes for a specific device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/actions/applyChanges/invoke", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Apply changes for a device in this organization." } ] }, "docs": "Issues request to the device to download and apply changes to the configuration.\n\nApplying changes for a specific device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Device Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/settings", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Settings on the device in this organization." }, { "name": "deviceModel", "value": "DMS Cisco 8811", "type": "query", "description": "The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model." } ] }, "docs": "Get override settings for a device.\n\nDevice settings lists all the applicable settings for MPP, ATA and Wifi devices at the device level. An admin can also modify the settings. DECT devices do not support settings at the device level.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update device settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/settings", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvMzAwMmViYmYtYjE1Zi00NTg5LWFjYmUtZGY2NzkwNzE1OTVh", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the device resides.." }, { "name": "deviceModel", "value": "DMS Cisco 8811", "type": "query", "description": "The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify override settings for a device.\n\nDevice settings list all the applicable settings for an MPP and an ATA devices at the device level. Admins can also modify the settings. NOTE: DECT devices do not support settings at the device level.\n\nUpdating settings on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Location Device Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/devices/settings", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which the device resides." } ] }, "docs": "Get device override settings for a location.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Webex Calling Device Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the device resides." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
\n\nRetrieves Webex Calling device details that include information needed for third-party device management.\n\nWebex calling devices are associated with a specific user Workspace or Virtual Line. Webex Calling devices share the location with the entity that owns them.\n\nPerson or workspace to which the device is assigned. Its fields point to a primary line/port of the device.\n\nRequires a full, location, use" }, { "info": { "name": "Update Third Party Device", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfREVWSUNFLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw", "type": "query", "description": "ID of the organization in which the device resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Not supported for Webex for Government (FedRAMP)
\n\nModify a device's `sipPassword`.\n\nUpdating `sipPassword` on the device requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Person Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/devices", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Person for whom to retrieve devices." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the person belongs." } ] }, "docs": "Get all devices for a person.\n\nThis requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Hoteling Settings for a Person's Primary Devices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings/hoteling", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "ID of the person associated with the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the person belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify 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 PRIMARY. To view the current hoteling login settings, see the `hoteling` field in [Get Person Devices](/docs/api/v1/device-call-settings/get-person-devices).\n\nModifying devices for a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Workspace Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "ID of the workspace for which to retrieve devices." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the workspace belongs." } ] }, "docs": "Get all devices for a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Workspace Devices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "ID of the workspace for which to modify devices." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the workspace belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify devices for a workspace.\n\nModifying devices for a workspace requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the device override settings for a organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/settings", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List supported devices for an organization." } ] }, "docs": "Get device override settings for an organization.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Read the list of Line Key Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List line key templates for this organization." } ] }, "docs": "List all Line Key Templates available for this organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve the list of Line Key Templates that are available for the organization.\n\nRetrieving this list requires a full, user or read-only administrator or location ad" }, { "info": { "name": "Create a Line Key Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the line key template belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Line Key Template in this organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows customers to create a `Line Key Template` for a device model.\n\nCreating a Line Key Template requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get details of a Line Key Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId", "params": [ { "name": "templateId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM", "type": "path", "description": "Get line key template for this template ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve a line key template for this organization." } ] }, "docs": "Get detailed information about a Line Key Template by template ID in an organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve a line key template by its ID in an organization.\n\nRetrieving a line key template requires a full, user, or read-only administrator" }, { "info": { "name": "Modify a Line Key Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId", "params": [ { "name": "templateId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM", "type": "path", "description": "Modify line key template with this template ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify a line key template for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a Line Key Template by its template ID in an organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to modify an existing Line Key Template by its ID in an organization.\n\nModifying an existing Line Key Template requires a full administrator auth token with a scop" }, { "info": { "name": "Delete a Line Key Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId", "params": [ { "name": "templateId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM", "type": "path", "description": "Delete line key template with this template ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete a line key template for this organization." } ] }, "docs": "Delete a Line Key Template by its template ID in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to delete an existing Line Key Templates by its ID in an organization.\n\nDeleting an existing line key template requires a full administrator auth token with a scope" }, { "info": { "name": "Preview Apply Line Key Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/devices/actions/previewApplyLineKeyTemplate/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Preview Line Key Template for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview 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.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to preview the number of devices that will be affected if a customer were" }, { "info": { "name": "Get List of Apply Line Key Template jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of line key templates jobs in this organization." } ] }, "docs": "Get the list of all apply line key templates jobs in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve all the apply line key templates jobs in an organization.\n\nRetrieving the list of apply line key templates jobs in an organization requires a full, " }, { "info": { "name": "Apply a Line Key Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Apply Line Key Template for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply a Line Key Template or reset devices to their factory Line Key settings.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to apply a line key template or apply factory default Line Key settings to devices in a set of locations or across all locations in the organization.\n" }, { "info": { "name": "Get the job status of an Apply Line Key Template job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job status for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Check a line key template job status in this organization." } ] }, "docs": "Get the status of an apply line key template job by its job ID.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to check the status of an apply line key templates job by job ID in an organization.\n\nChecking the the status of an apply line key templates job in an organization re" }, { "info": { "name": "Get job errors for an Apply Line Key Template job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job errors for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of errors for an apply line key template job in this organization." } ] }, "docs": "GET job errors for an apply Line Key Template job in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve all the errors of an apply line key templates job by job ID in an organization.\n\nRetrieving all the errors of an apply line key templates job in an " }, { "info": { "name": "Read the DECT device type list - Deprecated", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/dects/supportedDevices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query" } ] }, "docs": "
Not supported for Webex for Government (FedRAMP).
\n\n
The REST path for this API has changed to [GET /telephony/config/devices/dectNetworks/supportedDevices{?orgId}]. The use of this old REST path is deprecated and will be decommissioned on October 10, 2024. Please start using it for all future projects.
\n\nGet DECT device type list with base stations and line ports supported count. This is a static list.\n\nRetri" }, { "info": { "name": "Read the DECT device type list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/dectNetworks/supportedDevices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query" } ] }, "docs": "
Not supported for Webex for Government (FedRAMP).
\n\nGet DECT device type list with base stations and line ports supported count. This is a static list.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Validate a list of MAC address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/devices/actions/validateMacs/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Validate the mac address(es) for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate a list of MAC addresses.\n\nValidating this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "List Change Device Settings Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of 'calldevicesettings' jobs for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of jobs. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the number of jobs returned to this maximum count. Default is 2000." } ] }, "docs": "List change device settings jobs.\n\nLists all the jobs for jobType `calldevicesettings` for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Change Device Settings Across Organization Or Location Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Apply change device settings for all the devices under this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change device settings across organization or locations jobs.\n\nPerforms bulk and asynchronous processing for all types of device settings initiated by organization and system admins in a stateful persistent manner. This job will modify the requested device settings across all the devices. Whenever a location ID is specified in the request, it will modify the requested device settings only for the devices that are part of the provided location within an organization.\n\nReturns a unique job ID whic" }, { "info": { "name": "Get Change Device Settings Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ", "type": "path", "description": "Retrieve job details for this `jobId`." } ] }, "docs": "Get change device settings job status.\n\nProvides details of the job with `jobId` of `jobType` `calldevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "List Change Device Settings Job Errors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ", "type": "path", "description": "Retrieve job details for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of jobs for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Specifies the offset from the first result that you want to fetch. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Specifies the maximum number of records that you want to fetch. Default is 2000" } ] }, "docs": "List change device settings job errors.\n\nLists all error details of the job with `jobId` of `jobType` `calldevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Device Layout by Device ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/layout", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM", "type": "path", "description": "Get device layout for this device ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve a device layout for the device in this organization." } ] }, "docs": "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Device Layout by Device ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/layout", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM/", "type": "path", "description": "Modify device layout for this device ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify a device layout for the device in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "List Rebuild Phones Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List of rebuild phones jobs in this organization." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
.\n\nGet the list of all Rebuild Phones jobs in an organization.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Rebuild Phones Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Rebuild phones for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Not supported for Webex for Government (FedRAMP)
.\n\nRebuild all phone configurations for the specified location.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the Job Status of a Rebuild Phones Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job status for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Check a rebuild phones job status in this organization." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
.\n\nGet the details of a rebuild phones job by its job ID.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Job Errors for a Rebuild Phones Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job errors for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of errors for a rebuild phones job in this organization." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
.\n\nGet errors for a rebuild phones job in an organization.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Device Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI", "type": "path", "description": "ID of the person for whom to retrieve device settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE", "type": "query", "description": "Retrieves the device settings for a person in this organization." } ] }, "docs": "Device settings list the compression settings for a person.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Device Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI", "type": "path", "description": "ID of the person for whom to update device settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE", "type": "query", "description": "Modify device settings for a person in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update device settings modifies the compression settings for a person.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Device Settings for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices/settings", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0", "type": "path", "description": "ID of the workspace for which to retrieve device settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE", "type": "query", "description": "Retrieves the device settings for a workspace in this organization." } ] }, "docs": "Device settings list the compression settings for a workspace.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Device Settings for a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices/settings", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0", "type": "path", "description": "ID of the workspace for which to update device settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE", "type": "query", "description": "Modify the device settings for a workspace in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update device settings modifies the compression settings for a workspace.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the List of Background Images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/backgroundImages", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieves the list of images in this organization." } ] }, "docs": "Gets the list of device background images for an organization.\n\nWebex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.\n\nRetrieving this list requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Delete Device Background Images", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/devices/backgroundImages", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Deletes the list of images in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete the list of designated device background images for an organization. Maximum is 10 images per request.\n\nDeleting a device background image requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Upload a Device Background Image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/actions/backgroundImageUpload/invoke", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Uploads the image in this organization." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "fileName", "type": "text", "value": "" } ] } }, "docs": "Configure 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 625 KB.\n\nThe request must be a multipart/form-data request rather than JSON, using the image/jpeg or image/png content-type.\n\nWebex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.\n\nUploading a device backgr" }, { "info": { "name": "Get User Devices Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/devices/count", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Person for whom to retrieve the device count." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the person belongs." } ] }, "docs": "Get the total device and application count for a person.\n\nThe device count can be used to determine if more devices can be added for users with a device count limit. For example, users with standard calling licenses can only have one physical device.\n\nThis requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." } ] }, { "info": { "name": "Device Call Settings With Device Dynamic Settings", "type": "folder" }, "items": [ { "info": { "name": "Read the List of Supported Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/supportedDevices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List supported devices for an organization." }, { "name": "allowConfigureLayoutEnabled", "value": "true", "type": "query", "description": "List supported devices that allow the user to configure the layout." }, { "name": "type", "value": "MPP", "type": "query", "description": "List supported devices of a specific type. To excluded device types from a request or query, add `type=not:DEVICE_TYPE`. For example, `type=not:MPP`." } ] }, "docs": "Gets the list of supported devices for an organization.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Settings Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/dynamicSettings/settingsGroups", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Settings groups for devices in this organization." }, { "name": "familyOrModelDisplayName", "value": "Poly", "type": "query", "description": "Device family or model display name to filter the `settingsGroups`." }, { "name": "includeSettingsType", "value": "ALL", "type": "query", "description": "To show groups or tabs or both. Query param is case insensitive. Default is `ALL`." } ] }, "docs": "This API returns the `settingsGroups` that define the structure and association of tags for device dynamic settings.\n\n The `settingsGroups` are used to organize the tags into logical groups, making it easier to manage and configure device dynamic settings." }, { "info": { "name": "Get Customer Device Dynamic Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/lists/devices/dynamicSettings/actions/getSettings/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List of device dynamic settings in this organization." }, { "name": "familyOrModelDisplayName", "value": "Poly", "type": "query", "description": "The family or model name for the device. If no tag is specified, all tags related to `familyOrModelDisplayName` are returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve dynamic settings for specific device tags at customer level, allowing filters by `familyOrModelDisplayName` and `tag` identifier.\n\nThis API lets you request the values of multiple `Device Settings` at once by specifying a list of `familyOrModelDisplayName` and tag combinations.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Location Device Dynamic Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/lists/locations/:locationId/devices/dynamicSettings/actions/getSettings/invoke", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMzZjBlZDFiLWQ1YjctNGI4Mi1iMzIzLTg4ZTFmODMzNGNmMw", "type": "path", "description": "Unique identifier for the `location`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the `organization` to which this location belongs." }, { "name": "familyOrModelDisplayName", "value": "Poly", "type": "query", "description": "The family or model name for the device. If no tag is specified, all tags related to `familyOrModelDisplayName` are returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve dynamic settings for specific device tags at the specified location level, allowing filters by `familyOrModelDisplayName` and `tag` identifier.\n\nThis API lets you request the values of multiple `Device Settings` at once by specifying a list of `familyOrModelDisplayName` and tag combinations for a specific location.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Device Dynamic Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/lists/devices/:deviceId/dynamicSettings/actions/getSettings/invoke", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Device for which to retrieve settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the `device` belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve settings for a specified device.\n\nThis API retrieves device settings based on the specified `tags`; if the `tags` field is empty or missing, all settings for the device are returned.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Device Dynamic Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/devices/:deviceId/dynamicSettings", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=", "type": "path", "description": "Device for which to update settings." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the device belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify dynamic settings for a specified device.\n\nThis API updates device settings based on the specified `tags`. If the `tags` field is empty, the request has no effect.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "List Device Dynamic Settings Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve list of device dynamic settings jobs for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of jobs. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the number of jobs returned to this maximum count. Default is 2000." } ] }, "docs": "List device dynamic settings jobs.\n\nLists all the jobs for job type `dynamicdevicesettings` for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Device Dynamic Settings Across Organization or Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Apply update device dynamic settings for all the devices under this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a job to update device settings at location or organization level.\n\nThe job runs asynchronously and persistently, applying the requested settings in bulk to all relevant devices, which may belong to multiple families as specified in the request. If a `locationId` is provided, only devices in that location are affected.\n\nA unique job ID is returned to track status and errors.\n\nOnly one job can run per customer per organization at a time. Additionally, this job cannot run in parallel with " }, { "info": { "name": "Get Device Dynamic Settings Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ", "type": "path", "description": "Retrieve job details for this `jobId`." } ] }, "docs": "Get device dynamic settings job status.\n\nProvides details of the job with `jobId` of `jobType` `dynamicdevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "List Device Dynamic Settings Job Errors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ", "type": "path", "description": "Retrieve job details for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve the status of job for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Specifies the offset from the first result that you want to fetch. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Specifies the maximum number of records that you want to fetch. Default is 2000" } ] }, "docs": "List Update device dynamic settings job errors.\n\nLists all error details of the job with `jobId` of `jobType` `dynamicdevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." } ] }, { "info": { "name": "Beta Device Call Settings With Dynamic Device Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Validation Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/devices/dynamicSettings/validationSchema", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Validation schema for devices in this organization." }, { "name": "familyOrModelDisplayName", "value": "Poly", "type": "query", "description": "Device family or model display name to filter the schema." } ] }, "docs": "This API returns the validation schema for `tags` of all or specific `familyOrModelDisplayName`.\n\nThe schema is used to validate the `tag` for devices in the `Webex Calling` platform. The schema includes information about the required fields, data types, and validation rules for each setting." } ] }, { "info": { "name": "Device Configurations", "type": "folder" }, "items": [ { "info": { "name": "List Device Configurations for device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deviceConfigurations", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=", "type": "query", "description": "List device configurations by device ID." }, { "name": "key", "value": "", "type": "query", "description": "This can optionally be used to filter configurations. Keys are composed of segments. It's possible to use absolute paths, wildcards or ranges.\n\n- **Absolute** gives only one configuration as a result. `Conference.MaxReceiveCallRate` for example gives the Conference `MaxReceiveCallRate` configuration.\n\n+ **Wildcards** (\\*) can specify multiple configurations with shared segments. `Audio.Ultrasound.*` for example will filter on all Audio Ultrasound configurations.\n\n- **Range** ([_number_]) can be used to filter numbered segments. `FacilityService.Service[1].Name` for instance only shows the first `FacilityService` Service Name configuration, `FacilityService.Service[*].Name` shows all, `FacilityService.Service[1..3].Name` shows the first three and `FacilityService.Service[2..n].Name` shows all starting at 2. Note that [RFC 3986 3.2.2](https://www.ietf.org/rfc/rfc3986.html#section-3.2.2) does not allow square brackets in urls outside the host, so to specify range in a configuration key you will need to encode them to %5B for [ and %5D for ]." } ] }, "docs": "Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization." }, { "info": { "name": "Update Device Configurations", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/deviceConfigurations", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL0RFVklDRS9hNmYwYjhkMi01ZjdkLTQzZDItODAyNi0zM2JkNDg3NjYzMTg=", "type": "query", "description": "Update device configurations by device ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit configurations for the device specified by device ID." } ] }, { "info": { "name": "Devices", "type": "folder" }, "items": [ { "info": { "name": "List Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices", "params": [ { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of devices in the response." }, { "name": "start", "value": "", "type": "query", "description": "\nOffset. Default is 0.\n" }, { "name": "displayName", "value": "SFO12-3-PanHandle", "type": "query", "description": "\nList devices with this display name.\n" }, { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU", "type": "query", "description": "\nList devices by person ID.\n" }, { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by workspace ID.\n" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "\nList devices in this organization. Only admin users of another organization (such as partners) may use this parameter.\n" }, { "name": "connectionStatus", "value": "", "type": "query", "description": "\nList devices with this connection status.\n" }, { "name": "product", "value": "", "type": "query", "description": "\nList devices with this product name.\n" }, { "name": "type", "value": "", "type": "query", "description": "\nList devices with this type.\n" }, { "name": "serial", "value": "", "type": "query", "description": "\nList devices with this serial number.\n" }, { "name": "tag", "value": "", "type": "query", "description": "\nList devices which have a tag. Searching for multiple tags (logical AND) can be done by comma separating the `tag` values or adding several `tag` parameters.\n" }, { "name": "software", "value": "", "type": "query", "description": "\nList devices with this software version.\n" }, { "name": "upgradeChannel", "value": "", "type": "query", "description": "\nList devices with this upgrade channel.\n" }, { "name": "errorCode", "value": "", "type": "query", "description": "\nList devices with this error code.\n" }, { "name": "capability", "value": "xapi", "type": "query", "description": "\nList devices with this capability.\n" }, { "name": "permission", "value": "", "type": "query", "description": "\nList devices with this permission.\n" }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by location ID.\n" }, { "name": "workspaceLocationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=", "type": "query", "description": "\nList devices by workspace location ID. Deprecated, prefer `locationId`.\n" }, { "name": "mac", "value": "", "type": "query", "description": "\nList devices with this MAC address.\n" }, { "name": "devicePlatform", "value": "cisco", "type": "query", "description": "\nList devices with this device platform.\n" }, { "name": "plannedMaintenance", "value": "off", "type": "query", "description": "\nList devices with this planned maintenance.\n" } ] }, "docs": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the `spark:devices_read` scope. Administrators can list all devices within their organization. This requires an administrator auth token with the `spark-admin:devices_read` scope." }, { "info": { "name": "Create a Device by MAC Address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone confi" }, { "info": { "name": "Get Device Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "\nA unique identifier for the device.\n" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ] }, "docs": "Shows 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 any other device in your organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI." }, { "info": { "name": "Modify Device Tags", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "Unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, 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 `spark-admin:devices_write` scope is required to operate on other devices within the organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\nInclude only the tag array in the request body, no other device attributes can be changed. This action will overwrite any previous tags. A common approach is to first [GET the devices'" }, { "info": { "name": "Delete a Device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3", "type": "path", "description": "A unique identifier for the device." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the device. If left empty, the organization associated with the caller will be used." } ] }, "docs": "Deletes 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 will require an administrator auth token with the `spark-admin:devices_write` scope.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\n
Deleting a device from a person with a Webex Calling Standard license will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications." }, { "info": { "name": "Create a Device Activation Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/activationCode", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ", "type": "query", "description": "The organization associated with the activation code generated. If left empty, the organization associated with the caller will be used." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate 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 `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace callin" } ] }, { "info": { "name": "Hot Desk", "type": "folder" }, "items": [ { "info": { "name": "List Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotdesk/sessions", "params": [ { "name": "orgId", "value": "Y2lzY29...", "type": "query", "description": "List sessions in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "personId", "value": "YL34EmA...", "type": "query", "description": "List sessions for this person." }, { "name": "workspaceId", "value": "YL34EmB...", "type": "query", "description": "List sessions for this workspace." } ] }, "docs": "List hot desk sessions.\n\nUse query parameters to filter the response.\nThe `orgId` parameter is for use by partner administrators acting on a managed organization.\nThe `personId` and `workspaceId` parameters are optional and are used to filter the response to only include sessions for a specific person or workspace.\nWhen used together they are used as an AND filter." }, { "info": { "name": "Delete Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotdesk/sessions/:sessionId", "params": [ { "name": "sessionId", "value": "Y2lzY29zcGFyazovL3VzL0hEU0VTU0lPTi9lZTY1NDQ5OC00OGU5LTQxMTItOWYxMi1lZmJiYTJkOTE4ZWV8MjAyNC0wNS0xMVQxMDowMDowMFo=", "type": "path", "description": "The unique identifier for the hot desk session." } ] }, "docs": "Delete a hot desk session." } ] }, { "info": { "name": "Locations", "type": "folder" }, "items": [ { "info": { "name": "List Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/locations", "params": [ { "name": "name", "value": "Denver", "type": "query", "description": "List locations whose name contains this string (case-insensitive)." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw", "type": "query", "description": "List locations by ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List locations in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of location in the response." } ] }, "docs": "List locations for an organization.\n\n* Use query parameters to filter the result set by location name, ID, or organization.\n\n* Long result sets will be split into [pages](/docs/basics#pagination).\n\n* Searching and viewing locations in your organization requires an administrator or location administrator auth token with any of the following scopes: `spark-admin:locations_read`, `spark-admin:people_read` or `spark-admin:device_read`." }, { "info": { "name": "Create a Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/locations", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create a location common attribute for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Location for a given organization. Only an admin in the organization can create a new Location.\n\n* Creating a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Partners may specify `orgId` query parameter to create location in managed organization.\n\n* The following body parameters are required to create a new location: \n * `name`\n * `timeZone`\n * `preferredLanguage`\n * `address`\n * `announcementLan" }, { "info": { "name": "Get Location Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/locations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw", "type": "path", "description": "A unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get location common attributes for this organization." } ] }, "docs": "Shows details for a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Use query parameter `orgId` to filter the result set by organization(optional).\n\n* Searching and viewing location in your organization requires an administrator or location administrator auth token with any of the following scopes:\n\n * `spark-admin:locations_read`\n * `spark-admin:people_read`\n * `spark-admin:device_read`" }, { "info": { "name": "Update a Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/locations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "Update location common attributes for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update location common attributes for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details for a location, by ID.\n\n* Updating a location in your organization requires a full administrator or location administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Partners may specify `orgId` query parameter to update location in managed organization.\n\n* **Important:** While the `name` field supports up to 256 characters, locations that are enabled for Webex Calling must have names with a max" }, { "info": { "name": "Delete Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/locations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw", "type": "path", "description": "A unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Specify the organization for the location to be deleted." } ] }, "docs": "Delete a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Deleting a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* NOTE: Disabling Webex Calling for a Webex Calling enabled location is required prior to deleting a location." }, { "info": { "name": "List Location Floors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/locations/:locationId/floors", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "A unique identifier for the location." } ] }, "docs": "List location floors.\nRequires an administrator auth token with the `spark-admin:locations_read` scope." }, { "info": { "name": "Create a Location Floor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/locations/:locationId/floors", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "A unique identifier for the location." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create 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 set.\nRequires an administrator auth token with the `spark-admin:locations_write` scope." }, { "info": { "name": "Get Location Floor Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/locations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY", "type": "path", "description": "A unique identifier for the floor." } ] }, "docs": "Shows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:locations_read` scope." }, { "info": { "name": "Update a Location Floor", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/locations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY", "type": "path", "description": "A unique identifier for the floor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates 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 [Get Location Floor Details](/docs/api/v1/locations/get-location-floor-details). Omitting the optional `displayName` field will result in that field no longer being defined for the floor.\nRequires an administrator auth token with the `spark-admin:locations_write` scope." }, { "info": { "name": "Delete a Location Floor", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/locations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY", "type": "path", "description": "A unique identifier for the floor." } ] }, "docs": "Deletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:locations_write` scope." } ] }, { "info": { "name": "Workspace Locations", "type": "folder" }, "items": [ { "info": { "name": "List Workspace Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceLocations", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "displayName", "value": "Cisco Barcelona", "type": "query", "description": "Location display name." }, { "name": "address", "value": "Carrer de Pere IV, Barcelona, Spain", "type": "query", "description": "Location address." }, { "name": "countryCode", "value": "ES", "type": "query", "description": "Location country code (ISO 3166-1)." }, { "name": "cityName", "value": "Barcelona", "type": "query", "description": "Location city name." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace locations. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another\norganization (such as partners). The `displayName`," }, { "info": { "name": "Create a Workspace Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaceLocations", "body": { "type": "json", "data": "{}" } }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a location. The `cityName` and `notes` parameters are optional, and omitting them will result in the creation of a location without values for those attributes.\nRequires an adminis" }, { "info": { "name": "Get a Workspace Location Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceLocations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read`" }, { "info": { "name": "Update a Workspace Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workspaceLocations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI. The request should include all details for the location returned in a previous cal" }, { "info": { "name": "Delete a Workspace Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaceLocations/:locationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a location, by ID. The workspaces associated to that location will no longer have a location, but a new location can be reassigned to them.\nRequires an administrator auth token wi" }, { "info": { "name": "List Workspace Location Floors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceLocations/:locationId/floors", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace location floors.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope." }, { "info": { "name": "Create a Workspace Location Floor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaceLocations/:locationId/floors", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate 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 set.\nRequires an administrator" }, { "info": { "name": "Get a Workspace Location Floor Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "xx", "type": "path", "description": "A unique identifier for the floor." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope." }, { "info": { "name": "Update a Workspace Location Floor", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "xx", "type": "path", "description": "A unique identifier for the floor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates 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 [Get Workspace Location Fl" }, { "info": { "name": "Delete a Workspace Location Floor", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaceLocations/:locationId/floors/:floorId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==", "type": "path", "description": "A unique identifier for the location." }, { "name": "floorId", "value": "xx", "type": "path", "description": "A unique identifier for the floor." } ] }, "docs": "
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope." } ] }, { "info": { "name": "Workspace Metrics", "type": "folder" }, "items": [ { "info": { "name": "Workspace Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceMetrics", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the workspace to get metrics for." }, { "name": "metricName", "value": "temperature", "type": "query", "description": "The type of data to extract." }, { "name": "aggregation", "value": "hourly", "type": "query", "description": "Time unit over which to aggregate measurements." }, { "name": "from", "value": "2020-10-21T13:33:37.789Z", "type": "query", "description": "List only data points after a specific date and time (ISO 8601 timestamp)" }, { "name": "to", "value": "2020-10-31T16:00:00.532Z", "type": "query", "description": "List data points before a specific date and time (ISO 8601 timestamp)" }, { "name": "unit", "value": "celsius", "type": "query", "description": "Output data unit (only a valid parameter if `metricName` is `temperature`)." }, { "name": "sortBy", "value": "newestFirst", "type": "query", "description": "Sort results." } ] }, "docs": "Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period.\n\n* The `workspaceId` and `metricName` parameters indicate which workspace to fetch metrics for and what kind of metrics to get.\n\n* When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when" }, { "info": { "name": "Workspace Duration Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaceDurationMetrics", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the workspace to get metrics for." }, { "name": "aggregation", "value": "hourly", "type": "query", "description": "Unit of time over which to aggregate measurements." }, { "name": "measurement", "value": "timeBooked", "type": "query", "description": "The measurement to return duration for." }, { "name": "from", "value": "2020-10-21T13:33:37.789Z", "type": "query", "description": "Include data points after a specific date and time (ISO 8601 timestamp)." }, { "name": "to", "value": "2020-10-31T16:00:00.532Z", "type": "query", "description": "Include data points before a specific date and time (ISO 8601 timestamp)." } ] }, "docs": "Get metrics for how much time a workspace has been in the state given by the `measurement` parameter.\n\nFor example, if the measurement is `timeBooked` then the duration for which the workspace has been booked is returned. The `workspaceId` parameter indicates which workspace to fetch metrics for. If no `measurement` is given, the default value is `timeUsed`.\n\n* When executing a query, the result bucket start times will default to the start of an hour or a day, depending on\nthe aggregation inter" } ] }, { "info": { "name": "Workspace Personalization", "type": "folder" }, "items": [ { "info": { "name": "Personalize a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces/:workspaceId/personalize", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initializes the personalization for a given workspace for the user email provided.\n\nThe personalization process is asynchronous and thus a background task is created when this endpoint is invoked.\nAfter successful invocation of this endpoint a personalization task status URL will be returned in the `Location` header, which will point to the [Get Personalization Task](/docs/api/v1/workspace-personalization/get-personalization-task) endpoint for this workspace.\nThe task should be completed in appr" }, { "info": { "name": "Get Personalization Task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspaceId/personalizationTask", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ] }, "docs": "Returns the status of a personalization task for a given workspace.\n\nWhilst in progress the endpoint will return `Accepted` and provide a `Retry-After` header indicating the number of seconds a client should wait before retrying.\n\nUpon completion of the task, the endpoint will return `OK` with a body detailing if the personalization was successful and an error description if appropriate." } ] }, { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "locationId", "value": "YL34GrT...", "type": "query", "description": "Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API." }, { "name": "workspaceLocationId", "value": "YL34GrT...", "type": "query", "description": "Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer `locationId` going forward." }, { "name": "floorId", "value": "Y2lzY29z...", "type": "query", "description": "Floor associated with the workspace." }, { "name": "displayName", "value": "SFO-12 Capanina", "type": "query", "description": "List workspaces by display name." }, { "name": "capacity", "value": "5", "type": "query", "description": "List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set." }, { "name": "type", "value": "focus", "type": "query", "description": "List workspaces by type." }, { "name": "start", "value": "50", "type": "query", "description": "Offset. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of workspaces in the response." }, { "name": "calling", "value": "freeCalling", "type": "query", "description": "List workspaces by calling type." }, { "name": "supportedDevices", "value": "collaborationDevices", "type": "query", "description": "List workspaces by supported devices." }, { "name": "calendar", "value": "none", "type": "query", "description": "List workspaces by calendar type." }, { "name": "deviceHostedMeetingsEnabled", "value": "true", "type": "query", "description": "List workspaces enabled for device hosted meetings." }, { "name": "devicePlatform", "value": "cisco", "type": "query", "description": "List workspaces by device platform." }, { "name": "healthLevel", "value": "error", "type": "query", "description": "List workspaces by health level." }, { "name": "includeDevices", "value": "false", "type": "query", "description": "Flag identifying whether to include the devices associated with the workspace in the response." }, { "name": "includeCapabilities", "value": "false", "type": "query", "description": "Flag identifying whether to include the workspace capabilities in the response." }, { "name": "plannedMaintenance", "value": "off", "type": "query", "description": "List workspaces with given maintenance mode." }, { "name": "customAttribute", "value": "myKey", "type": "query", "description": "List workspaces with given custom attribute key." } ] }, "docs": "List workspaces.\n\nUse query parameters to filter the response. The `orgId` parameter can only be used by admin users of another organization (such as partners). The `locationId`, `workspaceLocationId`, `indoorNavigation`, `floorId`, `capacity` and `type` fields will only be present for workspaces that have a value set for them. The special values `notSet` (for filtering on category) and `-1` (for filtering on capacity) can be used to filter for workspaces without a type and/or capacity." }, { "info": { "name": "Create a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces", "body": { "type": "json", "data": "{}" } }, "docs": "Create a workspace.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type`, `notes` and `hotdeskingStatus` parameters are optional, and omitting them will result in the creation of a workspace without these values set, or set to their default. A `locationId` must be provided when the `floorId` is set. Calendar and calling can also be set for a new workspace. Omitting them will default to free calling and no calendaring. The `orgId` parameter can only be used " }, { "info": { "name": "Get Workspace Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." }, { "name": "includeDevices", "value": "false", "type": "query", "description": "Flag identifying whether to include the devices associated with the workspace in the response." }, { "name": "includeCapabilities", "value": "false", "type": "query", "description": "Flag identifying whether to include the workspace capabilities in the response." } ] }, "docs": "Shows details for a workspace, by ID.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type` and `notes` fields will only be present if they have been set for the workspace. Specify the workspace ID in the `workspaceId` parameter in the URI." }, { "info": { "name": "Update a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates details for a workspace by ID.\n\nSpecify the workspace ID in the `workspaceId` parameter in the URI. Include all details for the workspace that are present in a [GET request for the workspace details](/docs/api/v1/workspaces/get-workspace-details). Not including the optional `capacity`, `type` or `notes` fields will result in the fields no longer being defined for the workspace. A `locationId` must be provided when the `floorId` is set. The `locationId`, `workspaceLocationId`, `floorId`, " }, { "info": { "name": "Delete a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ] }, "docs": "Deletes a workspace by ID.\n\nAlso deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID in the `workspaceId` parameter in the URI." }, { "info": { "name": "Get Workspace Capabilities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspaceId/capabilities", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ] }, "docs": "Shows the capabilities for a workspace by ID.\n\nReturns a set of capabilities, including whether or not the capability is supported by any device in the workspace, and if the capability is configured (enabled). For example for a specific capability like `occupancyDetection`, the API will return if the capability is supported and/or configured such that occupancy detection data will flow from the workspace (device) to the cloud. Specify the workspace ID in the `workspaceId` parameter in the URI." } ] }, { "info": { "name": "xAPI", "type": "folder" }, "items": [ { "info": { "name": "Query Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/xapi/status", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM", "type": "query", "description": "The unique identifier for the Webex RoomOS Device." }, { "name": "name", "value": "audio.volume", "type": "query", "description": "A list of status expressions used to query the Webex RoomOS Device. See the [xAPI section of the Device Developers Guide](/docs/api/guides/device-developers-guide#xapi) for a description of status expressions. A request can contain at most 10 different status expressions." } ] }, "docs": "Query 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 statuses according to the expression in the `name` parameter.\n\nSee the [xAPI section of the Device Developers Guide](/docs/api/guides/device-developers-guide#xapi) or the [xAPI Command Reference](https://roomos.cisco.com/xapi) for a description of status expressions." }, { "info": { "name": "Query Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/xapi/schema", "params": [ { "name": "deviceId", "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM", "type": "query", "description": "A list of device IDs to query schemas from. A request can contain at most 5 device IDs." }, { "name": "status", "value": "Conference.*", "type": "query", "description": "A list of status key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_statuses` scope." }, { "name": "command", "value": "UserInterface.*", "type": "query", "description": "A list of command key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_commands` scope." } ] }, "docs": "Query the schema for statuses and commands of Webex RoomOS Devices. You specify the target devices in the `deviceId` parameter in the URI. Querying command schemas requires the `spark:xapi_commands` scope and querying status schemas requires the `spark:xapi_statuses` scope.\n\nIf no `status` or `command` expressions are specified, the full schema is returned, including both status and command schemas. If you specify any expression, the response is limited to only the types you queried for. For exa" }, { "info": { "name": "Execute Command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/xapi/command/:commandName", "params": [ { "name": "commandName", "value": "Audio.Volume.Set", "type": "path", "description": "Command to execute on the Webex RoomOS Device." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Executes a command on the Webex RoomOS Device. Specify the command to execute in the `commandName` URI parameter.\n\nSee the [xAPI section of the Device Developers Guide](/docs/devices#xapi) for a description of command expressions." } ] } ], "bundled": true }