Chilkat Online Tools

lianja / Zoom API / Get meeting archived files

Back to Collection Items

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

loHttp = createobject("CkHttp")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.zoom.us/v2/past_meetings/:meetingUUID/archive_files",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "uuid": "yVaEafxxRN+tiOZUSWKJVw==",
//   "id": 4554919265,
//   "host_id": "7pTFNV2SS0i0LKfQhmMyHQ",
//   "topic": "ZOOM_API Test's Personal Meeting Room",
//   "type": 4,
//   "start_time": "2021-04-26T05:23:18Z",
//   "timezone": "Asia/Shanghai",
//   "duration": 1,
//   "total_size": 2676453,
//   "recording_count": 2,
//   "meeting_type": "internal",
//   "account_name": "account_01",
//   "complete_time": "2021-03-12T02:57:27Z",
//   "is_breakout_room": false,
//   "archive_files": [
//     {
//       "id": "20d04c59-df9a-442b-9a3d-570884bede07",
//       "file_type": "MP4",
//       "file_extension": "MP4",
//       "file_size": 1434664,
//       "download_url": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
//       "status": "completed",
//       "recording_type": "shared_screen_with_speaker_view",
//       "individual": true,
//       "participant_email": "user@example.com",
//       "participant_join_time": "2021-03-12T02:07:27Z",
//       "participant_leave_time": "2021-03-12T02:12:27Z"
//     },
//     {
//       "id": "83cc23a5-3a35-44e2-87b3-a2b5a4dac6f8",
//       "file_type": "M4A",
//       "file_extension": "M4A",
//       "file_size": 1241789,
//       "download_url": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC",
//       "status": "completed",
//       "recording_type": "audio_only",
//       "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

lcUuid = loJResp.StringOf("uuid")
lnId = loJResp.IntOf("id")
lcHost_id = loJResp.StringOf("host_id")
lcTopic = loJResp.StringOf("topic")
lnV_type = loJResp.IntOf("type")
lcStart_time = loJResp.StringOf("start_time")
lcTimezone = loJResp.StringOf("timezone")
lnDuration = loJResp.IntOf("duration")
lnTotal_size = loJResp.IntOf("total_size")
lnRecording_count = loJResp.IntOf("recording_count")
lcMeeting_type = loJResp.StringOf("meeting_type")
lcAccount_name = loJResp.StringOf("account_name")
lcComplete_time = loJResp.StringOf("complete_time")
llIs_breakout_room = loJResp.BoolOf("is_breakout_room")
i = 0
lnCount_i = loJResp.SizeOfArray("archive_files")
do while i < lnCount_i
    loJResp.I = i
    lcId_str = loJResp.StringOf("archive_files[i].id")
    lcFile_type = loJResp.StringOf("archive_files[i].file_type")
    lcFile_extension = loJResp.StringOf("archive_files[i].file_extension")
    lnFile_size = loJResp.IntOf("archive_files[i].file_size")
    lcDownload_url = loJResp.StringOf("archive_files[i].download_url")
    lcStatus = loJResp.StringOf("archive_files[i].status")
    lcRecording_type = loJResp.StringOf("archive_files[i].recording_type")
    llIndividual = loJResp.BoolOf("archive_files[i].individual")
    lcParticipant_email = loJResp.StringOf("archive_files[i].participant_email")
    lcParticipant_join_time = loJResp.StringOf("archive_files[i].participant_join_time")
    lcParticipant_leave_time = loJResp.StringOf("archive_files[i].participant_leave_time")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/past_meetings/:meetingUUID/archive_files

Postman Collection Item JSON

{
  "name": "Get meeting archived files",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/past_meetings/:meetingUUID/archive_files",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "past_meetings",
        ":meetingUUID",
        "archive_files"
      ],
      "variable": [
        {
          "key": "meetingUUID",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.\n\nIf the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls."
        }
      ]
    },
    "description": "List the archived recording files of the specific meeting instance. For more information, read our [Managing archiving of meeting and webinar data](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) documentation.\n\n**Scopes:** `recording:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\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**\nMeeting with Archived files returned.\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/past_meetings/:meetingUUID/archive_files",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "past_meetings",
            ":meetingUUID",
            "archive_files"
          ],
          "variable": [
            {
              "key": "meetingUUID",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.\n\nIf the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"uuid\": \"yVaEafxxRN+tiOZUSWKJVw==\",\n \"id\": 4554919265,\n \"host_id\": \"7pTFNV2SS0i0LKfQhmMyHQ\",\n \"topic\": \"ZOOM_API Test's Personal Meeting Room\",\n \"type\": 4,\n \"start_time\": \"2021-04-26T05:23:18Z\",\n \"timezone\": \"Asia/Shanghai\",\n \"duration\": 1,\n \"total_size\": 2676453,\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\": \"20d04c59-df9a-442b-9a3d-570884bede07\",\n   \"file_type\": \"MP4\",\n   \"file_extension\": \"MP4\",\n   \"file_size\": 1434664,\n   \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n   \"status\": \"completed\",\n   \"recording_type\": \"shared_screen_with_speaker_view\",\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\": \"83cc23a5-3a35-44e2-87b3-a2b5a4dac6f8\",\n   \"file_type\": \"M4A\",\n   \"file_extension\": \"M4A\",\n   \"file_size\": 1241789,\n   \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC\",\n   \"status\": \"completed\",\n   \"recording_type\": \"audio_only\",\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}"
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nMeeting recording not found.<br>\n**Error Code:** `3001`<br>\nMeeting {meetingUUId} does not exist.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/past_meetings/:meetingUUID/archive_files",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "past_meetings",
            ":meetingUUID",
            "archive_files"
          ],
          "variable": [
            {
              "key": "meetingUUID",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.\n\nIf the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}