phpExt / Zoom API / Create a webinar's poll
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$req = new CkHttpRequest();
$req->put_HttpVerb('POST');
$req->put_Path('/v2/webinars/:webinarId/polls');
$req->put_ContentType('multipart/form-data');
$req->AddParam('title','a');
$req->AddParam('poll_type','a3');
$req->AddParam('anonymous','a3false');
$req->AddParam('questions','a3false[{\'name\':\'ad in ullamco elit\',\'type\':\'rating_scale\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'in \',\'do sint ipsum\'],\'right_answers\':[\'deserunt id\'],\'prompts\':[{\'prompt_question\':\'sint ipsum irure\',\'prompt_right_answers\':[\'sit officia\',\'irure est nostrud nul\']},{\'prompt_question\':\'qui\',\'prompt_right_answers\':[\'veniam\',\'voluptate reprehenderit irure\']}],\'answer_min_character\':29173071,\'answer_max_character\':27567154,\'case_sensitive\':false,\'rating_min_value\':58887175,\'rating_max_value\':-45787201,\'rating_min_label\':\'ea commodo\',\'rating_max_label\':\'ipsum dolore\'},{\'name\':\'ut eiusmod adipisicing exercitation\',\'type\':\'single\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'Excepteur Ut\',\'exercitation voluptate\'],\'right_answers\':[\'occaecat do esse\'],\'prompts\':[{\'prompt_question\':\'laboris eiusmod commodo ipsum ut\',\'prompt_right_answers\':[\'ut Lorem dolor do\',\'ullamco cillum tempor pariatur\']},{\'prompt_question\':\'officia l\',\'prompt_right_answers\':[\'nulla pariatur\',\'voluptate aliqua sint\']}],\'answer_min_character\':68878731,\'answer_max_character\':-60270992,\'case_sensitive\':false,\'rating_min_value\':61727066,\'rating_max_value\':-36610809,\'rating_min_label\':\'in ut\',\'rating_max_label\':\'proident officia\'}]');
$req->AddHeader('Authorization','Bearer <access_token>');
// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('api.zoom.us',443,true,$req);
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)
// {
// "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) {
$jResp->put_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) {
$jResp->put_J($j);
$strVal = $jResp->stringOf('questions[i].answers[j]');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('questions[i].right_answers');
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf('questions[i].right_answers[j]');
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'title=a'
--form 'poll_type=a3'
--form 'anonymous=a3false'
--form 'questions=a3false[{"name":"ad in ullamco elit","type":"rating_scale","show_as_dropdown":false,"answer_required":false,"answers":["in ","do sint ipsum"],"right_answers":["deserunt id"],"prompts":[{"prompt_question":"sint ipsum irure","prompt_right_answers":["sit officia","irure est nostrud nul"]},{"prompt_question":"qui","prompt_right_answers":["veniam","voluptate reprehenderit irure"]}],"answer_min_character":29173071,"answer_max_character":27567154,"case_sensitive":false,"rating_min_value":58887175,"rating_max_value":-45787201,"rating_min_label":"ea commodo","rating_max_label":"ipsum dolore"},{"name":"ut eiusmod adipisicing exercitation","type":"single","show_as_dropdown":false,"answer_required":false,"answers":["Excepteur Ut","exercitation voluptate"],"right_answers":["occaecat do esse"],"prompts":[{"prompt_question":"laboris eiusmod commodo ipsum ut","prompt_right_answers":["ut Lorem dolor do","ullamco cillum tempor pariatur"]},{"prompt_question":"officia l","prompt_right_answers":["nulla pariatur","voluptate aliqua sint"]}],"answer_min_character":68878731,"answer_max_character":-60270992,"case_sensitive":false,"rating_min_value":61727066,"rating_max_value":-36610809,"rating_min_label":"in ut","rating_max_label":"proident officia"}]'
https://api.zoom.us/v2/webinars/:webinarId/polls
Postman Collection Item JSON
{
"name": "Create a webinar's poll",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "title",
"value": "a",
"description": "undefined",
"type": "text"
},
{
"key": "poll_type",
"value": "3",
"description": "undefined",
"type": "text"
},
{
"key": "anonymous",
"value": "false",
"description": "undefined",
"type": "text"
},
{
"key": "questions",
"value": "[{\"name\":\"ad in ullamco elit\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"in \",\"do sint ipsum\"],\"right_answers\":[\"deserunt id\"],\"prompts\":[{\"prompt_question\":\"sint ipsum irure\",\"prompt_right_answers\":[\"sit officia\",\"irure est nostrud nul\"]},{\"prompt_question\":\"qui\",\"prompt_right_answers\":[\"veniam\",\"voluptate reprehenderit irure\"]}],\"answer_min_character\":29173071,\"answer_max_character\":27567154,\"case_sensitive\":false,\"rating_min_value\":58887175,\"rating_max_value\":-45787201,\"rating_min_label\":\"ea commodo\",\"rating_max_label\":\"ipsum dolore\"},{\"name\":\"ut eiusmod adipisicing exercitation\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"Excepteur Ut\",\"exercitation voluptate\"],\"right_answers\":[\"occaecat do esse\"],\"prompts\":[{\"prompt_question\":\"laboris eiusmod commodo ipsum ut\",\"prompt_right_answers\":[\"ut Lorem dolor do\",\"ullamco cillum tempor pariatur\"]},{\"prompt_question\":\"officia l\",\"prompt_right_answers\":[\"nulla pariatur\",\"voluptate aliqua sint\"]}],\"answer_min_character\":68878731,\"answer_max_character\":-60270992,\"case_sensitive\":false,\"rating_min_value\":61727066,\"rating_max_value\":-36610809,\"rating_min_label\":\"in ut\",\"rating_max_label\":\"proident officia\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.<br><br>\n**Scopes:** `webinar:write:admin` `webinar:write`<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:** `201`<br>\nWebinar Poll Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "title",
"value": "fugiat exercitation proident magna ullamco",
"description": "undefined",
"type": "text"
},
{
"key": "poll_type",
"value": "1",
"description": "undefined",
"type": "text"
},
{
"key": "anonymous",
"value": "false",
"description": "undefined",
"type": "text"
},
{
"key": "questions",
"value": "[{\"name\":\"irure ex velit consectetur\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"commodo in in ad\",\"do officia dolore eu\"],\"right_answers\":[\"laborum officia\"],\"prompts\":[{\"prompt_question\":\"minim in mollit\",\"prompt_right_answers\":[\"in cillum amet\",\"cupida\"]},{\"prompt_question\":\"eiusmod culpa\",\"prompt_right_answers\":[\"irure fugiat\",\"eiusmod et occaecat magna sed\"]}],\"answer_min_character\":93145901,\"answer_max_character\":91006906,\"case_sensitive\":false,\"rating_min_value\":37530130,\"rating_max_value\":-38740448,\"rating_min_label\":\"quis non proident Duis\",\"rating_max_label\":\"irure pariatur nisi\"},{\"name\":\"labore cillum\",\"type\":\"rank_order\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"in aliqua cillum\",\"irure fugiat qui et\"],\"right_answers\":[\"dolor in u\"],\"prompts\":[{\"prompt_question\":\"occaecat reprehenderit\",\"prompt_right_answers\":[\"reprehenderit deserunt\",\"c\"]},{\"prompt_question\":\"occaecat velit\",\"prompt_right_answers\":[\"ut mollit eu ipsum\",\"qui et tempor aute\"]}],\"answer_min_character\":72197843,\"answer_max_character\":-2000739,\"case_sensitive\":false,\"rating_min_value\":25766114,\"rating_max_value\":-12152537,\"rating_min_label\":\"adipisicing mollit in et\",\"rating_max_label\":\"Lorem magna non id\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of created Webinar Poll"
},
{
"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:** `300`<br>Invalid webinarId.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "title",
"value": "fugiat exercitation proident magna ullamco",
"description": "undefined",
"type": "text"
},
{
"key": "poll_type",
"value": "1",
"description": "undefined",
"type": "text"
},
{
"key": "anonymous",
"value": "false",
"description": "undefined",
"type": "text"
},
{
"key": "questions",
"value": "[{\"name\":\"irure ex velit consectetur\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"commodo in in ad\",\"do officia dolore eu\"],\"right_answers\":[\"laborum officia\"],\"prompts\":[{\"prompt_question\":\"minim in mollit\",\"prompt_right_answers\":[\"in cillum amet\",\"cupida\"]},{\"prompt_question\":\"eiusmod culpa\",\"prompt_right_answers\":[\"irure fugiat\",\"eiusmod et occaecat magna sed\"]}],\"answer_min_character\":93145901,\"answer_max_character\":91006906,\"case_sensitive\":false,\"rating_min_value\":37530130,\"rating_max_value\":-38740448,\"rating_min_label\":\"quis non proident Duis\",\"rating_max_label\":\"irure pariatur nisi\"},{\"name\":\"labore cillum\",\"type\":\"rank_order\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"in aliqua cillum\",\"irure fugiat qui et\"],\"right_answers\":[\"dolor in u\"],\"prompts\":[{\"prompt_question\":\"occaecat reprehenderit\",\"prompt_right_answers\":[\"reprehenderit deserunt\",\"c\"]},{\"prompt_question\":\"occaecat velit\",\"prompt_right_answers\":[\"ut mollit eu ipsum\",\"qui et tempor aute\"]}],\"answer_min_character\":72197843,\"answer_max_character\":-2000739,\"case_sensitive\":false,\"rating_min_value\":25766114,\"rating_max_value\":-12152537,\"rating_min_label\":\"adipisicing mollit in et\",\"rating_max_label\":\"Lorem magna non id\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"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` **Bad Request** <br>\n **Error Code:** `4400` <br>\n* Webinar polls disabled. To enable this feature, enable the \"Webinar Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n* Advanced webinar polls disabled. T",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "title",
"value": "fugiat exercitation proident magna ullamco",
"description": "undefined",
"type": "text"
},
{
"key": "poll_type",
"value": "1",
"description": "undefined",
"type": "text"
},
{
"key": "anonymous",
"value": "false",
"description": "undefined",
"type": "text"
},
{
"key": "questions",
"value": "[{\"name\":\"irure ex velit consectetur\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"commodo in in ad\",\"do officia dolore eu\"],\"right_answers\":[\"laborum officia\"],\"prompts\":[{\"prompt_question\":\"minim in mollit\",\"prompt_right_answers\":[\"in cillum amet\",\"cupida\"]},{\"prompt_question\":\"eiusmod culpa\",\"prompt_right_answers\":[\"irure fugiat\",\"eiusmod et occaecat magna sed\"]}],\"answer_min_character\":93145901,\"answer_max_character\":91006906,\"case_sensitive\":false,\"rating_min_value\":37530130,\"rating_max_value\":-38740448,\"rating_min_label\":\"quis non proident Duis\",\"rating_max_label\":\"irure pariatur nisi\"},{\"name\":\"labore cillum\",\"type\":\"rank_order\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"in aliqua cillum\",\"irure fugiat qui et\"],\"right_answers\":[\"dolor in u\"],\"prompts\":[{\"prompt_question\":\"occaecat reprehenderit\",\"prompt_right_answers\":[\"reprehenderit deserunt\",\"c\"]},{\"prompt_question\":\"occaecat velit\",\"prompt_right_answers\":[\"ut mollit eu ipsum\",\"qui et tempor aute\"]}],\"answer_min_character\":72197843,\"answer_max_character\":-2000739,\"case_sensitive\":false,\"rating_min_value\":25766114,\"rating_max_value\":-12152537,\"rating_min_label\":\"adipisicing mollit in et\",\"rating_max_label\":\"Lorem magna non id\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"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": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "title",
"value": "fugiat exercitation proident magna ullamco",
"description": "undefined",
"type": "text"
},
{
"key": "poll_type",
"value": "1",
"description": "undefined",
"type": "text"
},
{
"key": "anonymous",
"value": "false",
"description": "undefined",
"type": "text"
},
{
"key": "questions",
"value": "[{\"name\":\"irure ex velit consectetur\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"commodo in in ad\",\"do officia dolore eu\"],\"right_answers\":[\"laborum officia\"],\"prompts\":[{\"prompt_question\":\"minim in mollit\",\"prompt_right_answers\":[\"in cillum amet\",\"cupida\"]},{\"prompt_question\":\"eiusmod culpa\",\"prompt_right_answers\":[\"irure fugiat\",\"eiusmod et occaecat magna sed\"]}],\"answer_min_character\":93145901,\"answer_max_character\":91006906,\"case_sensitive\":false,\"rating_min_value\":37530130,\"rating_max_value\":-38740448,\"rating_min_label\":\"quis non proident Duis\",\"rating_max_label\":\"irure pariatur nisi\"},{\"name\":\"labore cillum\",\"type\":\"rank_order\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"in aliqua cillum\",\"irure fugiat qui et\"],\"right_answers\":[\"dolor in u\"],\"prompts\":[{\"prompt_question\":\"occaecat reprehenderit\",\"prompt_right_answers\":[\"reprehenderit deserunt\",\"c\"]},{\"prompt_question\":\"occaecat velit\",\"prompt_right_answers\":[\"ut mollit eu ipsum\",\"qui et tempor aute\"]}],\"answer_min_character\":72197843,\"answer_max_character\":-2000739,\"case_sensitive\":false,\"rating_min_value\":25766114,\"rating_max_value\":-12152537,\"rating_min_label\":\"adipisicing mollit in et\",\"rating_max_label\":\"Lorem magna non id\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/polls",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"polls"
],
"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": ""
}
]
}
