C++ / Zoom API / Invite channel members
Back to Collection Items
#include <CkHttp.h>
#include <CkHttpRequest.h>
#include <CkJsonArray.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
CkHttpRequest req;
req.put_HttpVerb("POST");
req.put_Path("/v2/chat/users/:userId/channels/:channelId/members");
req.put_ContentType("multipart/form-data");
CkJsonArray jsonFormData1;
jsonFormData1.AddObjectAt(-1);
CkJsonObject *jsonObj_1 = jsonFormData1.ObjectAt(jsonFormData1.get_Size() - 1);
jsonObj_1->UpdateString("email","fginRuwuEMN4t@ObyHyajXMKSsFbxKeKsZgV.ccb");
delete jsonObj_1;
jsonFormData1.AddObjectAt(-1);
jsonObj_1 = jsonFormData1.ObjectAt(jsonFormData1.get_Size() - 1);
jsonObj_1->UpdateString("email","6NUC-wUiAlD@IBTqKhhgULAWLvsbhASWcpI.hbk");
delete jsonObj_1;
req.AddStringForUpload2("members","",jsonFormData1,"utf-8","application/json");
req.AddHeader("Authorization","Bearer <access_token>");
CkHttpResponse *resp = http.SynchronousRequest("api.zoom.us",443,true,req);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *strVal = 0;
const char *added_at = jResp.stringOf("added_at");
int i = 0;
int count_i = jResp.SizeOfArray("ids");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("ids[i]");
i = i + 1;
}
}
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": ""
}
]
}
