Webex · Example Payload

Webex Changedevicesettingsacrossorganizationorlocationjob Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Changedevicesettingsacrossorganizationorlocationjob 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": "changeDeviceSettingsAcrossOrganizationOrLocationJob",
  "method": "POST",
  "path": "/telephony/config/jobs/devices/callDeviceSettings",
  "summary": "Change Device Settings Across Organization Or Location Job",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
        "locationCustomizationsEnabled": true,
        "customizations": {
          "ata": {
            "audioCodecPriority": {
              "primary": "G711a",
              "secondary": "G711u",
              "tertiary": "G729a",
              "selection": "REGIONAL"
            },
            "ataDtmfMode": "NORMAL",
            "ataDtmfMethod": "AVT",
            "cdpEnabled": true,
            "lldpEnabled": true,
            "qosEnabled": true,
            "vlan": {
              "enabled": true,
              "value": 1
            }
          },
          "dect": {
            "audioCodecPriority": {
              "primary": "G729",
              "secondary": "G711u",
              "tertiary": "G711a",
              "selection": "REGIONAL"
            },
            "cdpEnabled": true,
            "lldpEnabled": false,
            "multicast": [],
            "qosEnabled": true,
            "vlan": {
              "enabled": false,
              "value": null
            }
          },
          "mpp": {
            "pnacEnabled": true,
            "audioCodecPriority": {
              "primary": "OPUS",
              "secondary": "G722",
              "tertiary": "G711u",
              "selection": "CUSTOM"
            },
            "backlightTimer": "FIVE_M",
            "background": {
              "customUrl": "",
              "image": "NONE"
            },
            "displayNameFormat": "PERSON_FIRST_THEN_LAST_NAME",
            "cdpEnabled": false,
            "dndServicesEnabled": true,
            "acd": {
              "enabled": false,
              "displayCallqueueAgentSoftkeys": "LAST_PAGE"
            },
            "shortInterdigitTimer": 14,
            "longInterdigitTimer": 16,
            "lineKeyLabelFormat": "PERSON_FIRST_THEN_LAST_NAME",
            "lineKeyLEDPattern": "DEFAULT",
            "lldpEnabled": false,
            "mppUserWebAccessEnabled": true,
            "multicast": [],
            "enhancedMulticast": {
              "xmlAppUrl": "http://127.0.0.1:8080/",
              "multicastList": [
                {
                  "hostAndPort": "224.0.0.0:22",
                  "hasXmlAppUrl": true,
                  "xmlAppTimeout": 10
                }
              ]
            },
            "offHookTimer": 30,
            "phoneLanguage": "DANISH",
            "poeMode": "MAXIMUM",
            "qosEnabled": true,
            "screenTimeout": {
              "enabled": true,
              "value": 400
            },
            "usbPortsEnabled": true,
            "vlan": {
              "enabled": false,
              "value": 1,
              "pcPort": 1
            },
            "wifiNetwork": {
              "enabled": false,
              "authenticationMethod": "PSK",
              "ssidName": "test_wifi_network",
              "userId": "test"
            },
            "allowMonitorLinesEnabled": false,
            "iceEnabled": true,
            "cfExpandedSoftKey": "ONLY_THE_CALL_FORWARD_ALL"
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "name": "calldevicesettings",
        "id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ",
        "jobType": "calldevicesettings",
        "trackingId": "ROUTER_62F66055-8D70-01BB-0137-AC10A8310137",
        "sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
        "sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
        "targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
        "instanceId": 235142,
        "jobExecutionStatus": [
          {
            "id": 235842,
            "lastUpdated": "2022-08-12T14:15:14.591Z",
            "statusMessage": "STARTING",
            "exitCode": "UNKNOWN",
            "createdTime": "2022-08-12T14:15:14.591Z",
            "timeElapsed": "PT0S"
          }
        ],
        "latestExecutionStatus": "STARTING",
        "latestExecutionExitCode": "UNKNOWN",
        "locationCustomizationsEnabled": false,
        "target": "CUSTOMER",
        "locationId": "",
        "percentageComplete": 0
      }
    }
  ]
}