SQL Server / Zoom API / List Zoom Rooms
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'status', 'InMeeting'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'type', 'SchedulingDisplayOnly'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'unassigned_rooms', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page_size', 30
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'next_page_token', 'quis officia in reprehenderit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'location_id', 'quis officia in reprehenderit'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/rooms', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @activation_code nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @page_size int
EXEC sp_OAMethod @jResp, 'IntOf', @page_size OUT, 'page_size'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'rooms'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'rooms[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'rooms[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @activation_code OUT, 'rooms[i].activation_code'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'rooms[i].status'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
