autoit / Zoom API / Get a webinar survey
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.zoom.us/v2/webinars/:webinarId/survey",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "custom_survey": {
; "anonymous": true,
; "questions": [
; {
; "name": "Single Choice",
; "type": "single",
; "show_as_dropdown": false,
; "answer_required": false,
; "answers": [
; "option1",
; "option2",
; "option3"
; ]
; },
; {
; "name": "Multiple Choice",
; "type": "multiple",
; "answer_required": false,
; "answers": [
; "option1",
; "option2",
; "option3"
; ]
; },
; {
; "name": "Rating Scale",
; "type": "rating_scale",
; "answer_required": false,
; "rating_min_value": 0,
; "rating_max_value": 4,
; "rating_min_label": "Not likely",
; "rating_max_label": "Extremely Likely"
; },
; {
; "name": "Long Answer",
; "type": "long_answer",
; "answer_required": false,
; "answer_min_character": 1,
; "answer_max_character": 200
; }
; ]
; },
; "show_in_the_browser": true,
; "show_in_the_follow_up_email": false
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sName
Local $sV_type
Local $bShow_as_dropdown
Local $bAnswer_required
Local $iRating_min_value
Local $iRating_max_value
Local $sRating_min_label
Local $sRating_max_label
Local $iAnswer_min_character
Local $iAnswer_max_character
Local $iJ
Local $iCount_j
Local $strVal
Local $bAnonymous = $oJResp.BoolOf("custom_survey.anonymous")
Local $bShow_in_the_browser = $oJResp.BoolOf("show_in_the_browser")
Local $bShow_in_the_follow_up_email = $oJResp.BoolOf("show_in_the_follow_up_email")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("custom_survey.questions")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("custom_survey.questions[i].name")
$sV_type = $oJResp.StringOf("custom_survey.questions[i].type")
$bShow_as_dropdown = $oJResp.BoolOf("custom_survey.questions[i].show_as_dropdown")
$bAnswer_required = $oJResp.BoolOf("custom_survey.questions[i].answer_required")
$iRating_min_value = $oJResp.IntOf("custom_survey.questions[i].rating_min_value")
$iRating_max_value = $oJResp.IntOf("custom_survey.questions[i].rating_max_value")
$sRating_min_label = $oJResp.StringOf("custom_survey.questions[i].rating_min_label")
$sRating_max_label = $oJResp.StringOf("custom_survey.questions[i].rating_max_label")
$iAnswer_min_character = $oJResp.IntOf("custom_survey.questions[i].answer_min_character")
$iAnswer_max_character = $oJResp.IntOf("custom_survey.questions[i].answer_max_character")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("custom_survey.questions[i].answers")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("custom_survey.questions[i].answers[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId/survey
Postman Collection Item JSON
{
"name": "Get a webinar survey",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"survey"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Use this API to return information about a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651). \n\n **Scopes:** `webinar:read`, `webinar:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n **Prerequisites:** \n* A Pro or higher plan with the Webinar add-on. \n* The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account."
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\n Webinar survey object returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"survey"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_survey\": {\n \"anonymous\": true,\n \"questions\": [\n {\n \"name\": \"Single Choice\",\n \"type\": \"single\",\n \"show_as_dropdown\": false,\n \"answer_required\": false,\n \"answers\": [\n \"option1\",\n \"option2\",\n \"option3\"\n ]\n },\n {\n \"name\": \"Multiple Choice\",\n \"type\": \"multiple\",\n \"answer_required\": false,\n \"answers\": [\n \"option1\",\n \"option2\",\n \"option3\"\n ]\n },\n {\n \"name\": \"Rating Scale\",\n \"type\": \"rating_scale\",\n \"answer_required\": false,\n \"rating_min_value\": 0,\n \"rating_max_value\": 4,\n \"rating_min_label\": \"Not likely\",\n \"rating_max_label\": \"Extremely Likely\"\n },\n {\n \"name\": \"Long Answer\",\n \"type\": \"long_answer\",\n \"answer_required\": false,\n \"answer_min_character\": 1,\n \"answer_max_character\": 200\n }\n ]\n },\n \"show_in_the_browser\": true,\n \"show_in_the_follow_up_email\": false\n}"
},
{
"name": "**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n Invalid webinar ID. \n\n **Error Code:** `3000` <br>\n Webinar survey disabled. To enable this feature, enable the \"Webinar Survey\" setting in the Zoom web portal's \"Settings\" interf",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"survey"
],
"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> Not Found \n\n **Error Code:** `300` <br>\n Webinar ID does not exist. \n\n **Error Code:** `3001` <br>\n Webinar does not exist: {webinarId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"survey"
],
"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": ""
}
]
}
