Chilkat Online Tools

Swift / Zoom API / List Zoom Rooms

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateInt("page_size", value: 30)
    queryParams.UpdateInt("page_number", value: 1)
    queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/metrics/zoomrooms", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var room_name: String?
    var calendar_name: String?
    var email: String?
    var account_type: String?
    var status: String?
    var device_ip: String?
    var camera: String?
    var microphone: String?
    var speaker: String?
    var last_start_time: String?
    var health: String?
    var j: Int
    var count_j: Int
    var strVal: String?

    var page_count: Int = jResp.IntOf("page_count").intValue
    var page_number: Int = jResp.IntOf("page_number").intValue
    var page_size: Int = jResp.IntOf("page_size").intValue
    var total_records: Int = jResp.IntOf("total_records").intValue
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("zoom_rooms").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("zoom_rooms[i].id")
        room_name = jResp.StringOf("zoom_rooms[i].room_name")
        calendar_name = jResp.StringOf("zoom_rooms[i].calendar_name")
        email = jResp.StringOf("zoom_rooms[i].email")
        account_type = jResp.StringOf("zoom_rooms[i].account_type")
        status = jResp.StringOf("zoom_rooms[i].status")
        device_ip = jResp.StringOf("zoom_rooms[i].device_ip")
        camera = jResp.StringOf("zoom_rooms[i].camera")
        microphone = jResp.StringOf("zoom_rooms[i].microphone")
        speaker = jResp.StringOf("zoom_rooms[i].speaker")
        last_start_time = jResp.StringOf("zoom_rooms[i].last_start_time")
        health = jResp.StringOf("zoom_rooms[i].health")
        j = 0
        count_j = jResp.SizeOfArray("zoom_rooms[i].issues").intValue
        while j < count_j {
            jResp.J = j
            strVal = jResp.StringOf("zoom_rooms[i].issues[j]")
            j = j + 1
        }

        i = i + 1
    }


}

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}"
    }
  ]
}