Chilkat Online Tools

Xojo / Zoom API / List IM directory groups

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.zoom.us/v2/im/groups",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

// {
//   "page_count": "1",
//   "page_number": "1",
//   "page_size": "1",
//   "total_records": "1",
//   "groups": [
//     {
//       "id": "sjvfkjfew34535",
//       "name": "MyAdminDirectoryGroup",
//       "total_members": "10",
//       "type": "shared",
//       "search_by_domain": "true",
//       "search_by_account": "false",
//       "search_by_ma_account": "false"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim id As String
Dim name As String
Dim total_members As String
Dim v_type As String
Dim search_by_domain As String
Dim search_by_account As String
Dim search_by_ma_account As String

Dim page_count As String
page_count = jResp.StringOf("page_count")
Dim page_number As String
page_number = jResp.StringOf("page_number")
Dim page_size As String
page_size = jResp.StringOf("page_size")
Dim total_records As String
total_records = jResp.StringOf("total_records")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("groups")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("groups[i].id")
    name = jResp.StringOf("groups[i].name")
    total_members = jResp.StringOf("groups[i].total_members")
    v_type = jResp.StringOf("groups[i].type")
    search_by_domain = jResp.StringOf("groups[i].search_by_domain")
    search_by_account = jResp.StringOf("groups[i].search_by_account")
    search_by_ma_account = jResp.StringOf("groups[i].search_by_ma_account")
    i = i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List IM directory groups",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/im/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "im",
        "groups"
      ]
    },
    "description": "List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>\n**Scopes**: `imgroup: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.\n**Error Code:** `200` <br>\nList of IM groups returned.<br>\nOnly available for paid account:{accountId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/im/groups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": \"1\",\n \"page_number\": \"1\",\n \"page_size\": \"1\",\n \"total_records\": \"1\",\n \"groups\": [\n  {\n   \"id\": \"sjvfkjfew34535\",\n   \"name\": \"MyAdminDirectoryGroup\",\n   \"total_members\": \"10\",\n   \"type\": \"shared\",\n   \"search_by_domain\": \"true\",\n   \"search_by_account\": \"false\",\n   \"search_by_ma_account\": \"false\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/im/groups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}