Chilkat Online Tools

DataFlex / Zoom API / List IM directory groups

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sName
    String sTotal_members
    String sV_type
    String sSearch_by_domain
    String sSearch_by_account
    String sSearch_by_ma_account
    String sPage_count
    String sPage_number
    String sPage_size
    String sTotal_records
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.zoom.us/v2/im/groups" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    Get ComStringOf Of hoJResp "page_count" To sPage_count
    Get ComStringOf Of hoJResp "page_number" To sPage_number
    Get ComStringOf Of hoJResp "page_size" To sPage_size
    Get ComStringOf Of hoJResp "total_records" To sTotal_records
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "groups" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "groups[i].id" To sId
        Get ComStringOf Of hoJResp "groups[i].name" To sName
        Get ComStringOf Of hoJResp "groups[i].total_members" To sTotal_members
        Get ComStringOf Of hoJResp "groups[i].type" To sV_type
        Get ComStringOf Of hoJResp "groups[i].search_by_domain" To sSearch_by_domain
        Get ComStringOf Of hoJResp "groups[i].search_by_account" To sSearch_by_account
        Get ComStringOf Of hoJResp "groups[i].search_by_ma_account" To sSearch_by_ma_account
        Move (i + 1) To i
    Loop



End_Procedure

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