delphiDll / Zoom API / Get CRC port usage
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
date_time: HCkDtObj;
j: Integer;
count_j: Integer;
hour: PWideChar;
max_usage: Integer;
total_usage: Integer;
from: PWideChar;
v_to: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'from','1989-05-07');
CkJsonObject_UpdateString(queryParams,'to','1989-05-07');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/metrics/crc',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkDtObj_Create();
from := CkJsonObject__stringOf(jResp,'from');
v_to := CkJsonObject__stringOf(jResp,'to');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'crc_ports_usage');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
CkJsonObject_DtOf(jResp,'crc_ports_usage[i].date_time',False,date_time);
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'crc_ports_usage[i].crc_ports_hour_usage');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
hour := CkJsonObject__stringOf(jResp,'crc_ports_usage[i].crc_ports_hour_usage[j].hour');
max_usage := CkJsonObject_IntOf(jResp,'crc_ports_usage[i].crc_ports_hour_usage[j].max_usage');
total_usage := CkJsonObject_IntOf(jResp,'crc_ports_usage[i].crc_ports_hour_usage[j].total_usage');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(date_time);
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}"
}
]
}
