Chilkat Online Tools

C++ / Zoom API / List groups

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.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;

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.zoom.us/v2/groups",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

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

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "total_records": 2,
    //   "groups": [
    //     {
    //       "id": "hFK_GtF_e_TaVA808",
    //       "name": "ipsum",
    //       "total_members": 10
    //     },
    //     {
    //       "id": "TaVA8QKik_1233",
    //       "name": "awesomegroup",
    //       "total_members": 0
    //     }
    //   ]
    // }

    // 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 *id = 0;
    const char *name = 0;
    int total_members;

    int total_records = jResp.IntOf("total_records");
    int i = 0;
    int count_i = jResp.SizeOfArray("groups");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("groups[i].id");
        name = jResp.stringOf("groups[i].name");
        total_members = jResp.IntOf("groups[i].total_members");
        i = i + 1;
    }
    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups

Postman Collection Item JSON

{
  "name": "List groups",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "groups"
      ]
    },
    "description": "List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nList of groups returned.<br>\n**Error Code:** `200`\nOnly available for paid accounts.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/groups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"total_records\": 2,\n \"groups\": [\n  {\n   \"id\": \"hFK_GtF_e_TaVA808\",\n   \"name\": \"ipsum\",\n   \"total_members\": 10\n  },\n  {\n   \"id\": \"TaVA8QKik_1233\",\n   \"name\": \"awesomegroup\",\n   \"total_members\": 0\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `4130`<br> A group with this {groupId} does not exist.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/groups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}