SQL Server / Zoom API / Add IM directory group members
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', 'POST'
EXEC sp_OASetProperty @req, 'Path', '/v2/im/groups/:groupId/members'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
DECLARE @jsonFormData1 int
-- Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jsonFormData1 OUT
EXEC sp_OAMethod @jsonFormData1, 'AddObjectAt', @success OUT, -1
DECLARE @jsonObj_1 int
EXEC sp_OAGetProperty @jsonFormData1, 'Size', @iTmp0 OUT
EXEC sp_OAMethod @jsonFormData1, 'ObjectAt', @jsonObj_1 OUT, @iTmp0 - 1
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'id', 'id do sunt'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'email', 'exercitation'
EXEC @hr = sp_OADestroy @jsonObj_1
EXEC sp_OAMethod @jsonFormData1, 'AddObjectAt', @success OUT, -1
EXEC sp_OAGetProperty @jsonFormData1, 'Size', @iTmp0 OUT
EXEC sp_OAMethod @jsonFormData1, 'ObjectAt', @jsonObj_1 OUT, @iTmp0 - 1
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'id', 'sed aliqua sunt'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'email', 'quis'
EXEC @hr = sp_OADestroy @jsonObj_1
EXEC sp_OAMethod @req, 'AddStringForUpload2', @success OUT, 'members', '', @jsonFormData1, 'utf-8', 'application/json'
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
EXEC @hr = sp_OADestroy @jsonFormData1
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @jsonFormData1
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'members=[{"id":"id do sunt","email":"exercitation"},{"id":"sed aliqua sunt","email":"quis"}]'
https://api.zoom.us/v2/im/groups/:groupId/members
Postman Collection Item JSON
{
"name": "Add IM directory group members",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"id do sunt\",\"email\":\"exercitation\"},{\"id\":\"sed aliqua sunt\",\"email\":\"quis\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
}
]
},
"description": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>\n**Scope:** `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**Error Code:** `200` <br>\nOnly available for paid account:{accountId}.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `201` <br>\nMember added.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ids\": \"string\",\n \"added_at\": \"string [date-time]\"\n}"
},
{
"name": "**Error Code:** `300` <br>\nMissing field: name.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` <br>\nIM Group not found",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
