Chilkat Online Tools

Swift / Zoom API / Get Zoom Rooms details

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.UpdateString("from", value: "1989-05-07")
    queryParams.UpdateString("to", value: "1989-05-07")
    queryParams.UpdateInt("page_size", value: 30)
    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/:zoomroomId", 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)

    // {
    //   "account_type": "Work Email",
    //   "calendar_name": "testZoomRoom",
    //   "camera": "Integrated Webcam",
    //   "device_ip": "Computer : 192.0.2.0; Controller : 192.0.2.1",
    //   "email": "example@example.com",
    //   "health": "critical",
    //   "id": "fdjdsfdYYYYY",
    //   "issues": [
    //     "Zoom room is offline"
    //   ],
    //   "last_start_time": "2020-01-30T17:47:47Z",
    //   "live_meeting": {},
    //   "microphone": "Microphone Array (Realtek Audio)",
    //   "past_meetings": {
    //     "from": "2020-03-01",
    //     "meetings": [
    //     ],
    //     "next_page_token": "",
    //     "page_count": 0,
    //     "page_size": 30,
    //     "to": "2020-03-02",
    //     "total_records": 0
    //   },
    //   "room_name": "testZoomRoom",
    //   "speaker": "Speakers / Headphones (Realtek Audio)",
    //   "status": "Offline"
    // }

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

    var strVal: String?

    var account_type: String? = jResp.StringOf("account_type")
    var calendar_name: String? = jResp.StringOf("calendar_name")
    var camera: String? = jResp.StringOf("camera")
    var device_ip: String? = jResp.StringOf("device_ip")
    var email: String? = jResp.StringOf("email")
    var health: String? = jResp.StringOf("health")
    var id: String? = jResp.StringOf("id")
    var last_start_time: String? = jResp.StringOf("last_start_time")
    var microphone: String? = jResp.StringOf("microphone")
    var From: String? = jResp.StringOf("past_meetings.from")
    var Next_page_token: String? = jResp.StringOf("past_meetings.next_page_token")
    var Page_count: Int = jResp.IntOf("past_meetings.page_count").intValue
    var Page_size: Int = jResp.IntOf("past_meetings.page_size").intValue
    var v_To: String? = jResp.StringOf("past_meetings.to")
    var Total_records: Int = jResp.IntOf("past_meetings.total_records").intValue
    var room_name: String? = jResp.StringOf("room_name")
    var speaker: String? = jResp.StringOf("speaker")
    var status: String? = jResp.StringOf("status")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("issues").intValue
    while i < count_i {
        jResp.I = i
        strVal = jResp.StringOf("issues[i]")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("past_meetings.meetings").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

Curl Command

curl -G -d "from=1989-05-07"
	-d "to=1989-05-07"
	-d "page_size=30"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/zoomrooms/:zoomroomId

Postman Collection Item JSON

{
  "name": "Get Zoom Rooms details",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/zoomrooms/:zoomroomId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "zoomrooms",
        ":zoomroomId"
      ],
      "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."
        },
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        },
        {
          "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."
        }
      ],
      "variable": [
        {
          "key": "zoomroomId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The Zoom room ID."
        }
      ]
    },
    "description": "The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. \n\nUse this API to retrieve information on a specific room.<br><br>\n**Scopes:** `dashboard_zr:read:admin`<br> <br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`**Prerequisites:**<br>\n* Business, Education or API Plan with Zoom Rooms set up.\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nZoom room 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/:zoomroomId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "zoomrooms",
            ":zoomroomId"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "zoomroomId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The Zoom room ID."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"account_type\": \"Work Email\",\n \"calendar_name\": \"testZoomRoom\",\n \"camera\": \"Integrated Webcam\",\n \"device_ip\": \"Computer : 192.0.2.0; Controller : 192.0.2.1\",\n \"email\": \"example@example.com\",\n \"health\": \"critical\",\n \"id\": \"fdjdsfdYYYYY\",\n \"issues\": [\n  \"Zoom room is offline\"\n ],\n \"last_start_time\": \"2020-01-30T17:47:47Z\",\n \"live_meeting\": {},\n \"microphone\": \"Microphone Array (Realtek Audio)\",\n \"past_meetings\": {\n  \"from\": \"2020-03-01\",\n  \"meetings\": [],\n  \"next_page_token\": \"\",\n  \"page_count\": 0,\n  \"page_size\": 30,\n  \"to\": \"2020-03-02\",\n  \"total_records\": 0\n },\n \"room_name\": \"testZoomRoom\",\n \"speaker\": \"Speakers / Headphones (Realtek Audio)\",\n \"status\": \"Offline\"\n}"
    },
    {
      "name": "**Error Code:** `300`<br>\nThe next page token is either invalid or has expired.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/zoomrooms/:zoomroomId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "zoomrooms",
            ":zoomroomId"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "zoomroomId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The Zoom room ID."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}