unicodeC / Zoom API / List recording registrants
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *first_name;
const wchar_t *last_name;
const wchar_t *email;
const wchar_t *address;
const wchar_t *city;
const wchar_t *country;
const wchar_t *zip;
const wchar_t *state;
const wchar_t *phone;
const wchar_t *industry;
const wchar_t *org;
const wchar_t *job_title;
const wchar_t *purchasing_time_frame;
const wchar_t *role_in_purchase_process;
const wchar_t *no_of_employees;
const wchar_t *comments;
const wchar_t *status;
const wchar_t *create_time;
const wchar_t *share_url;
int j;
int count_j;
int page_count;
int page_number;
int page_size;
int total_records;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"status",L"approved");
CkJsonObjectW_UpdateInt(queryParams,L"page_size",30);
CkJsonObjectW_UpdateInt(queryParams,L"page_number",1);
CkJsonObjectW_UpdateString(queryParams,L"next_page_token",L"quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/meetings/:meetingId/recordings/registrants",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
page_count = CkJsonObjectW_IntOf(jResp,L"page_count");
page_number = CkJsonObjectW_IntOf(jResp,L"page_number");
page_size = CkJsonObjectW_IntOf(jResp,L"page_size");
total_records = CkJsonObjectW_IntOf(jResp,L"total_records");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"registrants");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"registrants[i].id");
first_name = CkJsonObjectW_stringOf(jResp,L"registrants[i].first_name");
last_name = CkJsonObjectW_stringOf(jResp,L"registrants[i].last_name");
email = CkJsonObjectW_stringOf(jResp,L"registrants[i].email");
address = CkJsonObjectW_stringOf(jResp,L"registrants[i].address");
city = CkJsonObjectW_stringOf(jResp,L"registrants[i].city");
country = CkJsonObjectW_stringOf(jResp,L"registrants[i].country");
zip = CkJsonObjectW_stringOf(jResp,L"registrants[i].zip");
state = CkJsonObjectW_stringOf(jResp,L"registrants[i].state");
phone = CkJsonObjectW_stringOf(jResp,L"registrants[i].phone");
industry = CkJsonObjectW_stringOf(jResp,L"registrants[i].industry");
org = CkJsonObjectW_stringOf(jResp,L"registrants[i].org");
job_title = CkJsonObjectW_stringOf(jResp,L"registrants[i].job_title");
purchasing_time_frame = CkJsonObjectW_stringOf(jResp,L"registrants[i].purchasing_time_frame");
role_in_purchase_process = CkJsonObjectW_stringOf(jResp,L"registrants[i].role_in_purchase_process");
no_of_employees = CkJsonObjectW_stringOf(jResp,L"registrants[i].no_of_employees");
comments = CkJsonObjectW_stringOf(jResp,L"registrants[i].comments");
status = CkJsonObjectW_stringOf(jResp,L"registrants[i].status");
create_time = CkJsonObjectW_stringOf(jResp,L"registrants[i].create_time");
share_url = CkJsonObjectW_stringOf(jResp,L"registrants[i].share_url");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"registrants[i].custom_questions");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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": ""
}
]
}
