Chilkat Tools

autoit / Zoom API / List Zoom Rooms

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("page_size",30)
$oQueryParams.UpdateInt("page_number",1)
$oQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/zoomrooms",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "page_count": 1,
;   "page_number": 1,
;   "page_size": 30,
;   "total_records": 1,
;   "zoom_rooms": [
;     {
;       "id": "EbgjgjhghZY9wh0A",
;       "room_name": "testZoomRoom",
;       "calendar_name": "example.cal",
;       "email": "example@example.com",
;       "account_type": "Work Email",
;       "status": "Offline",
;       "device_ip": "Computer : 192.0.2.0",
;       "camera": "Integrated Webcam",
;       "microphone": "Microphone Array (Realtek Audio)",
;       "speaker": "Speakers / Headphones (Realtek Audio)",
;       "last_start_time": "2019-08-29T16:37:07Z",
;       "issues": [
;         "Zoom room is offline"
;       ],
;       "health": "critical"
;     }
;   ]
; }

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

Local $sId
Local $sRoom_name
Local $sCalendar_name
Local $sEmail
Local $sAccount_type
Local $status
Local $sDevice_ip
Local $sCamera
Local $sMicrophone
Local $speaker
Local $sLast_start_time
Local $sHealth
Local $iJ
Local $iCount_j
Local $strVal

Local $iPage_count = $oJResp.IntOf("page_count")
Local $iPage_number = $oJResp.IntOf("page_number")
Local $iPage_size = $oJResp.IntOf("page_size")
Local $iTotal_records = $oJResp.IntOf("total_records")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("zoom_rooms")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("zoom_rooms[i].id")
    $sRoom_name = $oJResp.StringOf("zoom_rooms[i].room_name")
    $sCalendar_name = $oJResp.StringOf("zoom_rooms[i].calendar_name")
    $sEmail = $oJResp.StringOf("zoom_rooms[i].email")
    $sAccount_type = $oJResp.StringOf("zoom_rooms[i].account_type")
    $status = $oJResp.StringOf("zoom_rooms[i].status")
    $sDevice_ip = $oJResp.StringOf("zoom_rooms[i].device_ip")
    $sCamera = $oJResp.StringOf("zoom_rooms[i].camera")
    $sMicrophone = $oJResp.StringOf("zoom_rooms[i].microphone")
    $speaker = $oJResp.StringOf("zoom_rooms[i].speaker")
    $sLast_start_time = $oJResp.StringOf("zoom_rooms[i].last_start_time")
    $sHealth = $oJResp.StringOf("zoom_rooms[i].health")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("zoom_rooms[i].issues")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $strVal = $oJResp.StringOf("zoom_rooms[i].issues[j]")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl -G -d "page_size=30"
	-d "page_number=1"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/zoomrooms

Postman Collection Item JSON

{
  "name": "List Zoom Rooms",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/zoomrooms?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "zoomrooms"
      ],
      "query": [
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        },
        {
          "key": "page_number",
          "value": "1",
          "description": "The page number of the current page in the returned records."
        },
        {
          "key": "next_page_token",
          "value": "quis officia in reprehenderit",
          "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
        }
      ]
    },
    "description": "List information on all Zoom Rooms in an account.<br><br>\n**Scopes:** `dashboard_zr:read:admin`\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br>\n **Prerequisites:**<br>\n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nList of Zoom rooms returned.<br>\nOnly available for paid accounts that have enabled the Dashboard feature.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/zoomrooms?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "zoomrooms"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "page_number",
              "value": "1"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"zoom_rooms\": [\n  {\n   \"id\": \"EbgjgjhghZY9wh0A\",\n   \"room_name\": \"testZoomRoom\",\n   \"calendar_name\": \"example.cal\",\n   \"email\": \"example@example.com\",\n   \"account_type\": \"Work Email\",\n   \"status\": \"Offline\",\n   \"device_ip\": \"Computer : 192.0.2.0\",\n   \"camera\": \"Integrated Webcam\",\n   \"microphone\": \"Microphone Array (Realtek Audio)\",\n   \"speaker\": \"Speakers / Headphones (Realtek Audio)\",\n   \"last_start_time\": \"2019-08-29T16:37:07Z\",\n   \"issues\": [\n    \"Zoom room is offline\"\n   ],\n   \"health\": \"critical\"\n  }\n ]\n}"
    }
  ]
}

Chilkat Online Tools

autoit / Zoom API / List Zoom Rooms

Curl Command

Postman Collection Item JSON