delphiAx / Zoom API / List a webinar's polls
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
v_type: WideString;
answer_required: Integer;
j: Integer;
count_j: Integer;
strVal: WideString;
id: WideString;
status: WideString;
title: WideString;
anonymous: Integer;
poll_type: 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 := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('anonymous','true');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.QuickRequestParams('GET','https://api.zoom.us/v2/webinars/:webinarId/polls',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "cdjfhdsdfd",
// "status": "ended",
// "title": "Learn something new",
// "anonymous": false,
// "poll_type": 2,
// "questions": [
// {
// "name": "How are you?",
// "type": "multiple",
// "answer_required": false,
// "answers": [
// "Good",
// "Not so good"
// ],
// "right_answers": [
// "Good"
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id := jResp.StringOf('id');
status := jResp.StringOf('status');
title := jResp.StringOf('title');
anonymous := jResp.BoolOf('anonymous');
poll_type := jResp.IntOf('poll_type');
i := 0;
count_i := jResp.SizeOfArray('questions');
while i < count_i do
begin
jResp.I := i;
name := jResp.StringOf('questions[i].name');
v_type := jResp.StringOf('questions[i].type');
answer_required := jResp.BoolOf('questions[i].answer_required');
j := 0;
count_j := jResp.SizeOfArray('questions[i].answers');
while j < count_j do
begin
jResp.J := j;
strVal := jResp.StringOf('questions[i].answers[j]');
j := j + 1;
end;
j := 0;
count_j := jResp.SizeOfArray('questions[i].right_answers');
while j < count_j do
begin
jResp.J := j;
strVal := jResp.StringOf('questions[i].right_answers[j]');
j := j + 1;
end;
i := i + 1;
end;
Curl Command
curl -G -d "anonymous=true"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId/polls
Postman Collection Item JSON
{
"name": "List a webinar's polls ",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls?anonymous=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"query": [
{
"key": "anonymous",
"value": "true",
"description": "Whether to query for polls with the **Anonymous** option enabled: \n* `true` — Query for polls with the **Anonymous** option enabled. \n* `false` — Do not query for polls with the **Anonymous** option enabled."
}
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "List all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.<br><br>\n**Scopes:** `webinar:read:admin` `webinar:read`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nList polls of a Webinar returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls?anonymous=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"query": [
{
"key": "anonymous",
"value": "true"
}
],
"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 \"id\": \"cdjfhdsdfd\",\n \"status\": \"ended\",\n \"title\": \"Learn something new\",\n \"anonymous\": false,\n \"poll_type\": 2,\n \"questions\": [\n {\n \"name\": \"How are you?\",\n \"type\": \"multiple\",\n \"answer_required\": false,\n \"answers\": [\n \"Good\",\n \"Not so good\"\n ],\n \"right_answers\": [\n \"Good\"\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Webinar polls disabled. To enable this feature, enable the \"Webinar Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls?anonymous=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"query": [
{
"key": "anonymous",
"value": "true"
}
],
"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>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls?anonymous=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"query": [
{
"key": "anonymous",
"value": "true"
}
],
"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": ""
}
]
}
