Chilkat Online Tools

PureBasic / Zoom API / Perform batch poll creation

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckQuickRequest(http,"POST","https://api.zoom.us/v2/meetings/:meetingId/batch_polls")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; 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

    id.s
    title.s
    status.s
    anonymous.i
    poll_type.i
    j.i
    count_j.i
    name.s
    v_type.s
    answer_required.i
    k.i
    count_k.i
    strVal.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"polls")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"polls[i].id")
        title = CkJsonObject::ckStringOf(jResp,"polls[i].title")
        status = CkJsonObject::ckStringOf(jResp,"polls[i].status")
        anonymous = CkJsonObject::ckBoolOf(jResp,"polls[i].anonymous")
        poll_type = CkJsonObject::ckIntOf(jResp,"polls[i].poll_type")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"polls[i].questions")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            name = CkJsonObject::ckStringOf(jResp,"polls[i].questions[j].name")
            v_type = CkJsonObject::ckStringOf(jResp,"polls[i].questions[j].type")
            answer_required = CkJsonObject::ckBoolOf(jResp,"polls[i].questions[j].answer_required")
            k = 0
            count_k = CkJsonObject::ckSizeOfArray(jResp,"polls[i].questions[j].answers")
            While k < count_k
                CkJsonObject::setCkK(jResp, k)
                strVal = CkJsonObject::ckStringOf(jResp,"polls[i].questions[j].answers[k]")
                k = k + 1
            Wend
            k = 0
            count_k = CkJsonObject::ckSizeOfArray(jResp,"polls[i].questions[j].right_answers")
            While k < count_k
                CkJsonObject::setCkK(jResp, k)
                strVal = CkJsonObject::ckStringOf(jResp,"polls[i].questions[j].right_answers[k]")
                k = k + 1
            Wend
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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": ""
    }
  ]
}