Webex · Example Payload

Webex Initiate Number Jobs Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Initiate Number Jobs 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": "Initiate Number Jobs",
  "method": "POST",
  "path": "/telephony/config/jobs/numbers/manageNumbers",
  "summary": "Initiate Number Jobs",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "name": "managenumbers",
        "id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84M2U1MjNlYy02NjY2LTRlZjAtODcwYi0xZjViZGI1NDNhZDU",
        "jobType": "managenumbers",
        "trackingId": "NA_c989fd47-391e-47c0-8fe4-b45711871a42",
        "sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU",
        "sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
        "targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
        "instanceId": 0,
        "jobExecutionStatus": [
          {
            "id": 0,
            "startTime": "2022-09-13T10:56:41.241Z",
            "lastUpdated": "2022-09-13T10:56:41.242Z",
            "statusMessage": "STARTED",
            "exitCode": "UNKNOWN",
            "createdTime": "2022-09-13T10:56:41.054Z",
            "timeElapsed": "PT0S"
          }
        ],
        "latestExecutionStatus": "STARTED",
        "latestExecutionExitCode": "UNKNOWN",
        "operationType": "MOVE",
        "sourceLocationId": "5223bbed-42c9-454d-a1f3-7fad5cc7e6e3",
        "targetLocationId": "81b53c97-414d-48cc-ae8b-cafc40784007",
        "counts": {
          "totalNumbers": 0,
          "numbersDeleted": 0,
          "numbersMoved": 0,
          "numbersFailed": 0,
          "numbersUsageChanged": 0
        }
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "error": {
          "key": "400",
          "message": [
            {
              "description": "Invalid phone number.",
              "code": "BATCH-1017017",
              "location": null
            }
          ]
        },
        "trackingId": "ROUTER_6364F0A9-D48A-01BB-0128-0AFDEB7B0128"
      }
    }
  ]
}