TCL / Zoom API / Get a webinar survey
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.zoom.us/v2/webinars/:webinarId/survey" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set Anonymous [CkJsonObject_BoolOf $jResp "custom_survey.anonymous"]
set show_in_the_browser [CkJsonObject_BoolOf $jResp "show_in_the_browser"]
set show_in_the_follow_up_email [CkJsonObject_BoolOf $jResp "show_in_the_follow_up_email"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "custom_survey.questions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "custom_survey.questions[i].name"]
set v_type [CkJsonObject_stringOf $jResp "custom_survey.questions[i].type"]
set show_as_dropdown [CkJsonObject_BoolOf $jResp "custom_survey.questions[i].show_as_dropdown"]
set answer_required [CkJsonObject_BoolOf $jResp "custom_survey.questions[i].answer_required"]
set rating_min_value [CkJsonObject_IntOf $jResp "custom_survey.questions[i].rating_min_value"]
set rating_max_value [CkJsonObject_IntOf $jResp "custom_survey.questions[i].rating_max_value"]
set rating_min_label [CkJsonObject_stringOf $jResp "custom_survey.questions[i].rating_min_label"]
set rating_max_label [CkJsonObject_stringOf $jResp "custom_survey.questions[i].rating_max_label"]
set answer_min_character [CkJsonObject_IntOf $jResp "custom_survey.questions[i].answer_min_character"]
set answer_max_character [CkJsonObject_IntOf $jResp "custom_survey.questions[i].answer_max_character"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "custom_survey.questions[i].answers"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "custom_survey.questions[i].answers[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}
