Foxpro / Zoom API / List all recordings
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcUuid
LOCAL lnId
LOCAL lcAccount_id
LOCAL lcHost_id
LOCAL lcTopic
LOCAL lnV_type
LOCAL lcStart_time
LOCAL lcTimezone
LOCAL lnDuration
LOCAL lnTotal_size
LOCAL lnRecording_count
LOCAL lcShare_url
LOCAL j
LOCAL lnCount_j
LOCAL lcId_str
LOCAL lcMeeting_id
LOCAL lcRecording_start
LOCAL lcRecording_end
LOCAL lcFile_type
LOCAL lnFile_size
LOCAL lcPlay_url
LOCAL lcDownload_url
LOCAL lcStatus
LOCAL lcRecording_type
LOCAL lcFrom
LOCAL lcV_to
LOCAL lnPage_count
LOCAL lnPage_size
LOCAL lnTotal_records
LOCAL lcNext_page_token
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("page_size",30)
loQueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
loQueryParams.UpdateString("mc","false")
loQueryParams.UpdateString("trash","false")
loQueryParams.UpdateString("from","1989-05-07")
loQueryParams.UpdateString("to","1989-05-07")
loQueryParams.UpdateString("trash_type","meeting_recordings")
loQueryParams.UpdateInt("meeting_id",68423085)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/users/:userId/recordings",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "from": "2019-08-15",
* "to": "2019-09-15",
* "page_count": 1,
* "page_size": 30,
* "total_records": 1,
* "next_page_token": "",
* "meetings": [
* {
* "uuid": "gkABCDEnCkPuA==",
* "id": 1000000000000,
* "account_id": "AbcjxkfhdEEE",
* "host_id": "z8dfkgABBBBBBBfp8uQ",
* "topic": "MyTestPollMeeting",
* "type": 2,
* "start_time": "2019-08-29T21:54:49Z",
* "timezone": "America/Los_Angeles",
* "duration": 1,
* "total_size": 47383,
* "recording_count": 1,
* "share_url": "https://api.zoom.us/recording/share/IABCDJDKDJEEEEEk_GwfdggdgkTziMw",
* "recording_files": [
* {
* "id": "589ABBBBB-8718e",
* "meeting_id": "gkABCDEnCkPuA==",
* "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/pfA2AvvvvvAnAzOibbbbELxl",
* "download_url": "https://api.zoom.us/recording/download/pfA2AvvvvvAnAzOibbbbELxl",
* "status": "completed",
* "recording_type": "audio_only"
* },
* {
* "meeting_id": "gkABCDEnCkPuA==",
* "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/cc33ekldfdjfhf3-aaaaa"
* },
* {
* "id": "96119b=kdfhf791",
* "meeting_id": "gkABCDEnCkPuA==",
* "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/abcdkjfhdhfdhfj",
* "download_url": "https://api.zoom.us/recording/download/abcdkjfhdhfdhfj",
* "status": "completed",
* "recording_type": "shared_screen_with_speaker_view"
* }
* ]
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcFrom = loJResp.StringOf("from")
lcV_to = loJResp.StringOf("to")
lnPage_count = loJResp.IntOf("page_count")
lnPage_size = loJResp.IntOf("page_size")
lnTotal_records = loJResp.IntOf("total_records")
lcNext_page_token = loJResp.StringOf("next_page_token")
i = 0
lnCount_i = loJResp.SizeOfArray("meetings")
DO WHILE i < lnCount_i
loJResp.I = i
lcUuid = loJResp.StringOf("meetings[i].uuid")
lnId = loJResp.IntOf("meetings[i].id")
lcAccount_id = loJResp.StringOf("meetings[i].account_id")
lcHost_id = loJResp.StringOf("meetings[i].host_id")
lcTopic = loJResp.StringOf("meetings[i].topic")
lnV_type = loJResp.IntOf("meetings[i].type")
lcStart_time = loJResp.StringOf("meetings[i].start_time")
lcTimezone = loJResp.StringOf("meetings[i].timezone")
lnDuration = loJResp.IntOf("meetings[i].duration")
lnTotal_size = loJResp.IntOf("meetings[i].total_size")
lnRecording_count = loJResp.IntOf("meetings[i].recording_count")
lcShare_url = loJResp.StringOf("meetings[i].share_url")
j = 0
lnCount_j = loJResp.SizeOfArray("meetings[i].recording_files")
DO WHILE j < lnCount_j
loJResp.J = j
lcId_str = loJResp.StringOf("meetings[i].recording_files[j].id")
lcMeeting_id = loJResp.StringOf("meetings[i].recording_files[j].meeting_id")
lcRecording_start = loJResp.StringOf("meetings[i].recording_files[j].recording_start")
lcRecording_end = loJResp.StringOf("meetings[i].recording_files[j].recording_end")
lcFile_type = loJResp.StringOf("meetings[i].recording_files[j].file_type")
lnFile_size = loJResp.IntOf("meetings[i].recording_files[j].file_size")
lcPlay_url = loJResp.StringOf("meetings[i].recording_files[j].play_url")
lcDownload_url = loJResp.StringOf("meetings[i].recording_files[j].download_url")
lcStatus = loJResp.StringOf("meetings[i].recording_files[j].status")
lcRecording_type = loJResp.StringOf("meetings[i].recording_files[j].recording_type")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "mc=false"
-d "trash=false"
-d "from=1989-05-07"
-d "to=1989-05-07"
-d "trash_type=meeting_recordings"
-d "meeting_id=68423085"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/recordings
Postman Collection Item JSON
{
"name": "List all recordings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/recordings?page_size=30&next_page_token=quis officia in reprehenderit&mc=false&trash=false&from=1989-05-07&to=1989-05-07&trash_type=meeting_recordings&meeting_id=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"recordings"
],
"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": "mc",
"value": "false",
"description": "Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting."
},
{
"key": "trash",
"value": "false",
"description": "Query trash.\n`true`: List recordings from trash.<br> `false`: Do not list recordings from the trash.<br> The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve. "
},
{
"key": "from",
"value": "1989-05-07",
"description": "The start date in 'yyyy-mm-dd' UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”. \n\n**Note**: The \"trash\" files cannot be filtered by date range and thus, the \"from\" and \"to\" fields should not be used for trash files."
},
{
"key": "to",
"value": "1989-05-07",
"description": "End date in 'yyyy-mm-dd' 'yyyy-mm-dd' UTC format. "
},
{
"key": "trash_type",
"value": "meeting_recordings",
"description": "The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:<br>\n `meeting_recordings`: List all meeting recordings from the trash.<br>\n `recording_file`: List all individual recording files from the trash. "
},
{
"key": "meeting_id",
"value": "68423085",
"description": "The meeting ID."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Use this API to list all [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note:</b> To access a user's password protected cloud recording, add an <code>access_token</code> parameter to the download URL and provide either the <a href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app\">JWT</a> or the user's OAuth access token as the value of the <code>access_token</code> parameter.</p>\n\nWhen a user records a meeting or a webinar by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud.\n\n**Scopes:** `recording:read:admin`, `recording:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n**Prerequisites:** \n* Pro or a higher plan.\n* Cloud Recording must be enabled on the user's account."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nList of recording objects returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/recordings?page_size=30&next_page_token=quis officia in reprehenderit&mc=false&trash=false&from=1989-05-07&to=1989-05-07&trash_type=meeting_recordings&meeting_id=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"recordings"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "mc",
"value": "false"
},
{
"key": "trash",
"value": "false"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "trash_type",
"value": "meeting_recordings"
},
{
"key": "meeting_id",
"value": "68423085"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-08-15\",\n \"to\": \"2019-09-15\",\n \"page_count\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"next_page_token\": \"\",\n \"meetings\": [\n {\n \"uuid\": \"gkABCDEnCkPuA==\",\n \"id\": 1000000000000,\n \"account_id\": \"AbcjxkfhdEEE\",\n \"host_id\": \"z8dfkgABBBBBBBfp8uQ\",\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\": 47383,\n \"recording_count\": 1,\n \"share_url\": \"https://api.zoom.us/recording/share/IABCDJDKDJEEEEEk_GwfdggdgkTziMw\",\n \"recording_files\": [\n {\n \"id\": \"589ABBBBB-8718e\",\n \"meeting_id\": \"gkABCDEnCkPuA==\",\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/pfA2AvvvvvAnAzOibbbbELxl\",\n \"download_url\": \"https://api.zoom.us/recording/download/pfA2AvvvvvAnAzOibbbbELxl\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\"\n },\n {\n \"meeting_id\": \"gkABCDEnCkPuA==\",\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/cc33ekldfdjfhf3-aaaaa\"\n },\n {\n \"id\": \"96119b=kdfhf791\",\n \"meeting_id\": \"gkABCDEnCkPuA==\",\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/abcdkjfhdhfdhfj\",\n \"download_url\": \"https://api.zoom.us/recording/download/abcdkjfhdhfdhfj\",\n \"status\": \"completed\",\n \"recording_type\": \"shared_screen_with_speaker_view\"\n }\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br><br>\n**Error Code:** `1001`<br>\nUser {userId} not exist or not belong to this account.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/recordings?page_size=30&next_page_token=quis officia in reprehenderit&mc=false&trash=false&from=1989-05-07&to=1989-05-07&trash_type=meeting_recordings&meeting_id=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"recordings"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "mc",
"value": "false"
},
{
"key": "trash",
"value": "false"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "trash_type",
"value": "meeting_recordings"
},
{
"key": "meeting_id",
"value": "68423085"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
