Chilkat Online Tools

PureBasic / Zoom API / List Zoom Room devices

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.zoom.us/v2/rooms/:roomId/devices",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "devices": [
    ;     {
    ;       "id": "sajhdfshf24324",
    ;       "room_name": "MyAwesomeZoomRoom",
    ;       "device_type": "Zoom Rooms Computer",
    ;       "app_version": "4.4.1 (1242.0623)",
    ;       "device_system": "Win 10",
    ;       "status": "Online"
    ;     },
    ;     {
    ;       "id": "32dhgdfg2were",
    ;       "room_name": "MyAwesomeZoomRoom",
    ;       "device_type": "Zoom Rooms Controller",
    ;       "app_version": "4.3.6 (265.0307)",
    ;       "device_system": "iPad 12.3.1",
    ;       "status": "Online"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    id.s
    room_name.s
    device_type.s
    app_version.s
    device_system.s
    status.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"devices")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"devices[i].id")
        room_name = CkJsonObject::ckStringOf(jResp,"devices[i].room_name")
        device_type = CkJsonObject::ckStringOf(jResp,"devices[i].device_type")
        app_version = CkJsonObject::ckStringOf(jResp,"devices[i].app_version")
        device_system = CkJsonObject::ckStringOf(jResp,"devices[i].device_system")
        status = CkJsonObject::ckStringOf(jResp,"devices[i].status")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/:roomId/devices

Postman Collection Item JSON

{
  "name": "List Zoom Room devices",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/rooms/:roomId/devices",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "rooms",
        ":roomId",
        "devices"
      ],
      "variable": [
        {
          "key": "roomId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
        }
      ]
    },
    "description": "List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account.\n\n**Prerequisites:**<br>\n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.<br>\n* Account owner or admin permissions.\n**Scopes**: `room:read:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` **OK**\nDevices listed successfully.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms/:roomId/devices",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            ":roomId",
            "devices"
          ],
          "variable": [
            {
              "key": "roomId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"devices\": [\n  {\n   \"id\": \"sajhdfshf24324\",\n   \"room_name\": \"MyAwesomeZoomRoom\",\n   \"device_type\": \"Zoom Rooms Computer\",\n   \"app_version\": \"4.4.1 (1242.0623)\",\n   \"device_system\": \"Win 10\",\n   \"status\": \"Online\"\n  },\n  {\n   \"id\": \"32dhgdfg2were\",\n   \"room_name\": \"MyAwesomeZoomRoom\",\n   \"device_type\": \"Zoom Rooms Controller\",\n   \"app_version\": \"4.3.6 (265.0307)\",\n   \"device_system\": \"iPad 12.3.1\",\n   \"status\": \"Online\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms/:roomId/devices",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            ":roomId",
            "devices"
          ],
          "variable": [
            {
              "key": "roomId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}