Webex · Example Payload

Webex Getlocationdevicesettings Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Getlocationdevicesettings Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "getLocationDeviceSettings",
  "method": "GET",
  "path": "/telephony/config/locations/{locationId}/devices/settings",
  "summary": "Get Location Device Settings",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "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": {
              "customUrl": "",
              "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,
            "cfExpandedSoftKey": "ONLY_THE_CALL_FORWARD_ALL"
          },
          "wifi": {
            "audioCodecPriority": {
              "selection": "REGIONAL",
              "primary": "OPUS",
              "secondary": "G722",
              "tertiary": "G711u"
            },
            "ldap": {},
            "webAccess": {
              "enabled": false
            }
          }
        },
        "customEnabled": false,
        "updateInProgress": true,
        "deviceCount": 9,
        "lastUpdateTime": 1659624763665
      }
    }
  ]
}