Objective-C / Zoom API / Update Zoom Room settings
Back to Collection Items
#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"PATCH";
req.Path = @"/";
req.ContentType = @"multipart/form-data";
CkoJsonObject *jsonFormData1 = [[CkoJsonObject alloc] init];
[jsonFormData1 UpdateBool: @"upcoming_meeting_alert" value: YES];
[jsonFormData1 UpdateBool: @"show_alert_before_meeting" value: YES];
[jsonFormData1 UpdateBool: @"start_airplay_mirroring" value: YES];
[jsonFormData1 UpdateBool: @"start_airplay_manually" value: YES];
[jsonFormData1 UpdateBool: @"weekly_system_restart" value: NO];
[jsonFormData1 UpdateBool: @"display_meeting_list" value: NO];
[jsonFormData1 UpdateBool: @"display_top_banner" value: YES];
[jsonFormData1 UpdateBool: @"display_feedback_survey" value: YES];
[jsonFormData1 UpdateBool: @"auto_direct_sharing" value: YES];
[jsonFormData1 UpdateBool: @"transform_meeting_to_private" value: YES];
[jsonFormData1 UpdateBool: @"hide_id_for_private_meeting" value: NO];
[jsonFormData1 UpdateBool: @"auto_start_scheduled_meeting" value: YES];
[jsonFormData1 UpdateBool: @"auto_stop_scheduled_meeting" value: NO];
[jsonFormData1 UpdateBool: @"hide_share_instruction" value: NO];
[jsonFormData1 UpdateBool: @"audio_device_daily_auto_test" value: NO];
[jsonFormData1 UpdateBool: @"support_join_3rd_party_meeting" value: NO];
[jsonFormData1 UpdateBool: @"encrypt_shared_screen_content" value: NO];
[jsonFormData1 UpdateBool: @"allow_multiple_content_sharing" value: YES];
[jsonFormData1 UpdateBool: @"show_non_video_participants" value: YES];
[jsonFormData1 UpdateBool: @"show_call_history_in_room" value: NO];
[jsonFormData1 UpdateBool: @"show_contact_list_on_controller" value: YES];
[jsonFormData1 UpdateBool: @"count_attendees_number_in_room" value: YES];
[jsonFormData1 UpdateBool: @"send_whiteboard_to_internal_contact_only" value: NO];
[req AddStringForUpload2: @"zoom_rooms" filename: @"" strData: jsonFormData1 charset: @"utf-8" contentType: @"application/json"];
CkoJsonObject *jsonFormData2 = [[CkoJsonObject alloc] init];
[jsonFormData2 UpdateBool: @"upcoming_meeting_alert" value: YES];
[jsonFormData2 UpdateBool: @"show_alert_before_meeting" value: YES];
[jsonFormData2 UpdateBool: @"start_airplay_mirroring" value: YES];
[jsonFormData2 UpdateBool: @"start_airplay_manually" value: YES];
[jsonFormData2 UpdateBool: @"weekly_system_restart" value: NO];
[jsonFormData2 UpdateBool: @"display_meeting_list" value: NO];
[jsonFormData2 UpdateBool: @"display_top_banner" value: YES];
[jsonFormData2 UpdateBool: @"display_feedback_survey" value: YES];
[jsonFormData2 UpdateBool: @"auto_direct_sharing" value: YES];
[jsonFormData2 UpdateBool: @"transform_meeting_to_private" value: YES];
[jsonFormData2 UpdateBool: @"hide_id_for_private_meeting" value: NO];
[jsonFormData2 UpdateBool: @"auto_start_scheduled_meeting" value: YES];
[jsonFormData2 UpdateBool: @"auto_stop_scheduled_meeting" value: NO];
[jsonFormData2 UpdateBool: @"hide_share_instruction" value: NO];
[jsonFormData2 UpdateBool: @"audio_device_daily_auto_test" value: NO];
[jsonFormData2 UpdateBool: @"support_join_3rd_party_meeting" value: NO];
[jsonFormData2 UpdateBool: @"encrypt_shared_screen_content" value: NO];
[jsonFormData2 UpdateBool: @"allow_multiple_content_sharing" value: YES];
[jsonFormData2 UpdateBool: @"show_non_video_participants" value: YES];
[jsonFormData2 UpdateBool: @"show_call_history_in_room" value: NO];
[jsonFormData2 UpdateBool: @"show_contact_list_on_controller" value: YES];
[jsonFormData2 UpdateBool: @"count_attendees_number_in_room" value: YES];
[jsonFormData2 UpdateBool: @"send_whiteboard_to_internal_contact_only" value: NO];
[req AddStringForUpload2: @"meeting_security" filename: @"" strData: jsonFormData2 charset: @"utf-8" contentType: @"application/json"];
[req AddHeader: @"Authorization" value: @"Bearer <access_token>"];
CkoHttpResponse *resp = [http SynchronousRequest: @"reprehenderit" port: [NSNumber numberWithInt: 80] ssl: NO req: req];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
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": ""
}
]
}
