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.UpdateString("status", value: "InMeeting")
    queryParams.UpdateString("type", value: "SchedulingDisplayOnly")
    queryParams.UpdateString("unassigned_rooms", value: "false")
    queryParams.UpdateInt("page_size", value: 30)
    queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")
    queryParams.UpdateString("location_id", 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/rooms", 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_size": 30,
    //   "rooms": [
    //     {
    //       "id": "387434ryewr334",
    //       "name": "testZoomRooms",
    //       "activation_code": "1200",
    //       "status": "Available"
    //     },
    //     {
    //       "id": "4ryewr33sjfkds",
    //       "name": "MyZoomRooms",
    //       "activation_code": "eu34355empor",
    //       "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 id: String?
    var name: String?
    var activation_code: String?
    var status: String?

    var page_size: Int = jResp.IntOf("page_size").intValue
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("rooms").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("rooms[i].id")
        name = jResp.StringOf("rooms[i].name")
        activation_code = jResp.StringOf("rooms[i].activation_code")
        status = jResp.StringOf("rooms[i].status")
        i = i + 1
    }


}

Curl Command

curl -G -d "status=InMeeting"
	-d "type=SchedulingDisplayOnly"
	-d "unassigned_rooms=false"
	-d "page_size=30"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-d "location_id=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms

Postman Collection Item JSON

{
  "name": "List Zoom Rooms",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/rooms?status=InMeeting&type=SchedulingDisplayOnly&unassigned_rooms=false&page_size=30&next_page_token=quis officia in reprehenderit&location_id=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "rooms"
      ],
      "query": [
        {
          "key": "status",
          "value": "InMeeting",
          "description": "The status of the Zoom Room."
        },
        {
          "key": "type",
          "value": "SchedulingDisplayOnly",
          "description": "Type of the Zoom Rooms."
        },
        {
          "key": "unassigned_rooms",
          "value": "false",
          "description": "Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet."
        },
        {
          "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."
        },
        {
          "key": "location_id",
          "value": "quis officia in reprehenderit",
          "description": "Parent location ID of the Zoom Room."
        }
      ]
    },
    "description": "Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account.<br><br>\n**Prerequisites:**<br>\n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.<br>\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`<br>\nA list of Zoom Rooms returned successfully.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms?status=InMeeting&type=SchedulingDisplayOnly&unassigned_rooms=false&page_size=30&next_page_token=quis officia in reprehenderit&location_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms"
          ],
          "query": [
            {
              "key": "status",
              "value": "InMeeting"
            },
            {
              "key": "type",
              "value": "SchedulingDisplayOnly"
            },
            {
              "key": "unassigned_rooms",
              "value": "false"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "location_id",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_size\": 30,\n \"rooms\": [\n  {\n   \"id\": \"387434ryewr334\",\n   \"name\": \"testZoomRooms\",\n   \"activation_code\": \"1200\",\n   \"status\": \"Available\"\n  },\n  {\n   \"id\": \"4ryewr33sjfkds\",\n   \"name\": \"MyZoomRooms\",\n   \"activation_code\": \"eu34355empor\",\n   \"status\": \"Offline\"\n  }\n ]\n}"
    }
  ]
}