unicodeC / Zoom API / List channel members
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *email;
const wchar_t *first_name;
const wchar_t *last_name;
const wchar_t *name;
const wchar_t *role;
int total_records;
int page_size;
const wchar_t *next_page_token;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(queryParams,L"page_size",30);
CkJsonObjectW_UpdateString(queryParams,L"next_page_token",L"quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/chat/users/:userId/channels/:channelId/members",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "total_records": 2,
// "page_size": 30,
// "next_page_token": "",
// "members": [
// {
// "id": "laboris3764763ull",
// "email": "example@example.com",
// "first_name": "Harry",
// "last_name": "King",
// "name": "King_H",
// "role": "admin"
// },
// {
// "id": "eul21dfabore",
// "email": "example@example.com",
// "first_name": "Alisha",
// "last_name": "Sapkota",
// "name": "Alisha_S",
// "role": "member"
// }
// ]
// }
// 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.
total_records = CkJsonObjectW_IntOf(jResp,L"total_records");
page_size = CkJsonObjectW_IntOf(jResp,L"page_size");
next_page_token = CkJsonObjectW_stringOf(jResp,L"next_page_token");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"members");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"members[i].id");
email = CkJsonObjectW_stringOf(jResp,L"members[i].email");
first_name = CkJsonObjectW_stringOf(jResp,L"members[i].first_name");
last_name = CkJsonObjectW_stringOf(jResp,L"members[i].last_name");
name = CkJsonObjectW_stringOf(jResp,L"members[i].name");
role = CkJsonObjectW_stringOf(jResp,L"members[i].role");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/chat/users/:userId/channels/:channelId/members
Postman Collection Item JSON
{
"name": "List channel members",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"query": [
{
"key": "page_size",
"value": "30",
"description": "The number of records returned with 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."
}
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel Id."
},
{
"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 list all members of 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:read: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>View</b> or <b>Edit</b> permission for <b>Chat Channels</b>.</p>"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nList of channel members returned.\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel Id."
},
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the user who is the owner of this channel."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"total_records\": 2,\n \"page_size\": 30,\n \"next_page_token\": \"\",\n \"members\": [\n {\n \"id\": \"laboris3764763ull\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"King\",\n \"name\": \"King_H\",\n \"role\": \"admin\"\n },\n {\n \"id\": \"eul21dfabore\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Alisha\",\n \"last_name\": \"Sapkota\",\n \"name\": \"Alisha_S\",\n \"role\": \"member\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br> Bad Request<br>\n**Error Code:** `200`<br>\nUnauthorized request. You do not have permission to view channel members on this user's behalf..<br>\n**Error Code:** `300`<br>\nThe next page token is either invalid or has expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/channels/:channelId/members?page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"channels",
":channelId",
"members"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "channelId",
"value": "quis officia in reprehenderit",
"description": "(Required) Channel Id."
},
{
"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": ""
}
]
}
