DataFlex / Zoom API / Get Zoom Room settings
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Boolean iUpcoming_meeting_alert
Boolean iShow_alert_before_meeting
Boolean iStart_airplay_manually
Boolean iWeekly_system_restart
Boolean iDisplay_meeting_list
Boolean iDisplay_top_banner
Boolean iDisplay_feedback_survey
Boolean iAuto_direct_sharing
Boolean iTransform_meeting_to_private
Boolean iHide_id_for_private_meeting
Boolean iAuto_start_scheduled_meeting
Boolean iAuto_stop_scheduled_meeting
Boolean iHide_share_instruction
Boolean iAudio_device_daily_auto_test
Boolean iSupport_join_3rd_party_meeting
Boolean iEncrypt_shared_screen_content
Boolean iAllow_multiple_content_sharing
Boolean iShow_non_video_participants
Boolean iShow_call_history_in_room
Boolean iShow_contact_list_on_controller
Boolean iCount_attendees_number_in_room
Boolean iSend_whiteboard_to_internal_contact_only
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "setting_type" "meeting" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/rooms/:roomId/settings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComBoolOf Of hoJResp "zoom_rooms.upcoming_meeting_alert" To iUpcoming_meeting_alert
Get ComBoolOf Of hoJResp "zoom_rooms.show_alert_before_meeting" To iShow_alert_before_meeting
Get ComBoolOf Of hoJResp "zoom_rooms.start_airplay_manually" To iStart_airplay_manually
Get ComBoolOf Of hoJResp "zoom_rooms.weekly_system_restart" To iWeekly_system_restart
Get ComBoolOf Of hoJResp "zoom_rooms.display_meeting_list" To iDisplay_meeting_list
Get ComBoolOf Of hoJResp "zoom_rooms.display_top_banner" To iDisplay_top_banner
Get ComBoolOf Of hoJResp "zoom_rooms.display_feedback_survey" To iDisplay_feedback_survey
Get ComBoolOf Of hoJResp "zoom_rooms.auto_direct_sharing" To iAuto_direct_sharing
Get ComBoolOf Of hoJResp "zoom_rooms.transform_meeting_to_private" To iTransform_meeting_to_private
Get ComBoolOf Of hoJResp "zoom_rooms.hide_id_for_private_meeting" To iHide_id_for_private_meeting
Get ComBoolOf Of hoJResp "zoom_rooms.auto_start_scheduled_meeting" To iAuto_start_scheduled_meeting
Get ComBoolOf Of hoJResp "zoom_rooms.auto_stop_scheduled_meeting" To iAuto_stop_scheduled_meeting
Get ComBoolOf Of hoJResp "zoom_rooms.hide_share_instruction" To iHide_share_instruction
Get ComBoolOf Of hoJResp "zoom_rooms.audio_device_daily_auto_test" To iAudio_device_daily_auto_test
Get ComBoolOf Of hoJResp "zoom_rooms.support_join_3rd_party_meeting" To iSupport_join_3rd_party_meeting
Get ComBoolOf Of hoJResp "zoom_rooms.encrypt_shared_screen_content" To iEncrypt_shared_screen_content
Get ComBoolOf Of hoJResp "zoom_rooms.allow_multiple_content_sharing" To iAllow_multiple_content_sharing
Get ComBoolOf Of hoJResp "zoom_rooms.show_non_video_participants" To iShow_non_video_participants
Get ComBoolOf Of hoJResp "zoom_rooms.show_call_history_in_room" To iShow_call_history_in_room
Get ComBoolOf Of hoJResp "zoom_rooms.show_contact_list_on_controller" To iShow_contact_list_on_controller
Get ComBoolOf Of hoJResp "zoom_rooms.count_attendees_number_in_room" To iCount_attendees_number_in_room
Get ComBoolOf Of hoJResp "zoom_rooms.send_whiteboard_to_internal_contact_only" To iSend_whiteboard_to_internal_contact_only
End_Procedure
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": ""
}
]
}
