Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.zoom.us/v2/im/groups",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sId
Local $sName
Local $sTotal_members
Local $sV_type
Local $search_by_domain
Local $search_by_account
Local $search_by_ma_account

Local $sPage_count = $oJResp.StringOf("page_count")
Local $sPage_number = $oJResp.StringOf("page_number")
Local $sPage_size = $oJResp.StringOf("page_size")
Local $sTotal_records = $oJResp.StringOf("total_records")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("groups")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("groups[i].id")
    $sName = $oJResp.StringOf("groups[i].name")
    $sTotal_members = $oJResp.StringOf("groups[i].total_members")
    $sV_type = $oJResp.StringOf("groups[i].type")
    $search_by_domain = $oJResp.StringOf("groups[i].search_by_domain")
    $search_by_account = $oJResp.StringOf("groups[i].search_by_account")
    $search_by_ma_account = $oJResp.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": ""
    }
  ]
}