Chilkat Online Tools

delphiDll / Zoom API / List recording registrants

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
email: PWideChar;
address: PWideChar;
city: PWideChar;
country: PWideChar;
zip: PWideChar;
state: PWideChar;
phone: PWideChar;
industry: PWideChar;
org: PWideChar;
job_title: PWideChar;
purchasing_time_frame: PWideChar;
role_in_purchase_process: PWideChar;
no_of_employees: PWideChar;
comments: PWideChar;
status: PWideChar;
create_time: PWideChar;
share_url: PWideChar;
j: Integer;
count_j: Integer;
page_count: Integer;
page_number: Integer;
page_size: Integer;
total_records: Integer;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'status','approved');
CkJsonObject_UpdateInt(queryParams,'page_size',30);
CkJsonObject_UpdateInt(queryParams,'page_number',1);
CkJsonObject_UpdateString(queryParams,'next_page_token','quis officia in reprehenderit');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/meetings/:meetingId/recordings/registrants',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_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

page_count := CkJsonObject_IntOf(jResp,'page_count');
page_number := CkJsonObject_IntOf(jResp,'page_number');
page_size := CkJsonObject_IntOf(jResp,'page_size');
total_records := CkJsonObject_IntOf(jResp,'total_records');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'registrants');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'registrants[i].id');
    first_name := CkJsonObject__stringOf(jResp,'registrants[i].first_name');
    last_name := CkJsonObject__stringOf(jResp,'registrants[i].last_name');
    email := CkJsonObject__stringOf(jResp,'registrants[i].email');
    address := CkJsonObject__stringOf(jResp,'registrants[i].address');
    city := CkJsonObject__stringOf(jResp,'registrants[i].city');
    country := CkJsonObject__stringOf(jResp,'registrants[i].country');
    zip := CkJsonObject__stringOf(jResp,'registrants[i].zip');
    state := CkJsonObject__stringOf(jResp,'registrants[i].state');
    phone := CkJsonObject__stringOf(jResp,'registrants[i].phone');
    industry := CkJsonObject__stringOf(jResp,'registrants[i].industry');
    org := CkJsonObject__stringOf(jResp,'registrants[i].org');
    job_title := CkJsonObject__stringOf(jResp,'registrants[i].job_title');
    purchasing_time_frame := CkJsonObject__stringOf(jResp,'registrants[i].purchasing_time_frame');
    role_in_purchase_process := CkJsonObject__stringOf(jResp,'registrants[i].role_in_purchase_process');
    no_of_employees := CkJsonObject__stringOf(jResp,'registrants[i].no_of_employees');
    comments := CkJsonObject__stringOf(jResp,'registrants[i].comments');
    status := CkJsonObject__stringOf(jResp,'registrants[i].status');
    create_time := CkJsonObject__stringOf(jResp,'registrants[i].create_time');
    share_url := CkJsonObject__stringOf(jResp,'registrants[i].share_url');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'registrants[i].custom_questions');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_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": ""
    }
  ]
}