Chilkat Online Tools

Xojo / Zoom API / List meeting polls

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("anonymous","true")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/meetings/:meetingId/polls",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "total_records": 1,
//   "polls": [
//     {
//       "id": "YB33NcABCdg_g1AAAxTQ",
//       "title": "Meeting Usefulness",
//       "anonymous": false,
//       "poll_type": 2,
//       "status": "notstart",
//       "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

Dim id As String
Dim title As String
Dim anonymous As Boolean
Dim poll_type As Int32
Dim status As String
Dim j As Int32
Dim count_j As Int32
Dim name As String
Dim v_type As String
Dim answer_required As Boolean
Dim k As Int32
Dim count_k As Int32
Dim strVal As String

Dim total_records As Int32
total_records = jResp.IntOf("total_records")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("polls")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("polls[i].id")
    title = jResp.StringOf("polls[i].title")
    anonymous = jResp.BoolOf("polls[i].anonymous")
    poll_type = jResp.IntOf("polls[i].poll_type")
    status = jResp.StringOf("polls[i].status")
    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
        Wend
        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
        Wend
        j = j + 1
    Wend
    i = i + 1
Wend

Curl Command

curl -G -d "anonymous=true"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/polls

Postman Collection Item JSON

{
  "name": "List meeting polls",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/meetings/:meetingId/polls?anonymous=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "meetings",
        ":meetingId",
        "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": "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."
        }
      ]
    },
    "description": "Polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.<br><br>\n\n**Scopes**: `meeting:read:admin` `meeting:read`<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* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** <br>\nList polls of a Meeting  returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/polls?anonymous=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "polls"
          ],
          "query": [
            {
              "key": "anonymous",
              "value": "true"
            }
          ],
          "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."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"total_records\": 1,\n \"polls\": [\n  {\n   \"id\": \"YB33NcABCdg_g1AAAxTQ\",\n   \"title\": \"Meeting Usefulness\",\n   \"anonymous\": false,\n   \"poll_type\": 2,\n   \"status\": \"notstart\",\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  }\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?anonymous=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "polls"
          ],
          "query": [
            {
              "key": "anonymous",
              "value": "true"
            }
          ],
          "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."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**Error Code:** `404`\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?anonymous=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "polls"
          ],
          "query": [
            {
              "key": "anonymous",
              "value": "true"
            }
          ],
          "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."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}