Node.js / Zoom API / List Zoom Room devices
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://api.zoom.us/v2/rooms/:roomId/devices",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "devices": [
// {
// "id": "sajhdfshf24324",
// "room_name": "MyAwesomeZoomRoom",
// "device_type": "Zoom Rooms Computer",
// "app_version": "4.4.1 (1242.0623)",
// "device_system": "Win 10",
// "status": "Online"
// },
// {
// "id": "32dhgdfg2were",
// "room_name": "MyAwesomeZoomRoom",
// "device_type": "Zoom Rooms Controller",
// "app_version": "4.3.6 (265.0307)",
// "device_system": "iPad 12.3.1",
// "status": "Online"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id;
var room_name;
var device_type;
var app_version;
var device_system;
var status;
var i = 0;
var count_i = jResp.SizeOfArray("devices");
while (i < count_i) {
jResp.I = i;
id = jResp.StringOf("devices[i].id");
room_name = jResp.StringOf("devices[i].room_name");
device_type = jResp.StringOf("devices[i].device_type");
app_version = jResp.StringOf("devices[i].app_version");
device_system = jResp.StringOf("devices[i].device_system");
status = jResp.StringOf("devices[i].status");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/:roomId/devices
Postman Collection Item JSON
{
"name": "List Zoom Room devices",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/devices",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"devices"
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
}
]
},
"description": "List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account.\n\n**Prerequisites:**<br>\n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.<br>\n* Account owner or admin permissions.\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` **OK**\nDevices listed successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/devices",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"devices"
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"devices\": [\n {\n \"id\": \"sajhdfshf24324\",\n \"room_name\": \"MyAwesomeZoomRoom\",\n \"device_type\": \"Zoom Rooms Computer\",\n \"app_version\": \"4.4.1 (1242.0623)\",\n \"device_system\": \"Win 10\",\n \"status\": \"Online\"\n },\n {\n \"id\": \"32dhgdfg2were\",\n \"room_name\": \"MyAwesomeZoomRoom\",\n \"device_type\": \"Zoom Rooms Controller\",\n \"app_version\": \"4.3.6 (265.0307)\",\n \"device_system\": \"iPad 12.3.1\",\n \"status\": \"Online\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/devices",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"devices"
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
