unicodeC / Zoom API / List Zoom Rooms
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *room_name;
const wchar_t *calendar_name;
const wchar_t *email;
const wchar_t *account_type;
const wchar_t *status;
const wchar_t *device_ip;
const wchar_t *camera;
const wchar_t *microphone;
const wchar_t *speaker;
const wchar_t *last_start_time;
const wchar_t *health;
int j;
int count_j;
const wchar_t *strVal;
int page_count;
int page_number;
int page_size;
int total_records;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(queryParams,L"page_size",30);
CkJsonObjectW_UpdateInt(queryParams,L"page_number",1);
CkJsonObjectW_UpdateString(queryParams,L"next_page_token",L"quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/metrics/zoomrooms",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
page_count = CkJsonObjectW_IntOf(jResp,L"page_count");
page_number = CkJsonObjectW_IntOf(jResp,L"page_number");
page_size = CkJsonObjectW_IntOf(jResp,L"page_size");
total_records = CkJsonObjectW_IntOf(jResp,L"total_records");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"zoom_rooms");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].id");
room_name = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].room_name");
calendar_name = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].calendar_name");
email = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].email");
account_type = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].account_type");
status = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].status");
device_ip = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].device_ip");
camera = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].camera");
microphone = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].microphone");
speaker = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].speaker");
last_start_time = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].last_start_time");
health = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].health");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"zoom_rooms[i].issues");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"zoom_rooms[i].issues[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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}"
}
]
}
