C++ / Zoom API / Get webinar poll reports
Back to Collection Items
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://api.zoom.us/v2/report/webinars/:webinarId/polls",sbResponseBody);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = http.get_LastStatus();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << http.lastHeader() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": 123456,
// "uuid": "gsdjfhsdfkhjdsf",
// "status": "ended",
// "start_time": "2019-02-01T12:34:12.660Z",
// "title": "Learn something new",
// "questions": [
// {
// "name": "Sam S",
// "email": "example@example.com",
// "question_details": [
// {
// "question": "How are you?",
// "answer": "I am wonderful."
// }
// ]
// }
// ]
// }
// 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.
const char *name = 0;
const char *email = 0;
int j;
int count_j;
const char *question = 0;
const char *answer = 0;
int id = jResp.IntOf("id");
const char *uuid = jResp.stringOf("uuid");
const char *status = jResp.stringOf("status");
const char *start_time = jResp.stringOf("start_time");
const char *title = jResp.stringOf("title");
int i = 0;
int count_i = jResp.SizeOfArray("questions");
while (i < count_i) {
jResp.put_I(i);
name = jResp.stringOf("questions[i].name");
email = jResp.stringOf("questions[i].email");
j = 0;
count_j = jResp.SizeOfArray("questions[i].question_details");
while (j < count_j) {
jResp.put_J(j);
question = jResp.stringOf("questions[i].question_details[j].question");
answer = jResp.stringOf("questions[i].question_details[j].answer");
j = j + 1;
}
i = i + 1;
}
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/webinars/:webinarId/polls
Postman Collection Item JSON
{
"name": "Get webinar poll reports",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
}
]
},
"description": "Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).<br><br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or a higher plan with Webinar add-on enabled."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nWebinar polls report returned.<br>\nMissing webinar subscription plan.<br>\nThis is only available for paid account:{accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": 123456,\n \"uuid\": \"gsdjfhsdfkhjdsf\",\n \"status\": \"ended\",\n \"start_time\": \"2019-02-01T12:34:12.660Z\",\n \"title\": \"Learn something new\",\n \"questions\": [\n {\n \"name\": \"Sam S\",\n \"email\": \"example@example.com\",\n \"question_details\": [\n {\n \"question\": \"How are you?\",\n \"answer\": \"I am wonderful.\"\n }\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nWebinar ID not found.<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}}/report/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
