PureBasic / Zoom API / Get meeting archived files
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.zoom.us/v2/past_meetings/:meetingUUID/archive_files",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
id_str.s
file_type.s
file_extension.s
file_size.i
download_url.s
status.s
recording_type.s
individual.i
participant_email.s
participant_join_time.s
participant_leave_time.s
uuid.s = CkJsonObject::ckStringOf(jResp,"uuid")
id.i = CkJsonObject::ckIntOf(jResp,"id")
host_id.s = CkJsonObject::ckStringOf(jResp,"host_id")
topic.s = CkJsonObject::ckStringOf(jResp,"topic")
v_type.i = CkJsonObject::ckIntOf(jResp,"type")
start_time.s = CkJsonObject::ckStringOf(jResp,"start_time")
timezone.s = CkJsonObject::ckStringOf(jResp,"timezone")
duration.i = CkJsonObject::ckIntOf(jResp,"duration")
total_size.i = CkJsonObject::ckIntOf(jResp,"total_size")
recording_count.i = CkJsonObject::ckIntOf(jResp,"recording_count")
meeting_type.s = CkJsonObject::ckStringOf(jResp,"meeting_type")
account_name.s = CkJsonObject::ckStringOf(jResp,"account_name")
complete_time.s = CkJsonObject::ckStringOf(jResp,"complete_time")
is_breakout_room.i = CkJsonObject::ckBoolOf(jResp,"is_breakout_room")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"archive_files")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id_str = CkJsonObject::ckStringOf(jResp,"archive_files[i].id")
file_type = CkJsonObject::ckStringOf(jResp,"archive_files[i].file_type")
file_extension = CkJsonObject::ckStringOf(jResp,"archive_files[i].file_extension")
file_size = CkJsonObject::ckIntOf(jResp,"archive_files[i].file_size")
download_url = CkJsonObject::ckStringOf(jResp,"archive_files[i].download_url")
status = CkJsonObject::ckStringOf(jResp,"archive_files[i].status")
recording_type = CkJsonObject::ckStringOf(jResp,"archive_files[i].recording_type")
individual = CkJsonObject::ckBoolOf(jResp,"archive_files[i].individual")
participant_email = CkJsonObject::ckStringOf(jResp,"archive_files[i].participant_email")
participant_join_time = CkJsonObject::ckStringOf(jResp,"archive_files[i].participant_join_time")
participant_leave_time = CkJsonObject::ckStringOf(jResp,"archive_files[i].participant_leave_time")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
