PureBasic / Zoom API / List recording registrants
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"status","approved")
CkJsonObject::ckUpdateInt(queryParams,"page_size",30)
CkJsonObject::ckUpdateInt(queryParams,"page_number",1)
CkJsonObject::ckUpdateString(queryParams,"next_page_token","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/meetings/:meetingId/recordings/registrants",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "page_count": 0,
; "page_number": 1,
; "page_size": 30,
; "total_records": 1,
; "registrants": [
; {
; "id": "sskldsbdABBBBBBBB",
; "first_name": "Shri",
; "last_name": "Shree",
; "email": "example@example.com",
; "address": "1800 Amphibious Blvd.",
; "city": "Mountain View",
; "country": "US",
; "zip": "94045",
; "state": "CA",
; "phone": "5550100",
; "industry": "sfsdf",
; "org": "dsadsfsf",
; "job_title": "sfsdfsdf",
; "purchasing_time_frame": "Within a month",
; "role_in_purchase_process": "Influencer",
; "no_of_employees": "40",
; "comments": "Amazing!",
; "custom_questions": [
; ],
; "status": "approved",
; "create_time": "2019-08-29T23:04:08Z",
; "share_url": "https://zoom.us/recording/share/IlA1ABCDDJHKNDkkkkkkkTziMw"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
first_name.s
last_name.s
email.s
address.s
city.s
country.s
zip.s
state.s
phone.s
industry.s
org.s
job_title.s
purchasing_time_frame.s
role_in_purchase_process.s
no_of_employees.s
comments.s
status.s
create_time.s
share_url.s
j.i
count_j.i
page_count.i = CkJsonObject::ckIntOf(jResp,"page_count")
page_number.i = CkJsonObject::ckIntOf(jResp,"page_number")
page_size.i = CkJsonObject::ckIntOf(jResp,"page_size")
total_records.i = CkJsonObject::ckIntOf(jResp,"total_records")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"registrants")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"registrants[i].id")
first_name = CkJsonObject::ckStringOf(jResp,"registrants[i].first_name")
last_name = CkJsonObject::ckStringOf(jResp,"registrants[i].last_name")
email = CkJsonObject::ckStringOf(jResp,"registrants[i].email")
address = CkJsonObject::ckStringOf(jResp,"registrants[i].address")
city = CkJsonObject::ckStringOf(jResp,"registrants[i].city")
country = CkJsonObject::ckStringOf(jResp,"registrants[i].country")
zip = CkJsonObject::ckStringOf(jResp,"registrants[i].zip")
state = CkJsonObject::ckStringOf(jResp,"registrants[i].state")
phone = CkJsonObject::ckStringOf(jResp,"registrants[i].phone")
industry = CkJsonObject::ckStringOf(jResp,"registrants[i].industry")
org = CkJsonObject::ckStringOf(jResp,"registrants[i].org")
job_title = CkJsonObject::ckStringOf(jResp,"registrants[i].job_title")
purchasing_time_frame = CkJsonObject::ckStringOf(jResp,"registrants[i].purchasing_time_frame")
role_in_purchase_process = CkJsonObject::ckStringOf(jResp,"registrants[i].role_in_purchase_process")
no_of_employees = CkJsonObject::ckStringOf(jResp,"registrants[i].no_of_employees")
comments = CkJsonObject::ckStringOf(jResp,"registrants[i].comments")
status = CkJsonObject::ckStringOf(jResp,"registrants[i].status")
create_time = CkJsonObject::ckStringOf(jResp,"registrants[i].create_time")
share_url = CkJsonObject::ckStringOf(jResp,"registrants[i].share_url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"registrants[i].custom_questions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "status=approved"
-d "page_size=30"
-d "page_number=1"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/recordings/registrants
Postman Collection Item JSON
{
"name": "List recording registrants",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings/registrants?status=approved&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings",
"registrants"
],
"query": [
{
"key": "status",
"value": "approved",
"description": "Query by the registrant's status: \n* `pending` — The registration is pending. \n* `approved` — The registrant is approved. \n* `denied` — The registration is denied."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "page_number",
"value": "1",
"description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
},
{
"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."
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
},
"description": "Use this API to list registrants of a past meeting's [on-demand cloud recordings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-recordings). Users must [register](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view the recordings. \n\n **Scopes:** `recording:read:admin`, `recording:read` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\n Registrants returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings/registrants?status=approved&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings",
"registrants"
],
"query": [
{
"key": "status",
"value": "approved"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": 0,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"registrants\": [\n {\n \"id\": \"sskldsbdABBBBBBBB\",\n \"first_name\": \"Shri\",\n \"last_name\": \"Shree\",\n \"email\": \"example@example.com\",\n \"address\": \"1800 Amphibious Blvd.\",\n \"city\": \"Mountain View\",\n \"country\": \"US\",\n \"zip\": \"94045\",\n \"state\": \"CA\",\n \"phone\": \"5550100\",\n \"industry\": \"sfsdf\",\n \"org\": \"dsadsfsf\",\n \"job_title\": \"sfsdfsdf\",\n \"purchasing_time_frame\": \"Within a month\",\n \"role_in_purchase_process\": \"Influencer\",\n \"no_of_employees\": \"40\",\n \"comments\": \"Amazing!\",\n \"custom_questions\": [],\n \"status\": \"approved\",\n \"create_time\": \"2019-08-29T23:04:08Z\",\n \"share_url\": \"https://zoom.us/recording/share/IlA1ABCDDJHKNDkkkkkkkTziMw\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404` <br>\n Meeting recording not found.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/recordings/registrants?status=approved&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"recordings",
"registrants"
],
"query": [
{
"key": "status",
"value": "approved"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
