C++ / Zoom API / List Zoom Rooms
Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
CkJsonObject queryParams;
queryParams.UpdateString("status","InMeeting");
queryParams.UpdateString("type","SchedulingDisplayOnly");
queryParams.UpdateString("unassigned_rooms","false");
queryParams.UpdateInt("page_size",30);
queryParams.UpdateString("next_page_token","quis officia in reprehenderit");
queryParams.UpdateString("location_id","quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/rooms",queryParams);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *id = 0;
const char *name = 0;
const char *activation_code = 0;
const char *status = 0;
int page_size = jResp.IntOf("page_size");
int i = 0;
int count_i = jResp.SizeOfArray("rooms");
while (i < count_i) {
jResp.put_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}"
}
]
}
