phpAx / Zoom API / Perform batch poll creation
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('POST','https://api.zoom.us/v2/meetings/:meetingId/batch_polls');
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->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)
// {
// "polls": [
// {
// "id": "ex eiusmod",
// "title": "Meeting Usefulness",
// "status": "Excepteur Lorem dolor exercitation",
// "anonymous": false,
// "poll_type": 2,
// "questions": [
// {
// "name": "How useful was this meeting?",
// "type": "single",
// "answer_required": false,
// "answers": [
// "Extremely useful",
// "Somewhat useful",
// "Not useful at all"
// ],
// "right_answers": [
// "Not useful at all"
// ]
// }
// ]
// },
// {
// "id": "mollit do",
// "title": "Learn something new",
// "status": "ended",
// "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
$i = 0;
$count_i = $jResp->SizeOfArray('polls');
while ($i < $count_i) {
$jResp->I = $i;
$id = $jResp->stringOf('polls[i].id');
$title = $jResp->stringOf('polls[i].title');
$status = $jResp->stringOf('polls[i].status');
$anonymous = $jResp->BoolOf('polls[i].anonymous');
$poll_type = $jResp->IntOf('polls[i].poll_type');
$j = 0;
$count_j = $jResp->SizeOfArray('polls[i].questions');
while ($j < $count_j) {
$jResp->J = $j;
$name = $jResp->stringOf('polls[i].questions[j].name');
$v_type = $jResp->stringOf('polls[i].questions[j].type');
$answer_required = $jResp->BoolOf('polls[i].questions[j].answer_required');
$k = 0;
$count_k = $jResp->SizeOfArray('polls[i].questions[j].answers');
while ($k < $count_k) {
$jResp->K = $k;
$strVal = $jResp->stringOf('polls[i].questions[j].answers[k]');
$k = $k + 1;
}
$k = 0;
$count_k = $jResp->SizeOfArray('polls[i].questions[j].right_answers');
while ($k < $count_k) {
$jResp->K = $k;
$strVal = $jResp->stringOf('polls[i].questions[j].right_answers[k]');
$k = $k + 1;
}
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/batch_polls
Postman Collection Item JSON
{
"name": "Perform batch poll creation",
"request": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/batch_polls",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"batch_polls"
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) "
}
]
},
"description": "Polls allow the meeting host to survey attendees. Use this API to create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>\n\n**Scopes**: `meeting:write:admin` `meeting:write`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>\n**Prerequisites**:<br>\n* Host user type must be **Pro** or higher plan.\n* Polling feature must be enabled in the host's account.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled."
},
"response": [
{
"name": "**HTTP Status Code:** `201` <br>\nMeeting Poll Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/batch_polls",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"batch_polls"
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) "
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"polls\": [\n {\n \"id\": \"ex eiusmod\",\n \"title\": \"Meeting Usefulness\",\n \"status\": \"Excepteur Lorem dolor exercitation\",\n \"anonymous\": false,\n \"poll_type\": 2,\n \"questions\": [\n {\n \"name\": \"How useful was this meeting?\",\n \"type\": \"single\",\n \"answer_required\": false,\n \"answers\": [\n \"Extremely useful\",\n \"Somewhat useful\",\n \"Not useful at all\"\n ],\n \"right_answers\": [\n \"Not useful at all\"\n ]\n }\n ]\n },\n {\n \"id\": \"mollit do\",\n \"title\": \"Learn something new\",\n \"status\": \"ended\",\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 }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `300` <br>\nInvalid Meeting ID.\n**Error Code:** `300` <br>\nMeeting id does not exist.\n**Error Code:** `3000` <br>\nCannot access meeting information.\n**Error Code:** `3001`<br>\nMeeting does not ",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/batch_polls",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"batch_polls"
],
"variable": [
{
"key": "meetingId",
"value": "quis officia in reprehenderit",
"description": "(Required) "
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
