Ruby / Zoom API / Get a meeting poll
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.zoom.us/v2/meetings/:meetingId/polls/:pollId",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "abcdaaaeefffhhh",
# "status": "notstart",
# "title": "Meeting Usefulness",
# "anonymous": false,
# "poll_type": 2,
# "questions": [
# {
# "name": "How useful was this meeting?",
# "type": "multiple",
# "answer_required": false,
# "answers": [
# "Extremely useful",
# "Somewhat useful",
# "Not useful at all"
# ],
# "right_answers": [
# "Not useful at all"
# ]
# }
# ]
# }
# 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
end
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
end
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/polls/:pollId
Postman Collection Item JSON
{
"name": "Get a meeting poll",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/polls/:pollId",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"polls",
":pollId"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
},
{
"key": "pollId",
"value": "quis officia in reprehenderit",
"description": "(Required) The poll ID"
}
]
},
"description": "Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br><br>\n**Scopes**: `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\nMeeting Poll object returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/polls/:pollId",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"polls",
":pollId"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
},
{
"key": "pollId",
"value": "quis officia in reprehenderit",
"description": "(Required) The poll ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"abcdaaaeefffhhh\",\n \"status\": \"notstart\",\n \"title\": \"Meeting Usefulness\",\n \"anonymous\": false,\n \"poll_type\": 2,\n \"questions\": [\n {\n \"name\": \"How useful was this meeting?\",\n \"type\": \"multiple\",\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}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Meeting polls disabled. To enable this feature, enable the \"Meeting 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}}/meetings/:meetingId/polls/:pollId",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"polls",
":pollId"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
},
{
"key": "pollId",
"value": "quis officia in reprehenderit",
"description": "(Required) The poll ID"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**Error Code:** `404` <br>\nMeeting Poll not found.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/polls/:pollId",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"polls",
":pollId"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
},
{
"key": "pollId",
"value": "quis officia in reprehenderit",
"description": "(Required) The poll ID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
