Get Location Device Settings
Get device override settings for a location.
This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Unique identifier for the location.
Query Parameters
Organization in which the device resides.
Response Properties
Indicates the customization object of the device settings.
Applicable device settings for an ATA device.
Choose up to three predefined codec priority options available for your region.
Indicates the selection of an Audio Codec Priority Object.
Indicates the regional selection type for audio codec priority.
Indicates the custom selection type for audio codec priority.
Indicates the primary Audio Codec.
Indicates the secondary Audio Codec.
Indicates the tertiary Audio Codec.
DTMF Detection Tx Mode selection for Cisco ATA devices.
A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.
Normal threshold mode.
Method for transmitting DTMF signals to the far end.
Sends DTMF by using the audio path.
Audio video transport. Sends DTMF as AVT events.
Uses InBand or AVT based on the outcome of codec negotiation.
Enable/disable Cisco Discovery Protocol for local devices.
Enable/disable Link Layer Discovery Protocol for local devices.
Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform.
Specify a numeric Virtual LAN ID for devices.
Denotes whether the VLAN object of an ATA is enabled.
The value of the VLAN Object of an ATA object.
Enable/disable user level web access to the local device.
Enable/disable the automatic nightly configuration resync of the MPP device.
Specify values needed to enable use of the SNMP service from the phone.
Denotes whether the Simple Network Management Protocol of an ATA is enabled.
Trusted IPv4 address and subnet mask in this order: 0.0.0.0/0.0.0.0.
Read-only community string that allows/denies access to other device's statistics. Default value is public.
Read-write community string that protects the device against unauthorized changes. Must never be set to public.
Denotes whether the SNMPv3 security is enabled.
Applicable device settings for an MPP device.
Indicates whether the PNAC of MPP object is enabled or not.
Choose up to three predefined codec priority options available for your region.
Indicates the selection of the Audio Codec Priority Object for an MPP object.
Indicates the primary Audio Codec for an MPP object.
Indicates the secondary Audio Codec for an MPP object.
Indicates the tertiary Audio Codec for an MPP object.
Choose the length of time (in minutes) for the phone's backlight to remain on.
Set the phone's backlight to be on for one minute.
Set the phone's backlight to be on for five minutes.
Set the phone's backlight to be on for thirty minutes.
Keep the phone's backlight always on.
Holds the background object of MPP Object.
Indicates that there will be no background image set for the devices.
Indicates that dark blue background image will be set for the devices.
Indicates that Cisco themed dark blue background image will be set for the devices.
Indicates that Cisco Webex dark blue background image will be set for the devices.
Indicates that a custom background image will be set for the devices.
When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.
The display name that appears on the phone screen.
Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.
Indicates that devices will display the name in first name then last name format.
Indicates that devices will display the name in last name then first name format.
Allows you to enable/disable CDP for local devices.
Choose the desired logging level for an MPP devices.
Enables standard logging.
Enables detailed debugging logging.
Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones.
Holds the Acd object value.
Indicates whether the ACD object is enabled.
Indicates the call queue agent soft key value of an ACD object.
Indicates the short inter digit timer value.
Indicates the long inter digit timer value..
Line key labels define the format of what's shown next to line keys.
This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed.
Indicates that devices will display the name in first name then last name format.
Indicates that devices will display the name in last name then first name format.
LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875
Enable/disable Link Layer Discovery Protocol for local devices.
Enable/disable user-level access to the web interface of Multi-Platform Phones.
Select up to 10 Multicast Group URLs (each with a unique Listening Port).
Specify the enhanced multicast settings for the MPP device.
Specify the URL for the XML application.
Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout.
Specify the multicast group URL and listening port.
Specify whether the multicast group URL has an XML application URL.
Specify the timeout for the XML application.
Specify the amount of time (in seconds) that a phone can remain off-hook.
Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location.
Indicates a person's announcement language.
Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones.
Use normal power consumption.
Use maximum power consumption.
Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform.
Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates.
Indicates whether the Screen Time object is enabled.
Indicates the value of screen timeout.
Enable/disable the use of the USB ports on Multi-Platform phones.
Specify a numeric Virtual LAN ID for devices.
Indicates whether the VLAN object of an MPP is enabled.
Indicates the value of a VLAN object for an MPP object.
Indicates the PC port value of a VLAN object for an MPP object.
Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
Indicates whether the wifi network is enabled.
Authentication method of wifi network.
No authentication.
Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.
Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.
Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.
Pre-Shared Key. Requires shared passphrase for authentication.
Wired Equivalent Privacy. Requires encryption key for authentication.
SSID name of the wifi network.
User Id of the wifi network.
Specify the call history information to use. Only applies to user devices.
Set call history to use the unified call history from all of the end user's devices.
Set call history to use local device information only.
Specify the directory services to use.
Set directory services to use standard XSI query method from the device.
Set directory services to use the Webex Enterprise directory.
Enable/disable the availability of the webex meetings functionality from the phone.
Specify all volume level values on the phone.
Specify a ringer volume level through a numeric value between 0 and 15.
Specify a speaker volume level through a numeric value between 0 and 15.
Specify a handset volume level through a numeric value between 0 and 15.
Specify a headset volume level through a numeric value between 0 and 15.
Enable/disable the wireless headset hookswitch control.
Enable/disable to preserve the existing values on the phone and not the values defined for the device settings.
Specify the call forward expanded soft key behavior.
Set the default call forward expanded soft key behavior to single option.
Set the default call forward expanded soft key behavior to multiple menu option.
Specify HTTP Proxy values.
Mode of the HTTP proxy.
Enable/disable auto discovery of the URL.
Specify the host URL if the HTTP mode is set to MANUAL.
Specify the port if the HTTP mode is set to MANUAL.
Specify PAC URL if auto discovery is disabled.
Enable/disable authentication settings.
Specify a username if authentication settings are enabled.
Specify a password if authentication settings are enabled.
Enable/disable the visibility of the bluetooth menu on the MPP device.
Enable/disable Bluetooth.
Select a Bluetooth mode.
Enable/disable the use of the PC passthrough ethernet port on supported phone models.
Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device.
Enable/disable the default screen behavior when inbound calls are received.
Enable/disable peer firmware sharing.
Enable/disable local noise cancellation on active calls from the device.
Enable/disable the Noise Cancellation.
Enable/disable to preserve the existing values on the phone and not the value defined for the device setting.
Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device.
Enable/disable availability of dial assist feature on the phone.
Specify the number of calls per unique line appearance on the phone.
Enable/disable automatic nightly configuration resync of the MPP device.
Enable/disable the visual indication of missed calls.
Specify the softkey layout per phone menu state.
Customize SoftKey menu settings.
Specify the idle key list.
Specify the off hook key list.
Specify the dialing input key list.
Specify the progressing key list.
Specify the connected key list.
Specify the connected video key list.
Start the transfer key list.
Start the conference key list.
Specify the conferencing key list.
Specify the releasing key list.
Specify the hold key list.
Specify the ringing key list.
Specify the shared active key list.
Specify the shared held key list.
Customize PSK.
Specify PSK1.
Specify PSK2.
Specify PSK3.
Specify PSK4.
Specify PSK5.
Specify PSK6.
Specify PSK7.
Specify PSK8.
Specify PSK9.
Specify PSK10.
Specify PSK11.
Specify PSK12.
Specify PSK13.
Specify PSK14.
Specify PSK15.
Specify PSK16.
Default SoftKey menu settings.
Specify the idle key list.
Specify the off hook key list.
Specify the dialing input key list.
Specify the progressing key list.
Specify the connected key list.
Specify the connected video key list.
Start the transfer key list.
Start the conference key list.
Specify the conferencing key list.
Specify the releasing key list.
Specify the hold key list.
Specify the ringing key list.
Specify the shared active key list.
Specify the shared held key list.
Default PSK.
Specify PSK1.
Specify PSK2.
Specify PSK3.
Specify PSK4.
Specify PSK5.
Specify PSK6.
Specify PSK7.
Specify PSK8.
Specify PSK9.
Specify PSK10.
Specify PSK11.
Specify PSK12.
Specify PSK13.
Specify PSK14.
Specify PSK15.
Specify PSK16.
Specify the image option for the MPP 8875 phone background.
Indicates that dark cyan background image will be set for the devices.
Indicates the dark purple background image will be set for the devices.
Indicates the dark blue background image will be set for the devices.
Indicates the dark violet background image will be set for the devices.
Indicates the light blue background image will be set for the devices.
Indicates the light violet background image will be set for the devices.
Specify the use of the backlight feature on 6800 nad 7800 series devices.
Keep the phone's backlight always on.
Set the phone's backlight to be on for ten seconds.
Set the phone's backlight to be on for twenty seconds.
Set the phone's backlight to be on for thirty seconds.
Keep the phone's backlight off.
Enable/disable monitoring for MPP non-primary device.
Enable/disable SIP media streams to go directly between phones on the same local network.
Applicable device settings for a WiFi device.
Choose up to three predefined codec priority options available for your region.
Indicates the selection of the Audio Codec Priority Object for an WiFi object.
Indicates the regional selection type for audio codec priority.
Indicates the custom selection type for audio codec priority.
Indicates the primary Audio Codec for an WiFi object.
Indicates the secondary Audio Codec for an WiFi object.
Indicates the tertiary Audio Codec for an WiFi object.
Set the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Indicates the selection of the protocol for LDAP service on the phone.
Sets the LDAP server security protocol to None.
Sets the LDAP server security protocol to SSL.
Sets the LDAP server security protocol to STARTTLS.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Sets the values needed to enable use of the LDAP service on the phone.
Set the availability of the local end user web access for an 840/860 WiFi phone.
Ability to enable or disable the web browser access for the 840/860.
Ability to set a Web Server Password.
Set the local security password on an 840/860 WiFi phone.
Indicates if customization is allowed at a location level. If true, customized at a location level. If false, not customized; uses customer-level configuration.
Customer devices setting update status. If true, an update is in progress (no further changes are allowed). If false, no update in progress (changes are allowed).
Number of devices that will be updated.
Indicates the last updated time.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Organization in which the device resides.
{
"customizations": {
"ata": {
"audioCodecPriority": {
"selection": "REGIONAL",
"primary": "G711a",
"secondary": "G711u",
"tertiary": "G729a"
},
"ataDtmfMode": "STRICT",
"ataDtmfMethod": "AVT",
"cdpEnabled": true,
"lldpEnabled": true,
"qosEnabled": true,
"vlan": {
"enabled": true,
"value": 1
},
"webAccessEnabled": true,
"nightlyResyncEnabled": true,
"snmp": {
"enabled": false,
"trustedIP": "0.0.0.0/0.0.0.0",
"getCommunity": "public",
"setCommunity": "private",
"snmpV3Enabled": false
}
},
"mpp": {
"pnacEnabled": true,
"audioCodecPriority": {
"selection": "CUSTOM",
"primary": "OPUS",
"secondary": "G722",
"tertiary": "G711u"
},
"backlightTimer": "ONE_M",
"background": {
"image": "WEBEX_DARK_BLUE"
},
"displayNameFormat": "PERSON_FIRST_THEN_LAST_NAME",
"cdpEnabled": false,
"defaultLoggingLevel": "STANDARD",
"dndServicesEnabled": true,
"acd": {
"enabled": true,
"displayCallqueueAgentSoftkeys": "LAST_PAGE"
},
"shortInterdigitTimer": 14,
"longInterdigitTimer": 16,
"lineKeyLabelFormat": "PERSON_EXTENSION",
"lineKeyLEDPattern": "DEFAULT",
"lldpEnabled": false,
"mppUserWebAccessEnabled": true,
"multicast": [
"192.86.108.226:22"
],
"enhancedMulticast": {
"xmlAppUrl": "http://127.0.0.1:8080/",
"multicastList": [{
"hostAndPort": "224.0.0.0:22",
"hasXmlAppUrl": true,
"xmlAppTimeout": 10
}]
},
"offHookTimer": 30,
"phoneLanguage": "RUSSIAN",
"poeMode": "MAXIMUM",
"qosEnabled": true,
"screenTimeout": {
"enabled": true,
"value": 400
},
"usbPortsEnabled": true,
"vlan": {
"enabled": false,
"value": 1,
"pcPort": 1
},
"wifiNetwork": {
"enabled": false,
"authenticationMethod": "PSK",
"ssidName": "my_wifi_network",
"userId": "test-user"
},
"callHistory": "LOCAL_CALL_HISTORY",
"contacts": "WEBEX_DIRECTORY",
"webexMeetingsEnabled": false,
"usbPorts": {
"enabled": true,
"sideUsbEnabled": true,
"rearUsbEnabled": true
},
"volumeSettings": {
"ringerVolume": 9,
"speakerVolume": 9,
"handsetVolume": 9,
"headsetVolume": 9,
"eHookEnabled": false,
"allowEndUserOverrideEnabled": false
},
"httpProxy": {
"mode": "OFF",
"autoDiscoveryEnabled": false,
"host": "localhost",
"port": "8080",
"packUrl": "www.webex.com",
"authSettingsEnabled": true,
"username": "usernamecpi"
},
"bluetooth": {
"enabled": true,
"mode": "PHONE"
},
"passThroughPortEnabled": true,
"userPasswordOverrideEnabled": true,
"activeCallFocusEnabled": true,
"peerFirmwareEnabled": true,
"noiseCancellation": {
"enabled": false,
"allowEndUserOverrideEnabled": false
},
"dialAssistEnabled": true,
"callsPerLine": 8,
"nightlyResyncEnabled": true,
"missedCallNotificationEnabled": false,
"softKeyLayout": {
"softKeyMenu": {
"idleKeyList": "abcdefgh",
"offHookKeyList": "nmhsdjs",
"dialingInputKeyList": "djsks",
"progressingKeyList": "sdsd",
"connectedKeyList": "ssdds",
"connectedVideoKeyList": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"startTransferKeyList": "abcdef",
"startConferenceKeyList": "abcdef",
"conferencingKeyList": "abcdef",
"releasingKeyList": "abcdef",
"holdKeyList": "abcdef",
"ringingKeyList": "abcdef",
"sharedActiveKeyList": "abcdef",
"sharedHeldKeyList": "abcdef"
},
"psk": {
"psk1": "abcdef",
"psk2": "abcdef",
"psk3": "abcdef",
"psk4": "abcdef",
"psk5": "abcdef",
"psk6": "abcdef",
"psk7": "abcdef",
"psk8": "abcdef",
"psk9": "abcdef",
"psk10": "abcdef",
"psk11": "abcdef",
"psk12": "abcdef",
"psk13": "abcdef",
"psk14": "abcdef",
"psk15": "abcdef",
"psk16": "veeresh"
},
"softKeyMenuDefaults": {
"idleKeyList": "guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages",
"offHookKeyList": "endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7",
"dialingInputKeyList": "dial|1;cancel|2;delchar|3;left|5;right|6",
"progressingKeyList": "endcall|2",
"connectedKeyList": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"connectedVideoKeyList": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"startTransferKeyList": "endcall|2;xfer|3",
"startConferenceKeyList": "endcall|2;conf|3",
"conferencingKeyList": "endcall;join;crdstart;crdstop;crdpause;crdresume",
"releasingKeyList": "endcall|2",
"holdKeyList": "resume|1;endcall|2;newcall|3;redial|4;dir|5",
"ringingKeyList": "answer|1;ignore|2",
"sharedActiveKeyList": "newcall|1;psk1|2;dir|3;back|4",
"sharedHeldKeyList": "resume|1;dir|4"
},
"pskDefaults": {
"psk1": "fnc=sd;ext=*11;nme=Call Pull"
}
},
"backgroundImage8875": "BLUE_LIGHT",
"backlightTimer68XX78XX": "THIRTY_SEC",
"allowMonitorLinesEnabled": false,
"voiceFeedbackAccessibilityEnabled": false,
"iceEnabled": true
},
"wifi": {
"audioCodecPriority": {
"selection": "REGIONAL",
"primary": "OPUS",
"secondary": "G722",
"tertiary": "G711u"
},
"ldap": {},
"webAccess": {
"enabled": false
}
}
},
"customEnabled": false,
"updateInProgress": true,
"deviceCount": 9,
"lastUpdateTime": 1659624763665
}