Objective-C / Zoom API / Get location settings
Back to Collection Items
#import <CkoHttp.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;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"setting_type" value: @"meeting"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.zoom.us/v2/rooms/locations/:locationId/settings" json: queryParams];
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;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "client_alert": {
// "detect_microphone_error_alert": true,
// "detect_bluetooth_microphone_error_alert": true,
// "detect_speaker_error_alert": true,
// "detect_bluetooth_speaker_error_alert": true,
// "detect_camera_error_alert": true
// },
// "notification": {
// "audio_not_meet_usability_threshold": false,
// "battery_low_and_not_charging": false,
// "controller_scheduling_disconnected": false,
// "cpu_usage_high_detected": false,
// "network_unstable_detected": false,
// "zoom_room_offline": false,
// "sip_registration_failed": false,
// "mic_speaker_camera_disconnected": false,
// "zoom_room_display_disconnected": false
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
BOOL Detect_microphone_error_alert = [jResp BoolOf: @"client_alert.detect_microphone_error_alert"];
BOOL Detect_bluetooth_microphone_error_alert = [jResp BoolOf: @"client_alert.detect_bluetooth_microphone_error_alert"];
BOOL Detect_speaker_error_alert = [jResp BoolOf: @"client_alert.detect_speaker_error_alert"];
BOOL Detect_bluetooth_speaker_error_alert = [jResp BoolOf: @"client_alert.detect_bluetooth_speaker_error_alert"];
BOOL Detect_camera_error_alert = [jResp BoolOf: @"client_alert.detect_camera_error_alert"];
BOOL Audio_not_meet_usability_threshold = [jResp BoolOf: @"notification.audio_not_meet_usability_threshold"];
BOOL Battery_low_and_not_charging = [jResp BoolOf: @"notification.battery_low_and_not_charging"];
BOOL Controller_scheduling_disconnected = [jResp BoolOf: @"notification.controller_scheduling_disconnected"];
BOOL Cpu_usage_high_detected = [jResp BoolOf: @"notification.cpu_usage_high_detected"];
BOOL Network_unstable_detected = [jResp BoolOf: @"notification.network_unstable_detected"];
BOOL Zoom_room_offline = [jResp BoolOf: @"notification.zoom_room_offline"];
BOOL Sip_registration_failed = [jResp BoolOf: @"notification.sip_registration_failed"];
BOOL Mic_speaker_camera_disconnected = [jResp BoolOf: @"notification.mic_speaker_camera_disconnected"];
BOOL Zoom_room_display_disconnected = [jResp BoolOf: @"notification.zoom_room_display_disconnected"];
Curl Command
curl -G -d "setting_type=meeting"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/locations/:locationId/settings
Postman Collection Item JSON
{
"name": "Get location settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"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.<br>\n`signage`: Digital signage settings of the Zoom Rooms Account."
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
},
"description": "Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br><br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:read:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nZoom Room location settings returned successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"client_alert\": {\n \"detect_microphone_error_alert\": true,\n \"detect_bluetooth_microphone_error_alert\": true,\n \"detect_speaker_error_alert\": true,\n \"detect_bluetooth_speaker_error_alert\": true,\n \"detect_camera_error_alert\": true\n },\n \"notification\": {\n \"audio_not_meet_usability_threshold\": false,\n \"battery_low_and_not_charging\": false,\n \"controller_scheduling_disconnected\": false,\n \"cpu_usage_high_detected\": false,\n \"network_unstable_detected\": false,\n \"zoom_room_offline\": false,\n \"sip_registration_failed\": false,\n \"mic_speaker_camera_disconnected\": false,\n \"zoom_room_display_disconnected\": false\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.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"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:** `4801`<br>\nLocation not found: {locationId}\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
