SQL Server / Zoom API / Check-in or check-out of a Zoom Room
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 @req int
-- Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'PATCH'
EXEC sp_OASetProperty @req, 'Path', '/v2/rooms/:id/events'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'method', 'quis consectetur veniam laboris'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'params', 'quis consectetur veniam laboris{"event_id":"dolore sit laborum Duis","change_key":"ea adipisicing velit","calendar_id":"ullamco labore dolore mollit","resource_email":"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc"}'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
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 @req
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 @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'method=quis consectetur veniam laboris'
--form 'params=quis consectetur veniam laboris{"event_id":"dolore sit laborum Duis","change_key":"ea adipisicing velit","calendar_id":"ullamco labore dolore mollit","resource_email":"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc"}'
https://api.zoom.us/v2/rooms/:id/events
Postman Collection Item JSON
{
"name": "Check-in or check-out of a Zoom Room",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "quis consectetur veniam laboris",
"description": "The value of this field can be one of the following:<br>\n* zoomroom.check_in\n* zoomroom.check_out",
"type": "text"
},
{
"key": "params",
"value": "{\"event_id\":\"dolore sit laborum Duis\",\"change_key\":\"ea adipisicing velit\",\"calendar_id\":\"ullamco labore dolore mollit\",\"resource_email\":\"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:id/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":id",
"events"
],
"variable": [
{
"key": "id",
"value": "quis officia in reprehenderit",
"description": "(Required) Room ID"
}
]
},
"description": "The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either **check in** and confirm that you are utilizing the room reservation or to **check out** of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the [Using the Zoom Rooms check-in feature](https://support.zoom.us/hc/en-us/articles/360001147163-Using-the-Zoom-Rooms-check-in-feature) guide. \n\n**Prerequisites:**\n* [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-started-with-Zoom-Rooms#:~:text=Zoom%20Rooms%20is%20a%20software,or%20from%20their%20mobile%20device) must have been set up for use for the account and must be online. \n* You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.\n\n**Scope:** `room:write:admin`"
},
"response": [
{
"name": "**HTTP Status Code:** `202` **Accepted**<br>\nRequest processed successfully.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "quis consectetur veniam laboris",
"description": "The value of this field can be one of the following:<br>\n* zoomroom.check_in\n* zoomroom.check_out",
"type": "text"
},
{
"key": "params",
"value": "{\"event_id\":\"dolore sit laborum Duis\",\"change_key\":\"ea adipisicing velit\",\"calendar_id\":\"ullamco labore dolore mollit\",\"resource_email\":\"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:id/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":id",
"events"
],
"variable": [
{
"key": "id",
"value": "quis officia in reprehenderit",
"description": "(Required) Room ID"
}
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300`<br>\n* Zoom Room is offline. Please ensure that the Zoom Room is online before checking in or checking out.\n* Invalid parameters.\n\n\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "quis consectetur veniam laboris",
"description": "The value of this field can be one of the following:<br>\n* zoomroom.check_in\n* zoomroom.check_out",
"type": "text"
},
{
"key": "params",
"value": "{\"event_id\":\"dolore sit laborum Duis\",\"change_key\":\"ea adipisicing velit\",\"calendar_id\":\"ullamco labore dolore mollit\",\"resource_email\":\"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:id/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":id",
"events"
],
"variable": [
{
"key": "id",
"value": "quis officia in reprehenderit",
"description": "(Required) Room ID"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `1012` <br>\nRoom does not exist: {roomId}.\n\n\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "method",
"value": "quis consectetur veniam laboris",
"description": "The value of this field can be one of the following:<br>\n* zoomroom.check_in\n* zoomroom.check_out",
"type": "text"
},
{
"key": "params",
"value": "{\"event_id\":\"dolore sit laborum Duis\",\"change_key\":\"ea adipisicing velit\",\"calendar_id\":\"ullamco labore dolore mollit\",\"resource_email\":\"U45sjN@qkwQqRsglYQapYeGbizqBNN.mgc\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:id/events",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":id",
"events"
],
"variable": [
{
"key": "id",
"value": "quis officia in reprehenderit",
"description": "(Required) Room ID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
