delphiDll / Zoom API / List Zoom Rooms
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
room_name: PWideChar;
calendar_name: PWideChar;
email: PWideChar;
account_type: PWideChar;
status: PWideChar;
device_ip: PWideChar;
camera: PWideChar;
microphone: PWideChar;
speaker: PWideChar;
last_start_time: PWideChar;
health: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
page_count: Integer;
page_number: Integer;
page_size: Integer;
total_records: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,'page_size',30);
CkJsonObject_UpdateInt(queryParams,'page_number',1);
CkJsonObject_UpdateString(queryParams,'next_page_token','quis officia in reprehenderit');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/metrics/zoomrooms',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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
page_count := CkJsonObject_IntOf(jResp,'page_count');
page_number := CkJsonObject_IntOf(jResp,'page_number');
page_size := CkJsonObject_IntOf(jResp,'page_size');
total_records := CkJsonObject_IntOf(jResp,'total_records');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'zoom_rooms');
while i < count_i do
begin
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');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'zoom_rooms[i].issues[j]');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
