Chilkat Online Tools

autoit / Zoom API / List account's archived files

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

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("page_size",30)
$oQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
$oQueryParams.UpdateString("from","quis officia in reprehenderit")
$oQueryParams.UpdateString("to","quis officia in reprehenderit")
$oQueryParams.UpdateString("query_date_type","meeting_start_time")

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

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/accounts/:accountId/archive_files",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

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

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

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sUuid
Local $id
Local $sHost_id
Local $sTopic
Local $iV_type
Local $start_time
Local $sTimezone
Local $iDuration
Local $iTotal_size
Local $iRecording_count
Local $sMeeting_type
Local $sAccount_name
Local $sComplete_time
Local $bIs_breakout_room
Local $iJ
Local $iCount_j
Local $sId_str
Local $sFile_type
Local $sFile_extension
Local $iFile_size
Local $sDownload_url
Local $status
Local $sRecording_type
Local $bIndividual
Local $sParticipant_email
Local $sParticipant_join_time
Local $sParticipant_leave_time

Local $sFrom = $oJResp.StringOf("from")
Local $sV_to = $oJResp.StringOf("to")
Local $iPage_size = $oJResp.IntOf("page_size")
Local $sNext_page_token = $oJResp.StringOf("next_page_token")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("meetings")
While $i < $iCount_i
    $oJResp.I = $i
    $sUuid = $oJResp.StringOf("meetings[i].uuid")
    $id = $oJResp.IntOf("meetings[i].id")
    $sHost_id = $oJResp.StringOf("meetings[i].host_id")
    $sTopic = $oJResp.StringOf("meetings[i].topic")
    $iV_type = $oJResp.IntOf("meetings[i].type")
    $start_time = $oJResp.StringOf("meetings[i].start_time")
    $sTimezone = $oJResp.StringOf("meetings[i].timezone")
    $iDuration = $oJResp.IntOf("meetings[i].duration")
    $iTotal_size = $oJResp.IntOf("meetings[i].total_size")
    $iRecording_count = $oJResp.IntOf("meetings[i].recording_count")
    $sMeeting_type = $oJResp.StringOf("meetings[i].meeting_type")
    $sAccount_name = $oJResp.StringOf("meetings[i].account_name")
    $sComplete_time = $oJResp.StringOf("meetings[i].complete_time")
    $bIs_breakout_room = $oJResp.BoolOf("meetings[i].is_breakout_room")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("meetings[i].archive_files")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sId_str = $oJResp.StringOf("meetings[i].archive_files[j].id")
        $sFile_type = $oJResp.StringOf("meetings[i].archive_files[j].file_type")
        $sFile_extension = $oJResp.StringOf("meetings[i].archive_files[j].file_extension")
        $iFile_size = $oJResp.IntOf("meetings[i].archive_files[j].file_size")
        $sDownload_url = $oJResp.StringOf("meetings[i].archive_files[j].download_url")
        $status = $oJResp.StringOf("meetings[i].archive_files[j].status")
        $sRecording_type = $oJResp.StringOf("meetings[i].archive_files[j].recording_type")
        $bIndividual = $oJResp.BoolOf("meetings[i].archive_files[j].individual")
        $sParticipant_email = $oJResp.StringOf("meetings[i].archive_files[j].participant_email")
        $sParticipant_join_time = $oJResp.StringOf("meetings[i].archive_files[j].participant_join_time")
        $sParticipant_leave_time = $oJResp.StringOf("meetings[i].archive_files[j].participant_leave_time")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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