Chilkat Online Tools

Swift3 / Zoom API / Get webinar Q&A report

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

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

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://api.zoom.us/v2/report/webinars/:webinarId/qa", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    // {
    //   "id": 14321,
    //   "uuid": "urgvhge945",
    //   "start_time": "2019-02-01T12:34:12.660Z",
    //   "questions": [
    //     {
    //       "name": "Harry S",
    //       "email": "example@example.com",
    //       "question_details": [
    //         {
    //           "question": "How often will you hold this webinar?",
    //           "answer": "Once a month."
    //         }
    //       ]
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var name: String?
    var email: String?
    var j: Int
    var count_j: Int
    var question: String?
    var answer: String?

    var id: Int = jResp.int(of: "id").intValue
    var uuid: String? = jResp.string(of: "uuid")
    var start_time: String? = jResp.string(of: "start_time")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "questions").intValue
    while i < count_i {
        jResp.i = i
        name = jResp.string(of: "questions[i].name")
        email = jResp.string(of: "questions[i].email")
        j = 0
        count_j = jResp.size(ofArray: "questions[i].question_details").intValue
        while j < count_j {
            jResp.j = j
            question = jResp.string(of: "questions[i].question_details[j].question")
            answer = jResp.string(of: "questions[i].question_details[j].answer")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/webinars/:webinarId/qa

Postman Collection Item JSON

{
  "name": "Get webinar Q&A report",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/report/webinars/:webinarId/qa",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "report",
        "webinars",
        ":webinarId",
        "qa"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
        }
      ]
    },
    "description": "The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions.\n\nUse this API to retrieve a report on question and answers from past webinars. <br><br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or a higher plan with Webinar add-on enabled."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nWebinar Q&A report returned.<br>\nThis is only available for paid account:{accountId}.<br>\nA report cannot be generated for this account because this account has not subscribed to a webinar plan.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId/qa",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId",
            "qa"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": 14321,\n \"uuid\": \"urgvhge945\",\n \"start_time\": \"2019-02-01T12:34:12.660Z\",\n \"questions\": [\n  {\n   \"name\": \"Harry S\",\n   \"email\": \"example@example.com\",\n   \"question_details\": [\n    {\n     \"question\": \"How often will you hold this webinar?\",\n     \"answer\": \"Once a month.\"\n    }\n   ]\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId/qa",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId",
            "qa"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nWebinar ID not found.<br>\n**Error Code:** `1001`<br>\nUser does not exist: {userId}.<br>\n**Error Code:** `3001`<br>\nWebinar  {webinarId} not found or has expired.<br>\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId/qa",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId",
            "qa"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}