DataFlex / Zoom API / Get meeting recordings
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId_str
String sMeeting_id
String sRecording_start
String sRecording_end
String sFile_type
Integer iFile_size
String sPlay_url
String sDownload_url
String sStatus
String sRecording_type
String sFile_name
String sFile_extension
String sUuid
Integer iId
String sAccount_id
String sHost_id
String sTopic
Integer iV_type
String sStart_time
String sTimezone
Integer iDuration
Integer iTotal_size
Integer iRecording_count
String sShare_url
String sDownload_access_token
String sPassword
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "include_fields" "quis officia in reprehenderit" To iSuccess
Get ComUpdateInt Of hoQueryParams "ttl" 20600 To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/meetings/:meetingId/recordings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "uuid": "gkABCDEbbbbbbbkPuA==",
// "id": 68000000031879,
// "account_id": "EABkdslfBBBdk",
// "host_id": "z8yBXksaAAjdhfsfdfkjgg",
// "topic": "MyTestPollMeeting",
// "type": 2,
// "start_time": "2019-08-29T21:54:49Z",
// "timezone": "America/Los_Angeles",
// "duration": 1,
// "total_size": 74596,
// "recording_count": 4,
// "share_url": "https://api.zoom.us/recording/share/abcdkhfdbbfdjbg",
// "recording_files": [
// {
// "id": "96119skjlfhdshkjf-djkfndjf0-f791",
// "meeting_id": "gkABCDEbbbbbbbkPuA==",
// "recording_start": "2019-08-29T21:54:55Z",
// "recording_end": "2019-08-29T21:55:24Z",
// "file_type": "MP4",
// "file_size": 37285,
// "play_url": "https://api.zoom.us/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
// "download_url": "https://api.zoom.us/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
// "status": "completed",
// "recording_type": "shared_screen_with_speaker_view"
// },
// {
// "id": "5890sfjkdsf-aaaakdf-fbbb618718e",
// "meeting_id": "gkABCDEbbbbbbbkPuA==",
// "recording_start": "2019-08-29T21:54:55Z",
// "recording_end": "2019-08-29T21:55:24Z",
// "file_type": "M4A",
// "file_size": 10098,
// "play_url": "https://api.zoom.us/recording/play/ABdkEEEfhlgldfjkglfghlkfdklhsg",
// "download_url": "https://api.zoom.us/recording/download/ABdkEEEfhlgldfjkglfghlkfdklhsg",
// "status": "completed",
// "recording_type": "audio_only"
// },
// {
// "meeting_id": "gkABCDEbbbbbbbkPuA==",
// "recording_start": "2019-08-29T21:54:55Z",
// "recording_end": "2019-08-29T21:55:24Z",
// "file_type": "TIMELINE",
// "download_url": "https://api.zoom.us/recording/download/e2ed-dlkjgdfkgh-kslsdbsjf1a"
// }
// ],
// "download_access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOiJvNEU2WnVydFJQdWpxQVZQNmxoTVpnPT0iLCJleHAiOjE2MjEzMDY3MTR9.AiTsTgso8-g487NROU7oGXsn04W68HdZXrjqR3W-X_s",
// "password": "123456789",
// "participant_audio_files": [
// {
// "id": "6ebb42fb-fce2-4c6d-932d-27229f07e933",
// "recording_start": "2021-06-22T05:23:41Z",
// "recording_end": "2021-06-22T05:23:58Z",
// "file_name": "Audio only - API1 TA2",
// "file_type": "M4A",
// "file_extension": "M4A",
// "file_size": 272173,
// "play_url": "https://example.zoomdev.us/rec/play/S9sHV863qengfT4zNYGSE2gUpltTVQOL2cwOjFkyGfVZhOpnONozI_9RVJsfcc-y3iT0ayG7CKrXnGw.yqI3hidFZBHn3LXt",
// "download_url": "https://example.zoomdev.us/rec/download/S9sHV863qengfT4zNYGSE2gUpltTVQOL2cwOjFkyGfVZhOpnONozI_9RVJsfcc-y3iT0ayG7CKrXnGw.yqI3hidFZBHn3LXt",
// "status": "completed"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "uuid" To sUuid
Get ComIntOf Of hoJResp "id" To iId
Get ComStringOf Of hoJResp "account_id" To sAccount_id
Get ComStringOf Of hoJResp "host_id" To sHost_id
Get ComStringOf Of hoJResp "topic" To sTopic
Get ComIntOf Of hoJResp "type" To iV_type
Get ComStringOf Of hoJResp "start_time" To sStart_time
Get ComStringOf Of hoJResp "timezone" To sTimezone
Get ComIntOf Of hoJResp "duration" To iDuration
Get ComIntOf Of hoJResp "total_size" To iTotal_size
Get ComIntOf Of hoJResp "recording_count" To iRecording_count
Get ComStringOf Of hoJResp "share_url" To sShare_url
Get ComStringOf Of hoJResp "download_access_token" To sDownload_access_token
Get ComStringOf Of hoJResp "password" To sPassword
Move 0 To i
Get ComSizeOfArray Of hoJResp "recording_files" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "recording_files[i].id" To sId_str
Get ComStringOf Of hoJResp "recording_files[i].meeting_id" To sMeeting_id
Get ComStringOf Of hoJResp "recording_files[i].recording_start" To sRecording_start
Get ComStringOf Of hoJResp "recording_files[i].recording_end" To sRecording_end
Get ComStringOf Of hoJResp "recording_files[i].file_type" To sFile_type
Get ComIntOf Of hoJResp "recording_files[i].file_size" To iFile_size
Get ComStringOf Of hoJResp "recording_files[i].play_url" To sPlay_url
Get ComStringOf Of hoJResp "recording_files[i].download_url" To sDownload_url
Get ComStringOf Of hoJResp "recording_files[i].status" To sStatus
Get ComStringOf Of hoJResp "recording_files[i].recording_type" To sRecording_type
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "participant_audio_files" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "participant_audio_files[i].id" To sId_str
Get ComStringOf Of hoJResp "participant_audio_files[i].recording_start" To sRecording_start
Get ComStringOf Of hoJResp "participant_audio_files[i].recording_end" To sRecording_end
Get ComStringOf Of hoJResp "participant_audio_files[i].file_name" To sFile_name
Get ComStringOf Of hoJResp "participant_audio_files[i].file_type" To sFile_type
Get ComStringOf Of hoJResp "participant_audio_files[i].file_extension" To sFile_extension
Get ComIntOf Of hoJResp "participant_audio_files[i].file_size" To iFile_size
Get ComStringOf Of hoJResp "participant_audio_files[i].play_url" To sPlay_url
Get ComStringOf Of hoJResp "participant_audio_files[i].download_url" To sDownload_url
Get ComStringOf Of hoJResp "participant_audio_files[i].status" To sStatus
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "include_fields=quis%20officia%20in%20reprehenderit"
-d "ttl=20600"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/recordings
Postman Collection Item JSON
{
"name": "Get meeting recordings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings?include_fields=quis officia in reprehenderit&ttl=20600",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings"
],
"query": [
{
"key": "include_fields",
"value": "quis officia in reprehenderit",
"description": "Get the `download_access_token` field for downloading meeting recordings."
},
{
"key": "ttl",
"value": "20600",
"description": "Time to live (TTL) of the `download_access_token`. This is only valid if the `include_fields` query parameter contains `download_access_token`. The range is between 0-604800."
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request. "
}
]
},
"description": "Get all the [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting or Webinar instance. The recording files can be downloaded via the `download_url` property listed in the response.\n\n> To access a password-protected cloud recording, add an `access_token` parameter to the download URL and provide OAuth access token or [JWT](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app) as the `access_token` value.\n\n**Scopes:** `recording:read:admin`, `recording:read`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**Error Code:** `200` <br>\nYou do not have the right permissions.\n**HTTP Status Code:** `200`<br>\nRecording object returned.<br>\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings?include_fields=quis officia in reprehenderit&ttl=20600",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings"
],
"query": [
{
"key": "include_fields",
"value": "quis officia in reprehenderit"
},
{
"key": "ttl",
"value": "20600"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request. "
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"uuid\": \"gkABCDEbbbbbbbkPuA==\",\n \"id\": 68000000031879,\n \"account_id\": \"EABkdslfBBBdk\",\n \"host_id\": \"z8yBXksaAAjdhfsfdfkjgg\",\n \"topic\": \"MyTestPollMeeting\",\n \"type\": 2,\n \"start_time\": \"2019-08-29T21:54:49Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"duration\": 1,\n \"total_size\": 74596,\n \"recording_count\": 4,\n \"share_url\": \"https://api.zoom.us/recording/share/abcdkhfdbbfdjbg\",\n \"recording_files\": [\n {\n \"id\": \"96119skjlfhdshkjf-djkfndjf0-f791\",\n \"meeting_id\": \"gkABCDEbbbbbbbkPuA==\",\n \"recording_start\": \"2019-08-29T21:54:55Z\",\n \"recording_end\": \"2019-08-29T21:55:24Z\",\n \"file_type\": \"MP4\",\n \"file_size\": 37285,\n \"play_url\": \"https://api.zoom.us/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"download_url\": \"https://api.zoom.us/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"shared_screen_with_speaker_view\"\n },\n {\n \"id\": \"5890sfjkdsf-aaaakdf-fbbb618718e\",\n \"meeting_id\": \"gkABCDEbbbbbbbkPuA==\",\n \"recording_start\": \"2019-08-29T21:54:55Z\",\n \"recording_end\": \"2019-08-29T21:55:24Z\",\n \"file_type\": \"M4A\",\n \"file_size\": 10098,\n \"play_url\": \"https://api.zoom.us/recording/play/ABdkEEEfhlgldfjkglfghlkfdklhsg\",\n \"download_url\": \"https://api.zoom.us/recording/download/ABdkEEEfhlgldfjkglfghlkfdklhsg\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\"\n },\n {\n \"meeting_id\": \"gkABCDEbbbbbbbkPuA==\",\n \"recording_start\": \"2019-08-29T21:54:55Z\",\n \"recording_end\": \"2019-08-29T21:55:24Z\",\n \"file_type\": \"TIMELINE\",\n \"download_url\": \"https://api.zoom.us/recording/download/e2ed-dlkjgdfkgh-kslsdbsjf1a\"\n }\n ],\n \"download_access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtaWQiOiJvNEU2WnVydFJQdWpxQVZQNmxoTVpnPT0iLCJleHAiOjE2MjEzMDY3MTR9.AiTsTgso8-g487NROU7oGXsn04W68HdZXrjqR3W-X_s\",\n \"password\": \"123456789\",\n \"participant_audio_files\": [\n {\n \"id\": \"6ebb42fb-fce2-4c6d-932d-27229f07e933\",\n \"recording_start\": \"2021-06-22T05:23:41Z\",\n \"recording_end\": \"2021-06-22T05:23:58Z\",\n \"file_name\": \"Audio only - API1 TA2\",\n \"file_type\": \"M4A\",\n \"file_extension\": \"M4A\",\n \"file_size\": 272173,\n \"play_url\": \"https://example.zoomdev.us/rec/play/S9sHV863qengfT4zNYGSE2gUpltTVQOL2cwOjFkyGfVZhOpnONozI_9RVJsfcc-y3iT0ayG7CKrXnGw.yqI3hidFZBHn3LXt\",\n \"download_url\": \"https://example.zoomdev.us/rec/download/S9sHV863qengfT4zNYGSE2gUpltTVQOL2cwOjFkyGfVZhOpnONozI_9RVJsfcc-y3iT0ayG7CKrXnGw.yqI3hidFZBHn3LXt\",\n \"status\": \"completed\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` <br>\n**Error Code:** `1010`<br>\nUser not found on this account: {accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings?include_fields=quis officia in reprehenderit&ttl=20600",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings"
],
"query": [
{
"key": "include_fields",
"value": "quis officia in reprehenderit"
},
{
"key": "ttl",
"value": "20600"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request. "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nMeeting recording not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3301`<br>\nThere is no recording for this meeting.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings?include_fields=quis officia in reprehenderit&ttl=20600",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings"
],
"query": [
{
"key": "include_fields",
"value": "quis officia in reprehenderit"
},
{
"key": "ttl",
"value": "20600"
}
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request. "
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
