C / Zoom API / Get Zoom Rooms details
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *strVal;
const char *account_type;
const char *calendar_name;
const char *camera;
const char *device_ip;
const char *email;
const char *health;
const char *id;
const char *last_start_time;
const char *microphone;
const char *From;
const char *Next_page_token;
int Page_count;
int Page_size;
const char *v_To;
int Total_records;
const char *room_name;
const char *speaker;
const char *status;
int i;
int count_i;
// 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_UpdateString(queryParams,"from","1989-05-07");
CkJsonObject_UpdateString(queryParams,"to","1989-05-07");
CkJsonObject_UpdateInt(queryParams,"page_size",30);
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/:zoomroomId",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
account_type = CkJsonObject_stringOf(jResp,"account_type");
calendar_name = CkJsonObject_stringOf(jResp,"calendar_name");
camera = CkJsonObject_stringOf(jResp,"camera");
device_ip = CkJsonObject_stringOf(jResp,"device_ip");
email = CkJsonObject_stringOf(jResp,"email");
health = CkJsonObject_stringOf(jResp,"health");
id = CkJsonObject_stringOf(jResp,"id");
last_start_time = CkJsonObject_stringOf(jResp,"last_start_time");
microphone = CkJsonObject_stringOf(jResp,"microphone");
From = CkJsonObject_stringOf(jResp,"past_meetings.from");
Next_page_token = CkJsonObject_stringOf(jResp,"past_meetings.next_page_token");
Page_count = CkJsonObject_IntOf(jResp,"past_meetings.page_count");
Page_size = CkJsonObject_IntOf(jResp,"past_meetings.page_size");
v_To = CkJsonObject_stringOf(jResp,"past_meetings.to");
Total_records = CkJsonObject_IntOf(jResp,"past_meetings.total_records");
room_name = CkJsonObject_stringOf(jResp,"room_name");
speaker = CkJsonObject_stringOf(jResp,"speaker");
status = CkJsonObject_stringOf(jResp,"status");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"issues");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"issues[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"past_meetings.meetings");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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": ""
}
]
}
