phpExt / Zoom API / List account's archived files
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateInt('page_size',30);
$queryParams->UpdateString('next_page_token','quis officia in reprehenderit');
$queryParams->UpdateString('from','quis officia in reprehenderit');
$queryParams->UpdateString('to','quis officia in reprehenderit');
$queryParams->UpdateString('query_date_type','meeting_start_time');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.zoom.us/v2/accounts/:accountId/archive_files',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "from": "2021-03-11T05:41:36Z",
// "to": "2021-03-18T05:41:36Z",
// "page_size": 30,
// "next_page_token": "",
// "meetings": [
// {
// "uuid": "yO3dfhh3t467UkQ==",
// "id": 553068284,
// "host_id": "Dhjdfgdkg8w",
// "topic": "Zoom Meeting",
// "type": 1,
// "start_time": "2021-03-12T01:57:27Z",
// "timezone": "",
// "duration": 3,
// "total_size": 364463,
// "recording_count": 2,
// "meeting_type": "internal",
// "account_name": "account_01",
// "complete_time": "2021-03-12T02:57:27Z",
// "is_breakout_room": false,
// "archive_files": [
// {
// "id": "55hfgsd-sd8e2bd7255",
// "file_type": "M4A",
// "file_extension": "M4A",
// "file_size": 165743,
// "download_url": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
// "status": "completed",
// "recording_type": "audio_only",
// "individual": true,
// "participant_email": "user@example.com",
// "participant_join_time": "2021-03-12T02:07:27Z",
// "participant_leave_time": "2021-03-12T02:12:27Z"
// },
// {
// "id": "9c5daa5b-34a1-40e8-8947-a11be5e373a7",
// "file_type": "MP4",
// "file_extension": "MP4",
// "file_size": 198720,
// "download_url": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC",
// "status": "completed",
// "recording_type": "shared_screen_with_speaker_view",
// "individual": true,
// "participant_email": "user1@example.com",
// "participant_join_time": "2021-03-12T02:07:27Z",
// "participant_leave_time": "2021-03-12T02:12:27Z"
// }
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$from = $jResp->stringOf('from');
$v_to = $jResp->stringOf('to');
$page_size = $jResp->IntOf('page_size');
$next_page_token = $jResp->stringOf('next_page_token');
$i = 0;
$count_i = $jResp->SizeOfArray('meetings');
while ($i < $count_i) {
$jResp->put_I($i);
$uuid = $jResp->stringOf('meetings[i].uuid');
$id = $jResp->IntOf('meetings[i].id');
$host_id = $jResp->stringOf('meetings[i].host_id');
$topic = $jResp->stringOf('meetings[i].topic');
$v_type = $jResp->IntOf('meetings[i].type');
$start_time = $jResp->stringOf('meetings[i].start_time');
$timezone = $jResp->stringOf('meetings[i].timezone');
$duration = $jResp->IntOf('meetings[i].duration');
$total_size = $jResp->IntOf('meetings[i].total_size');
$recording_count = $jResp->IntOf('meetings[i].recording_count');
$meeting_type = $jResp->stringOf('meetings[i].meeting_type');
$account_name = $jResp->stringOf('meetings[i].account_name');
$complete_time = $jResp->stringOf('meetings[i].complete_time');
$is_breakout_room = $jResp->BoolOf('meetings[i].is_breakout_room');
$j = 0;
$count_j = $jResp->SizeOfArray('meetings[i].archive_files');
while ($j < $count_j) {
$jResp->put_J($j);
$id_str = $jResp->stringOf('meetings[i].archive_files[j].id');
$file_type = $jResp->stringOf('meetings[i].archive_files[j].file_type');
$file_extension = $jResp->stringOf('meetings[i].archive_files[j].file_extension');
$file_size = $jResp->IntOf('meetings[i].archive_files[j].file_size');
$download_url = $jResp->stringOf('meetings[i].archive_files[j].download_url');
$status = $jResp->stringOf('meetings[i].archive_files[j].status');
$recording_type = $jResp->stringOf('meetings[i].archive_files[j].recording_type');
$individual = $jResp->BoolOf('meetings[i].archive_files[j].individual');
$participant_email = $jResp->stringOf('meetings[i].archive_files[j].participant_email');
$participant_join_time = $jResp->stringOf('meetings[i].archive_files[j].participant_join_time');
$participant_leave_time = $jResp->stringOf('meetings[i].archive_files[j].participant_leave_time');
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -G -d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "from=quis%20officia%20in%20reprehenderit"
-d "to=quis%20officia%20in%20reprehenderit"
-d "query_date_type=meeting_start_time"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/archive_files
Postman Collection Item JSON
{
"name": "List account's archived files",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/archive_files?page_size=30&next_page_token=quis officia in reprehenderit&from=quis officia in reprehenderit&to=quis officia in reprehenderit&query_date_type=meeting_start_time",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"archive_files"
],
"query": [
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"key": "from",
"value": "quis officia in reprehenderit",
"description": "Start date for the query in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format. The duration for the query defined using the \"from\" and \"to\" parameters should not exceed 7 days as this API only provides a week's data at once."
},
{
"key": "to",
"value": "quis officia in reprehenderit",
"description": "End date for the query in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format. "
},
{
"key": "query_date_type",
"value": "meeting_start_time",
"description": "The query date type for the `from` and `to` parameters."
}
],
"variable": [
{
"key": "accountId"
}
]
},
"description": "Use this API to retrieve archived meeting or webinar files of an account. \n\n Zoom’s [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) allows account administrators to set up an automated mechanism to record, collect, and archive meeting data to a 3rd-party platform of their choice to satisfy FINRA and/or other compliance requirements. \n\n**Scopes:** `recording:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n**Prerequisites:** \n* Follow the [enablement process](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data#h_01ENPBD3WR68D7FAKTBY92SG45) to access the archiving feature."
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**\nArchived files returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/archive_files?page_size=30&next_page_token=quis officia in reprehenderit&from=quis officia in reprehenderit&to=quis officia in reprehenderit&query_date_type=meeting_start_time",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"archive_files"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "from",
"value": "quis officia in reprehenderit"
},
{
"key": "to",
"value": "quis officia in reprehenderit"
},
{
"key": "query_date_type",
"value": "meeting_start_time"
}
],
"variable": [
{
"key": "accountId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2021-03-11T05:41:36Z\",\n \"to\": \"2021-03-18T05:41:36Z\",\n \"page_size\": 30,\n \"next_page_token\": \"\",\n \"meetings\": [\n {\n \"uuid\": \"yO3dfhh3t467UkQ==\",\n \"id\": 553068284,\n \"host_id\": \"Dhjdfgdkg8w\",\n \"topic\": \"Zoom Meeting\",\n \"type\": 1,\n \"start_time\": \"2021-03-12T01:57:27Z\",\n \"timezone\": \"\",\n \"duration\": 3,\n \"total_size\": 364463,\n \"recording_count\": 2,\n \"meeting_type\": \"internal\",\n \"account_name\": \"account_01\",\n \"complete_time\": \"2021-03-12T02:57:27Z\",\n \"is_breakout_room\": false,\n \"archive_files\": [\n {\n \"id\": \"55hfgsd-sd8e2bd7255\",\n \"file_type\": \"M4A\",\n \"file_extension\": \"M4A\",\n \"file_size\": 165743,\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\",\n \"individual\": true,\n \"participant_email\": \"user@example.com\",\n \"participant_join_time\": \"2021-03-12T02:07:27Z\",\n \"participant_leave_time\": \"2021-03-12T02:12:27Z\"\n },\n {\n \"id\": \"9c5daa5b-34a1-40e8-8947-a11be5e373a7\",\n \"file_type\": \"MP4\",\n \"file_extension\": \"MP4\",\n \"file_size\": 198720,\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC\",\n \"status\": \"completed\",\n \"recording_type\": \"shared_screen_with_speaker_view\",\n \"individual\": true,\n \"participant_email\": \"user1@example.com\",\n \"participant_join_time\": \"2021-03-12T02:07:27Z\",\n \"participant_leave_time\": \"2021-03-12T02:12:27Z\"\n }\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad request**<br>\n**Error Code:** `2001`<br>\nAccount does not exist: {accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/archive_files?page_size=30&next_page_token=quis officia in reprehenderit&from=quis officia in reprehenderit&to=quis officia in reprehenderit&query_date_type=meeting_start_time",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"archive_files"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "from",
"value": "quis officia in reprehenderit"
},
{
"key": "to",
"value": "quis officia in reprehenderit"
},
{
"key": "query_date_type",
"value": "meeting_start_time"
}
],
"variable": [
{
"key": "accountId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
