TCL / Zoom API / List Zoom Room devices
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.zoom.us/v2/rooms/:roomId/devices" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "devices"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "devices[i].id"]
set room_name [CkJsonObject_stringOf $jResp "devices[i].room_name"]
set device_type [CkJsonObject_stringOf $jResp "devices[i].device_type"]
set app_version [CkJsonObject_stringOf $jResp "devices[i].app_version"]
set device_system [CkJsonObject_stringOf $jResp "devices[i].device_system"]
set status [CkJsonObject_stringOf $jResp "devices[i].status"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}