Chilkat Online Tools

Powershell / Zoom API / Get CRC port usage

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("from","1989-05-07")
$queryParams.UpdateString("to","1989-05-07")

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

$resp = $http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/crc",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "from": "2019-04-03",
#   "to": "2019-04-04",
#   "crc_ports_usage": [
#     {
#       "date_time": "2019-05-01T15:13:39.424Z",
#       "crc_ports_hour_usage": [
#         {
#           "hour": "sed",
#           "max_usage": 8,
#           "total_usage": 14
#         }
#       ]
#     }
#   ]
# }

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

$date_time = New-Object Chilkat.DtObj

$from = $jResp.StringOf("from")
$v_to = $jResp.StringOf("to")
$i = 0
$count_i = $jResp.SizeOfArray("crc_ports_usage")
while ($i -lt $count_i) {
    $jResp.I = $i
    $jResp.DtOf("crc_ports_usage[i].date_time",$false,$date_time)
    $j = 0
    $count_j = $jResp.SizeOfArray("crc_ports_usage[i].crc_ports_hour_usage")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $hour = $jResp.StringOf("crc_ports_usage[i].crc_ports_hour_usage[j].hour")
        $max_usage = $jResp.IntOf("crc_ports_usage[i].crc_ports_hour_usage[j].max_usage")
        $total_usage = $jResp.IntOf("crc_ports_usage[i].crc_ports_hour_usage[j].total_usage")
        $j = $j + 1
    }

    $i = $i + 1
}

Curl Command

curl -G -d "from=1989-05-07"
	-d "to=1989-05-07"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/crc

Postman Collection Item JSON

{
  "name": "Get CRC port usage",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/crc?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "crc"
      ],
      "query": [
        {
          "key": "from",
          "value": "1989-05-07",
          "description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
        },
        {
          "key": "to",
          "value": "1989-05-07",
          "description": "(Required) End date."
        }
      ]
    },
    "description": "A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. \n\nUse this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if \"from\" is set to \"2017-08-05\" and \"to\" is set to \"2017-10-10\", we will adjust \"from\" to \"2017-09-10\".</aside><br><br>\n**Prerequisites:**<br>\n* Business, Education or API Plan.\n* Room Connector must be enabled on the account.<br><br>\n**Scopes:** `dashboard_crc:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` "
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nCRC usage returned.<br>\nOnly available for paid accounts that have enabled the Dashboard feature.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/crc?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "crc"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"from\": \"2019-04-03\",\n \"to\": \"2019-04-04\",\n \"crc_ports_usage\": [\n  {\n   \"date_time\": \"2019-05-01T15:13:39.424Z\",\n   \"crc_ports_hour_usage\": [\n    {\n     \"hour\": \"sed\",\n     \"max_usage\": 8,\n     \"total_usage\": 14\n    }\n   ]\n  }\n ]\n}"
    }
  ]
}