unicodeC / Zoom API / Get webinar poll reports
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *name;
const wchar_t *email;
int j;
int count_j;
const wchar_t *question;
const wchar_t *answer;
int id;
const wchar_t *uuid;
const wchar_t *status;
const wchar_t *start_time;
const wchar_t *title;
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();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.zoom.us/v2/report/webinars/:webinarId/polls",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
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.
id = CkJsonObjectW_IntOf(jResp,L"id");
uuid = CkJsonObjectW_stringOf(jResp,L"uuid");
status = CkJsonObjectW_stringOf(jResp,L"status");
start_time = CkJsonObjectW_stringOf(jResp,L"start_time");
title = CkJsonObjectW_stringOf(jResp,L"title");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"questions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
name = CkJsonObjectW_stringOf(jResp,L"questions[i].name");
email = CkJsonObjectW_stringOf(jResp,L"questions[i].email");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"questions[i].question_details");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
question = CkJsonObjectW_stringOf(jResp,L"questions[i].question_details[j].question");
answer = CkJsonObjectW_stringOf(jResp,L"questions[i].question_details[j].answer");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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": ""
}
]
}
