Delphi (DLL) / Zoom API / List Zoom Rooms
Back to Collection Items
var
begin
CkJsonObject_UpdateInt(queryParams,'page_size',30);CkJsonObject_UpdateInt(queryParams,'page_number',1);CkJsonObject_UpdateString(queryParams,'next_page_token','quis officia in reprehenderit');CkHttp_putAuthToken(http,'<access_token>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);id := CkJsonObject__stringOf(jResp,'zoom_rooms[i].id');room_name := CkJsonObject__stringOf(jResp,'zoom_rooms[i].room_name');calendar_name := CkJsonObject__stringOf(jResp,'zoom_rooms[i].calendar_name');email := CkJsonObject__stringOf(jResp,'zoom_rooms[i].email');account_type := CkJsonObject__stringOf(jResp,'zoom_rooms[i].account_type');status := CkJsonObject__stringOf(jResp,'zoom_rooms[i].status');device_ip := CkJsonObject__stringOf(jResp,'zoom_rooms[i].device_ip');camera := CkJsonObject__stringOf(jResp,'zoom_rooms[i].camera');microphone := CkJsonObject__stringOf(jResp,'zoom_rooms[i].microphone');speaker := CkJsonObject__stringOf(jResp,'zoom_rooms[i].speaker');last_start_time := CkJsonObject__stringOf(jResp,'zoom_rooms[i].last_start_time');health := CkJsonObject__stringOf(jResp,'zoom_rooms[i].health');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'zoom_rooms[i].issues');CkJsonObject_putJ(jResp,j);strVal := CkJsonObject__stringOf(jResp,'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}"
}
]
}