Chilkat Online Tools

Swift3 / Zoom API / Get top 25 Zoom Rooms with issues

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.update("from", value: "1989-05-07")
    queryParams.update("to", value: "1989-05-07")

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

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.zoom.us/v2/metrics/issues/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)

    // {
    //   "from": "2019-05-22",
    //   "to": "1958-10-24",
    //   "total_records": -12352697,
    //   "zoom_rooms": [
    //     {
    //       "id": "culpa Ut",
    //       "room_name": "nisi dolor amet eiusmod",
    //       "issues_count": -15865999
    //     },
    //     {
    //       "id": "ipsum exercitation minim dolor",
    //       "room_name": "veniam pariatur laboris qui",
    //       "issues_count": 11887943
    //     }
    //   ]
    // }

    // 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 issues_count: Int

    var from: String? = jResp.string(of: "from")
    var v_to: String? = jResp.string(of: "to")
    var total_records: Int = jResp.int(of: "total_records").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "zoom_rooms").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "zoom_rooms[i].id")
        room_name = jResp.string(of: "zoom_rooms[i].room_name")
        issues_count = jResp.int(of: "zoom_rooms[i].issues_count").intValue
        i = i + 1
    }


}

Curl Command

curl -G -d "from=1989-05-07"
	-d "to=1989-05-07"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/issues/zoomrooms

Postman Collection Item JSON

{
  "name": "Get top 25 Zoom Rooms with issues",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "issues",
        "zoomrooms"
      ],
      "query": [
        {
          "key": "from",
          "value": "1989-05-07",
          "description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
        },
        {
          "key": "to",
          "value": "1989-05-07",
          "description": "(Required) End date."
        }
      ]
    },
    "description": "Get information on top 25 Zoom Rooms with issues in a month. The month specified with the \"from\" and \"to\" range should fall within the last six months.<br>\n**Scope:** `dashboard_home:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Business or a higher plan.\n* Zoom Room must be enabled in the account."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nZoom Room with issue details returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "issues",
            "zoomrooms"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"from\": \"2019-05-22\",\n \"to\": \"1958-10-24\",\n \"total_records\": -12352697,\n \"zoom_rooms\": [\n  {\n   \"id\": \"culpa Ut\",\n   \"room_name\": \"nisi dolor amet eiusmod\",\n   \"issues_count\": -15865999\n  },\n  {\n   \"id\": \"ipsum exercitation minim dolor\",\n   \"room_name\": \"veniam pariatur laboris qui\",\n   \"issues_count\": 11887943\n  }\n ]\n}"
    }
  ]
}