Webex · Example Payload
Webex Validateorinitiatemoveusersjob Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Validateorinitiatemoveusersjob 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

{
  "operationId": "validateOrInitiateMoveUsersJob",
  "method": "POST",
  "path": "/telephony/config/jobs/person/moveLocation",
  "summary": "Validate or Initiate Move Users Job",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "usersList": [
          {
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA",
            "validate": false,
            "users": [
              {
                "userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9teW5hbWUgaXNvcHRpdXMGEyltZXdlYXJlMGEyMGEyNWM1OWE",
                "phoneNumber": "+18632520486"
              },
              {
                "userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTJhYjliZC1jNmUyLTZlYWUtMWE5YS01ZWZhMGEyNWMxNmE",
                "extension": "28544"
              }
            ]
          },
          {
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDkwNS04MGViLWRjY2NiM2VlMTQ0MwFG",
            "validate": false,
            "users": [
              {
                "userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY",
                "extension": "29376",
                "phoneNumber": "+18947028597"
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "response": [
          {
            "userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY",
            "impacts": [
              {
                "code": 19701,
                "message": "[Informational 19701] The identity/device profile the user is using is moved to the new group: GBKAXBRMJUXF, GNXX95CLTQ0V, HD_92dbc8b6-30d1-419f-9386-3340da658f9c, G4O4NVP7MZI5, GQGWO5BDMPLP."
              },
              {
                "code": 19722,
                "message": "[Informational 19722] User CLID number is set to use the new group CLID number: null."
              },
              {
                "code": 19723,
                "message": "[Informational 19723] New group CLID number is not configured."
              }
            ],
            "errors": [
              {
                "code": 4202,
                "message": "[Error 4202] The extension is not available. It is already assigned to a user: 7593. "
              }
            ]
          }
        ]
      }
    },
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "response": {
          "name": "moveusers",
          "id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk",
          "trackingId": "ROUTER_ebb52b5b-d060-4164-9757-48b383423d73",
          "sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY",
          "sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
          "targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
          "instanceId": 10,
          "jobExecutionStatus": [
            {
              "id": 10,
              "startTime": "2023-06-08T12:05:11.798Z",
              "lastUpdated": "2023-06-08T12:05:11.798Z",
              "statusMessage": "STARTED",
              "exitCode": "UNKNOWN",
              "createdTime": "2023-06-08T12:05:11.752Z",
              "timeElapsed": "PT0S"
            }
          ],
          "latestExecutionStatus": "STARTED",
          "latestExecutionExitCode": "UNKNOWN",
          "counts": {
            "totalMoves": 0,
            "moved": 0,
            "failed": 0,
            "pending": 0,
            "skipped": 0,
            "inProgress": 0,
            "notStarted": 0
          }
        }
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "error": [
          {
            "code": 1026016,
            "message": "User should have either phone number or extension."
          }
        ]
      }
    }
  ]
}