phpExt / Zoom API / List webinar registrants
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateString('occurrence_id','quis officia in reprehenderit');
$queryParams->UpdateString('status','approved');
$queryParams->UpdateString('tracking_source_id','quis officia in reprehenderit');
$queryParams->UpdateInt('page_size',30);
$queryParams->UpdateInt('page_number',1);
$queryParams->UpdateString('next_page_token','quis officia in reprehenderit');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.zoom.us/v2/webinars/:webinarId/registrants',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page_count": "1",
// "page_number": "1",
// "page_size": "30",
// "total_records": "1",
// "registrants": [
// {
// "id": "24000002122",
// "email": "example@example.com",
// "first_name": "Jill",
// "last_name": "Chill",
// "address": "1800 Amphibious Blvd.",
// "city": "Mountain View",
// "country": "US",
// "zip": "94045",
// "state": "CA",
// "phone": "5550100",
// "industry": "Food",
// "org": "Cooking Org",
// "job_title": "Chef",
// "purchasing_time_frame": "1-3 months",
// "role_in_purchase_process": "Influencer",
// "no_of_employees": "10",
// "comments": "Looking forward to the Webinar",
// "custom_questions": [
// {
// "title": "What do you hope to learn from this Webinar?",
// "value": "Look forward to learning how you come up with new recipes and what other services you offer."
// }
// ],
// "status": "approved",
// "create_time": "2019-02-26T23:01:16.899Z",
// "join_url": "https://zoom.us/webinar/mywebinarissocooldighdghodghodg"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$page_count = $jResp->stringOf('page_count');
$page_number = $jResp->stringOf('page_number');
$page_size = $jResp->stringOf('page_size');
$total_records = $jResp->stringOf('total_records');
$i = 0;
$count_i = $jResp->SizeOfArray('registrants');
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf('registrants[i].id');
$email = $jResp->stringOf('registrants[i].email');
$first_name = $jResp->stringOf('registrants[i].first_name');
$last_name = $jResp->stringOf('registrants[i].last_name');
$address = $jResp->stringOf('registrants[i].address');
$city = $jResp->stringOf('registrants[i].city');
$country = $jResp->stringOf('registrants[i].country');
$zip = $jResp->stringOf('registrants[i].zip');
$state = $jResp->stringOf('registrants[i].state');
$phone = $jResp->stringOf('registrants[i].phone');
$industry = $jResp->stringOf('registrants[i].industry');
$org = $jResp->stringOf('registrants[i].org');
$job_title = $jResp->stringOf('registrants[i].job_title');
$purchasing_time_frame = $jResp->stringOf('registrants[i].purchasing_time_frame');
$role_in_purchase_process = $jResp->stringOf('registrants[i].role_in_purchase_process');
$no_of_employees = $jResp->stringOf('registrants[i].no_of_employees');
$comments = $jResp->stringOf('registrants[i].comments');
$status = $jResp->stringOf('registrants[i].status');
$create_time = $jResp->stringOf('registrants[i].create_time');
$join_url = $jResp->stringOf('registrants[i].join_url');
$j = 0;
$count_j = $jResp->SizeOfArray('registrants[i].custom_questions');
while ($j < $count_j) {
$jResp->put_J($j);
$title = $jResp->stringOf('registrants[i].custom_questions[j].title');
$value = $jResp->stringOf('registrants[i].custom_questions[j].value');
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -G -d "occurrence_id=quis%20officia%20in%20reprehenderit"
-d "status=approved"
-d "tracking_source_id=quis%20officia%20in%20reprehenderit"
-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/webinars/:webinarId/registrants
Postman Collection Item JSON
{
"name": "List webinar registrants",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=quis officia in reprehenderit&status=approved&tracking_source_id=quis officia in reprehenderit&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit",
"description": "The meeting or webinar occurrence ID."
},
{
"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": "tracking_source_id",
"value": "quis officia in reprehenderit",
"description": "The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See [Creating source tracking links for webinar registration](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-source-tracking-links-for-webinar-registration) for details."
},
{
"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": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.<br>\nUse this API to list all the users that have registered for a webinar.<br><br>\n**Prerequisites:**\n* Pro or higher plan with a Webinar Add-on.<br>\n**Scopes:** `webinar:read:admin` `webinar:read`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nWebinar plan subscription is missing. Enable webinar for this user once the subscription is added:{userId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=quis officia in reprehenderit&status=approved&tracking_source_id=quis officia in reprehenderit&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "status",
"value": "approved"
},
{
"key": "tracking_source_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": \"1\",\n \"page_number\": \"1\",\n \"page_size\": \"30\",\n \"total_records\": \"1\",\n \"registrants\": [\n {\n \"id\": \"24000002122\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Jill\",\n \"last_name\": \"Chill\",\n \"address\": \"1800 Amphibious Blvd.\",\n \"city\": \"Mountain View\",\n \"country\": \"US\",\n \"zip\": \"94045\",\n \"state\": \"CA\",\n \"phone\": \"5550100\",\n \"industry\": \"Food\",\n \"org\": \"Cooking Org\",\n \"job_title\": \"Chef\",\n \"purchasing_time_frame\": \"1-3 months\",\n \"role_in_purchase_process\": \"Influencer\",\n \"no_of_employees\": \"10\",\n \"comments\": \"Looking forward to the Webinar\",\n \"custom_questions\": [\n {\n \"title\": \"What do you hope to learn from this Webinar?\",\n \"value\": \"Look forward to learning how you come up with new recipes and what other services you offer.\"\n }\n ],\n \"status\": \"approved\",\n \"create_time\": \"2019-02-26T23:01:16.899Z\",\n \"join_url\": \"https://zoom.us/webinar/mywebinarissocooldighdghodghodg\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `300`<br>Invalid webinar ID.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=quis officia in reprehenderit&status=approved&tracking_source_id=quis officia in reprehenderit&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "status",
"value": "approved"
},
{
"key": "tracking_source_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=quis officia in reprehenderit&status=approved&tracking_source_id=quis officia in reprehenderit&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "status",
"value": "approved"
},
{
"key": "tracking_source_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nWebinar not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3001`<br>\nWebinar {webinarId} not found or has expired.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants?occurrence_id=quis officia in reprehenderit&status=approved&tracking_source_id=quis officia in reprehenderit&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "status",
"value": "approved"
},
{
"key": "tracking_source_id",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
