autoit / Zoom API / Invite channel members
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oReq = ObjCreate("Chilkat.HttpRequest")
$oReq.HttpVerb = "POST"
$oReq.Path = "/v2/chat/users/:userId/channels/:channelId/members"
$oReq.ContentType = "multipart/form-data"
$oJsonFormData1 = ObjCreate("Chilkat.JsonArray")
$oJsonFormData1.AddObjectAt(-1)
Local $oJsonObj_1 = $oJsonFormData1.ObjectAt($oJsonFormData1.Size - 1)
$oJsonObj_1.UpdateString("email","fginRuwuEMN4t@ObyHyajXMKSsFbxKeKsZgV.ccb")
$oJsonFormData1.AddObjectAt(-1)
$oJsonObj_1 = $oJsonFormData1.ObjectAt($oJsonFormData1.Size - 1)
$oJsonObj_1.UpdateString("email","6NUC-wUiAlD@IBTqKhhgULAWLvsbhASWcpI.hbk")
$oReq.AddStringForUpload2("members","",$oJsonFormData1,"utf-8","application/json")
$oReq.AddHeader "Authorization","Bearer <access_token>"
Local $oResp = $oHttp.SynchronousRequest("api.zoom.us",443,True,$oReq)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "ids": [
; "abc4545fdgfdhg",
; "lgfdkhg123456"
; ],
; "added_at": "2019-09-27T00:14:46Z"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $strVal
Local $sAdded_at = $oJResp.StringOf("added_at")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("ids")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("ids[i]")
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'members=[{"email":"fginRuwuEMN4t@ObyHyajXMKSsFbxKeKsZgV.ccb"},{"email":"6NUC-wUiAlD@IBTqKhhgULAWLvsbhASWcpI.hbk"}]'
https://api.zoom.us/v2/chat/users/:userId/channels/:channelId/members
Postman Collection Item JSON
{
"name": "Invite channel members",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"email\":\"fginRuwuEMN4t@ObyHyajXMKSsFbxKeKsZgV.ccb\"},{\"email\":\"6NUC-wUiAlD@IBTqKhhgULAWLvsbhASWcpI.hbk\"}]",
"description": "Members of a channel. You can invite up to a max number of 5 members with a single API call.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel ID: Unique Identifier of the channel."
},
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the user who is the owner of this channel."
}
]
},
"description": "Use this API to invite members that are in a user's contact list to a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Scopes:** `chat_channel:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note:</b> For an <b>account-level</b> <a href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"> role</a> that has the <b>Edit</b> permission for <b>Chat Channels</b>.</p>"
},
"response": [
{
"name": "**HTTP Status Code:** `201`<br>\nMembers invited to the channel.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"email\":\"0vVtrEMU8hpNS-Z@BIoFNiX.gmf\"},{\"email\":\"7o5@OFnVHVwpgTfzOGfmBNHJryf.fbz\"}]",
"description": "Members of a channel. You can invite up to a max number of 5 members with a single API call.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel ID: Unique Identifier of the channel."
},
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the user who is the owner of this channel."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ids\": [\n \"abc4545fdgfdhg\",\n \"lgfdkhg123456\"\n ],\n \"added_at\": \"2019-09-27T00:14:46Z\"\n}"
},
{
"name": "**Status Code:** `400`<br>\nBad request.<br>\n**Error Code:** `5301`<br>\nRequest to invite channel members failed.<br>\n**Error Code:** `200`<br>\nUnauthorized request. You do not have permission to invite channel members on this user's behalf.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"email\":\"0vVtrEMU8hpNS-Z@BIoFNiX.gmf\"},{\"email\":\"7o5@OFnVHVwpgTfzOGfmBNHJryf.fbz\"}]",
"description": "Members of a channel. You can invite up to a max number of 5 members with a single API call.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel ID: Unique Identifier of the channel."
},
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the user who is the owner of this channel."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
