Foxpro / Zoom API / Get Zoom Room settings
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnUpcoming_meeting_alert
LOCAL lnShow_alert_before_meeting
LOCAL lnStart_airplay_manually
LOCAL lnWeekly_system_restart
LOCAL lnDisplay_meeting_list
LOCAL lnDisplay_top_banner
LOCAL lnDisplay_feedback_survey
LOCAL lnAuto_direct_sharing
LOCAL lnTransform_meeting_to_private
LOCAL lnHide_id_for_private_meeting
LOCAL lnAuto_start_scheduled_meeting
LOCAL lnAuto_stop_scheduled_meeting
LOCAL lnHide_share_instruction
LOCAL lnAudio_device_daily_auto_test
LOCAL lnSupport_join_3rd_party_meeting
LOCAL lnEncrypt_shared_screen_content
LOCAL lnAllow_multiple_content_sharing
LOCAL lnShow_non_video_participants
LOCAL lnShow_call_history_in_room
LOCAL lnShow_contact_list_on_controller
LOCAL lnCount_attendees_number_in_room
LOCAL lnSend_whiteboard_to_internal_contact_only
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("setting_type","meeting")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/:roomId/settings",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "zoom_rooms": {
* "upcoming_meeting_alert": true,
* "show_alert_before_meeting": false,
* "start_airplay_manually": true,
* "weekly_system_restart": false,
* "display_meeting_list": false,
* "display_top_banner": false,
* "display_feedback_survey": true,
* "auto_direct_sharing": false,
* "transform_meeting_to_private": false,
* "hide_id_for_private_meeting": false,
* "auto_start_scheduled_meeting": true,
* "auto_stop_scheduled_meeting": true,
* "hide_share_instruction": true,
* "audio_device_daily_auto_test": true,
* "support_join_3rd_party_meeting": true,
* "encrypt_shared_screen_content": false,
* "allow_multiple_content_sharing": true,
* "show_non_video_participants": false,
* "show_call_history_in_room": true,
* "show_contact_list_on_controller": true,
* "count_attendees_number_in_room": true,
* "send_whiteboard_to_internal_contact_only": true
* }
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnUpcoming_meeting_alert = loJResp.BoolOf("zoom_rooms.upcoming_meeting_alert")
lnShow_alert_before_meeting = loJResp.BoolOf("zoom_rooms.show_alert_before_meeting")
lnStart_airplay_manually = loJResp.BoolOf("zoom_rooms.start_airplay_manually")
lnWeekly_system_restart = loJResp.BoolOf("zoom_rooms.weekly_system_restart")
lnDisplay_meeting_list = loJResp.BoolOf("zoom_rooms.display_meeting_list")
lnDisplay_top_banner = loJResp.BoolOf("zoom_rooms.display_top_banner")
lnDisplay_feedback_survey = loJResp.BoolOf("zoom_rooms.display_feedback_survey")
lnAuto_direct_sharing = loJResp.BoolOf("zoom_rooms.auto_direct_sharing")
lnTransform_meeting_to_private = loJResp.BoolOf("zoom_rooms.transform_meeting_to_private")
lnHide_id_for_private_meeting = loJResp.BoolOf("zoom_rooms.hide_id_for_private_meeting")
lnAuto_start_scheduled_meeting = loJResp.BoolOf("zoom_rooms.auto_start_scheduled_meeting")
lnAuto_stop_scheduled_meeting = loJResp.BoolOf("zoom_rooms.auto_stop_scheduled_meeting")
lnHide_share_instruction = loJResp.BoolOf("zoom_rooms.hide_share_instruction")
lnAudio_device_daily_auto_test = loJResp.BoolOf("zoom_rooms.audio_device_daily_auto_test")
lnSupport_join_3rd_party_meeting = loJResp.BoolOf("zoom_rooms.support_join_3rd_party_meeting")
lnEncrypt_shared_screen_content = loJResp.BoolOf("zoom_rooms.encrypt_shared_screen_content")
lnAllow_multiple_content_sharing = loJResp.BoolOf("zoom_rooms.allow_multiple_content_sharing")
lnShow_non_video_participants = loJResp.BoolOf("zoom_rooms.show_non_video_participants")
lnShow_call_history_in_room = loJResp.BoolOf("zoom_rooms.show_call_history_in_room")
lnShow_contact_list_on_controller = loJResp.BoolOf("zoom_rooms.show_contact_list_on_controller")
lnCount_attendees_number_in_room = loJResp.BoolOf("zoom_rooms.count_attendees_number_in_room")
lnSend_whiteboard_to_internal_contact_only = loJResp.BoolOf("zoom_rooms.send_whiteboard_to_internal_contact_only")
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "setting_type=meeting"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/:roomId/settings
Postman Collection Item JSON
{
"name": "Get Zoom Room settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting",
"description": "(Required) The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br>\n`meeting`: Meeting settings of the Zoom Rooms Account."
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
},
"description": "Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:read:admin`\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br> "
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nZoom Room settings returned successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"zoom_rooms\": {\n \"upcoming_meeting_alert\": true,\n \"show_alert_before_meeting\": false,\n \"start_airplay_manually\": true,\n \"weekly_system_restart\": false,\n \"display_meeting_list\": false,\n \"display_top_banner\": false,\n \"display_feedback_survey\": true,\n \"auto_direct_sharing\": false,\n \"transform_meeting_to_private\": false,\n \"hide_id_for_private_meeting\": false,\n \"auto_start_scheduled_meeting\": true,\n \"auto_stop_scheduled_meeting\": true,\n \"hide_share_instruction\": true,\n \"audio_device_daily_auto_test\": true,\n \"support_join_3rd_party_meeting\": true,\n \"encrypt_shared_screen_content\": false,\n \"allow_multiple_content_sharing\": true,\n \"show_non_video_participants\": false,\n \"show_call_history_in_room\": true,\n \"show_contact_list_on_controller\": true,\n \"count_attendees_number_in_room\": true,\n \"send_whiteboard_to_internal_contact_only\": true\n }\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n\n**Error Code:** `1012`<br>\nRoom not found:{roomId}.\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
