Chilkat Online Tools

autoit / Zoom API / Update Zoom Room settings

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

$oReq = ObjCreate("Chilkat.HttpRequest")
$oReq.HttpVerb = "PATCH"
$oReq.Path = "/"
$oReq.ContentType = "multipart/form-data"

$oJsonFormData1 = ObjCreate("Chilkat.JsonObject")
$oJsonFormData1.UpdateBool("upcoming_meeting_alert",True)
$oJsonFormData1.UpdateBool("show_alert_before_meeting",True)
$oJsonFormData1.UpdateBool("start_airplay_mirroring",True)
$oJsonFormData1.UpdateBool("start_airplay_manually",True)
$oJsonFormData1.UpdateBool("weekly_system_restart",False)
$oJsonFormData1.UpdateBool("display_meeting_list",False)
$oJsonFormData1.UpdateBool("display_top_banner",True)
$oJsonFormData1.UpdateBool("display_feedback_survey",True)
$oJsonFormData1.UpdateBool("auto_direct_sharing",True)
$oJsonFormData1.UpdateBool("transform_meeting_to_private",True)
$oJsonFormData1.UpdateBool("hide_id_for_private_meeting",False)
$oJsonFormData1.UpdateBool("auto_start_scheduled_meeting",True)
$oJsonFormData1.UpdateBool("auto_stop_scheduled_meeting",False)
$oJsonFormData1.UpdateBool("hide_share_instruction",False)
$oJsonFormData1.UpdateBool("audio_device_daily_auto_test",False)
$oJsonFormData1.UpdateBool("support_join_3rd_party_meeting",False)
$oJsonFormData1.UpdateBool("encrypt_shared_screen_content",False)
$oJsonFormData1.UpdateBool("allow_multiple_content_sharing",True)
$oJsonFormData1.UpdateBool("show_non_video_participants",True)
$oJsonFormData1.UpdateBool("show_call_history_in_room",False)
$oJsonFormData1.UpdateBool("show_contact_list_on_controller",True)
$oJsonFormData1.UpdateBool("count_attendees_number_in_room",True)
$oJsonFormData1.UpdateBool("send_whiteboard_to_internal_contact_only",False)
$oReq.AddStringForUpload2("zoom_rooms","",$oJsonFormData1,"utf-8","application/json")

$oJsonFormData2 = ObjCreate("Chilkat.JsonObject")
$oJsonFormData2.UpdateBool("upcoming_meeting_alert",True)
$oJsonFormData2.UpdateBool("show_alert_before_meeting",True)
$oJsonFormData2.UpdateBool("start_airplay_mirroring",True)
$oJsonFormData2.UpdateBool("start_airplay_manually",True)
$oJsonFormData2.UpdateBool("weekly_system_restart",False)
$oJsonFormData2.UpdateBool("display_meeting_list",False)
$oJsonFormData2.UpdateBool("display_top_banner",True)
$oJsonFormData2.UpdateBool("display_feedback_survey",True)
$oJsonFormData2.UpdateBool("auto_direct_sharing",True)
$oJsonFormData2.UpdateBool("transform_meeting_to_private",True)
$oJsonFormData2.UpdateBool("hide_id_for_private_meeting",False)
$oJsonFormData2.UpdateBool("auto_start_scheduled_meeting",True)
$oJsonFormData2.UpdateBool("auto_stop_scheduled_meeting",False)
$oJsonFormData2.UpdateBool("hide_share_instruction",False)
$oJsonFormData2.UpdateBool("audio_device_daily_auto_test",False)
$oJsonFormData2.UpdateBool("support_join_3rd_party_meeting",False)
$oJsonFormData2.UpdateBool("encrypt_shared_screen_content",False)
$oJsonFormData2.UpdateBool("allow_multiple_content_sharing",True)
$oJsonFormData2.UpdateBool("show_non_video_participants",True)
$oJsonFormData2.UpdateBool("show_call_history_in_room",False)
$oJsonFormData2.UpdateBool("show_contact_list_on_controller",True)
$oJsonFormData2.UpdateBool("count_attendees_number_in_room",True)
$oJsonFormData2.UpdateBool("send_whiteboard_to_internal_contact_only",False)
$oReq.AddStringForUpload2("meeting_security","",$oJsonFormData2,"utf-8","application/json")

$oReq.AddHeader "Authorization","Bearer <access_token>"

Local $oResp = $oHttp.SynchronousRequest("reprehenderit",80,False,$oReq)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'zoom_rooms={"upcoming_meeting_alert":true,"show_alert_before_meeting":true,"start_airplay_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":false,"display_meeting_list":false,"display_top_banner":true,"display_feedback_survey":true,"auto_direct_sharing":true,"transform_meeting_to_private":true,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":true,"auto_stop_scheduled_meeting":false,"hide_share_instruction":false,"audio_device_daily_auto_test":false,"support_join_3rd_party_meeting":false,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":true,"show_non_video_participants":true,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":true,"send_whiteboard_to_internal_contact_only":false}'
	--form 'meeting_security={"upcoming_meeting_alert":true,"show_alert_before_meeting":true,"start_airplay_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":false,"display_meeting_list":false,"display_top_banner":true,"display_feedback_survey":true,"auto_direct_sharing":true,"transform_meeting_to_private":true,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":true,"auto_stop_scheduled_meeting":false,"hide_share_instruction":false,"audio_device_daily_auto_test":false,"support_join_3rd_party_meeting":false,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":true,"show_non_video_participants":true,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":true,"send_whiteboard_to_internal_contact_only":false}{"end_to_end_encrypted_meetings":true,"encryption_type":"enhanced_encryption"}'
https://api.zoom.us/v2/rooms/:roomId/settings?setting_type=quis officia in reprehenderit

Postman Collection Item JSON

{
  "name": "Update Zoom Room settings",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "zoom_rooms",
          "value": "{\"upcoming_meeting_alert\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
          "type": "text"
        },
        {
          "key": "meeting_security",
          "value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "rooms",
        ":roomId",
        "settings"
      ],
      "query": [
        {
          "key": "setting_type",
          "value": "quis officia in reprehenderit",
          "description": "The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Room.<br>\n`meeting`: Meeting settings of the Zoom Room.<br>\n`signage`: Digital signage settings applied on the Zoom Room."
        }
      ],
      "variable": [
        {
          "key": "roomId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique Identifier of the Zoom Room."
        }
      ]
    },
    "description": "Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**, specify `meeting` 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:write:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204` **No Content**<br>\nSettings updated successfully. ",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "zoom_rooms",
              "value": "{\"upcoming_meeting_alert\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
              "type": "text"
            },
            {
              "key": "meeting_security",
              "value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            ":roomId",
            "settings"
          ],
          "query": [
            {
              "key": "setting_type",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "roomId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique Identifier of the Zoom Room."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "name": "**HTTP Status Code:** `400` **Bad Request**<br><br>\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "zoom_rooms",
              "value": "{\"upcoming_meeting_alert\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
              "type": "text"
            },
            {
              "key": "meeting_security",
              "value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            ":roomId",
            "settings"
          ],
          "query": [
            {
              "key": "setting_type",
              "value": "quis officia in reprehenderit"
            }
          ],
          "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": ""
    }
  ]
}