{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Device Call Settings API",
    "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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP).</Callout></div>\n\n<div><Callout type=\"warning\">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.</Callout></div>\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP).</Callout></div>\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>.\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>.\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>.\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": "<div><Callout type=\"warning\">Not supported for Webex for Government (FedRAMP)</Callout></div>.\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`."
        }
      ]
    }
  ],
  "bundled": true
}