Webex · Example Payload
Webex Getworkspacedetails Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Getworkspacedetails 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": "getWorkspaceDetails",
  "method": "GET",
  "path": "/workspaces/{workspaceId}",
  "summary": "Get Workspace Details",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
        "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
        "locationId": "Y2lzY29...",
        "workspaceLocationId": "YL34GrT...",
        "floorId": "Y2lzY29z...",
        "displayName": "SFO-12 Capanina",
        "capacity": 5,
        "type": "notSet",
        "sipAddress": "test_workspace_1@trialorg.room.ciscospark.com",
        "created": "2016-04-21T17:00:00.000Z",
        "calling": {
          "type": "hybridCalling",
          "hybridCalling": {
            "emailAddress": "workspace@example.com"
          },
          "webexCalling": {
            "licenses": [
              "Y2lzY29g4..."
            ]
          }
        },
        "notes": "this is a note",
        "hotdeskingStatus": "on",
        "supportedDevices": "collaborationDevices",
        "calendar": {
          "type": "microsoft",
          "emailAddress": "workspace@example.com"
        },
        "deviceHostedMeetings": {
          "enabled": true,
          "siteUrl": "'example.webex.com'"
        },
        "devicePlatform": "cisco",
        "indoorNavigation": {},
        "health": {
          "level": "error",
          "issues": [
            {
              "id": "",
              "createdAt": "",
              "title": "",
              "description": "",
              "recommendedAction": "",
              "level": {
                "Members": "error"
              }
            }
          ]
        },
        "devices": [
          {
            "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
            "displayName": "SFO12-3-PanHandle",
            "placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
            "workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
            "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
            "capabilities": [
              "xapi"
            ],
            "permissions": [
              "xapi:readonly"
            ],
            "connectionStatus": "connected",
            "product": "Cisco Webex DX80",
            "type": "roomdesk",
            "tags": [
              "First Tag, Second Tag"
            ],
            "ip": "100.110.120.130",
            "activeInterface": "wired",
            "mac": "11:22:33:44:AA:FF",
            "primarySipUrl": "sample_device@sample_workspacename.orgname.org",
            "sipUrls": [
              "sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org"
            ],
            "serial": "FOC1923NVVN",
            "software": "RoomOS 2018-06-01 608dcdbb6e1",
            "upgradeChannel": "beta",
            "created": "2016-04-21T17:00:00.000Z",
            "locationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
            "workspaceLocationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
            "errorCodes": [
              "sipprofileregistration"
            ],
            "firstSeen": "2021-02-24T09:08:38.822Z",
            "lastSeen": "2023-08-15T14:04:00.444Z",
            "managedBy": "CISCO",
            "devicePlatform": "cisco"
          }
        ],
        "capabilities": {
          "occupancyDetection": {
            "supported": true,
            "configured": true
          },
          "presenceDetection": {
            "supported": true,
            "configured": true
          },
          "ambientNoise": {
            "supported": true,
            "configured": true
          },
          "soundLevel": {
            "supported": true,
            "configured": true
          },
          "temperature": {
            "supported": true,
            "configured": true
          },
          "airQuality": {
            "supported": true,
            "configured": true
          },
          "relativeHumidity": {
            "supported": true,
            "configured": true
          }
        }
      }
    }
  ]
}