Chilkat Online Tools

Android / Zoom API / List channel members

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateInt("page_size",30);
    queryParams.UpdateString("next_page_token","quis officia in reprehenderit");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkHttpResponse resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/chat/users/:userId/channels/:channelId/members",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

    // 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

    String id;
    String email;
    String first_name;
    String last_name;
    String name;
    String role;

    int total_records = jResp.IntOf("total_records");
    int page_size = jResp.IntOf("page_size");
    String next_page_token = jResp.stringOf("next_page_token");
    int i = 0;
    int count_i = jResp.SizeOfArray("members");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("members[i].id");
        email = jResp.stringOf("members[i].email");
        first_name = jResp.stringOf("members[i].first_name");
        last_name = jResp.stringOf("members[i].last_name");
        name = jResp.stringOf("members[i].name");
        role = jResp.stringOf("members[i].role");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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": ""
    }
  ]
}