Conference Room Connector

OpenAPI Version: 3.1.1
API Version: 2

The Conference Room Connector (CRC) APIs allow developers to interface with CRC features programmatically.

Servers

URL: https://api.zoom.us/v2

Operations

Get Cisco/Polycom Room Account Setting

Method: GET
Path: /crc/managed_rooms/account_setting
Tags: Account

Retrieves details of the managed Cisco or Polycom rooms account profile settings. To get information on an individual room profile, use the Get managed room profile API.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_account:read:admin

Granular Scopes: crc:read:rooms_account_settings:admin

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP Status Code: `200` Account setting returned.

Content-Type: application/json

account_id

string — Account ID.
additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
airplay

boolean — The setting "AirPlay" of Polycom Trio Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
apply_qos_setting

boolean — The setting "Apply QoS Settings" of Polycom Trio Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
background_image

string — The background image URL of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
beta_firmware

boolean — The setting "Beta Firmware" of Polycom Trio Rooms.
blue_tooth

boolean — The setting "Bluetooth" of Polycom Trio Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
capset_filter

string — The setting "Capset Filter" of Cisco Rooms.
cisco_extra_provisioning

string — The setting "Advanced Provisioning" of Cisco Rooms. Should be a JSON string
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
connector_log_level

string, possible values: "OFF", "ERROR", "WARN", "INFO", "DEBUG" — The setting "Connector Log Level" of the Enhanced API connector.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
dev_signed_device

boolean — The setting "Dev Signed Device" of Polycom Trio Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
dolby_extra_provisioning

string — The setting "Advanced Provisioning" of Dolby Rooms. Should be a JSON string.
dolby_provisioning

boolean — The setting "Dolby Provisioning" of Dolby Rooms.
dscp_audio

integer — The setting "DSCP Audio" of Polycom Trio Rooms.
dscp_data

integer — The setting "DSCP Data" of Polycom Trio Rooms.
dscp_signalling

integer — The setting "DSCP Signalling" of Polycom Trio Rooms.
dscp_video

integer — The setting "DSCP Video" of Polycom Trio Rooms.
dynamic_ip_address

string, possible values: "Configured", "Dynamic" — The dynamic IP address of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_automatic_update

boolean — The setting "Enable Automatic Update" of the Enhanced API connector.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_runner_automatic_update

boolean — The setting "Enable Runner Automatic Update" of the Enhanced API connector.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
end_user_license_agreement

boolean — The End User License Agreement (EULA) of Polycom Trio Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
firmware_key

string — The setting "Firmware Key" of Polycom Trio Rooms.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting.
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for ad hoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
miracast

boolean — The setting "Miracast" of Polycom Trio Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
nightly_reboot

boolean — The setting "Nightly Reboot" of Dolby Rooms.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
polycom_debut_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom Debut Rooms. Should be a JSON string.
polycom_hdx_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom HDX Rooms. Should be a JSON string.
polycom_trio_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom Trio Rooms. Should be a JSON string.
polycon_group_extra_provisioning

string — The setting "Advanced Provisioning" of Ploycom Group Rooms. Should be a JSON string.
ppcip

boolean — The setting "Polycom People+Content IP (PPCIP)" of Polycom Trio Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting.
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
screen_capture

boolean — The setting "Screen Capture" of Polycom Trio Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting - Set Zoom cloud SIP proxy region.
show_call_button

boolean — The setting "Show Call Button" of Polycom Trio Rooms.
show_icons_on_the_home_screen

boolean — The setting "Show Icons on the Home Screen" of Polycom Group Rooms.
show_redial_button

boolean — The setting "Show Redial Button" of Polycom Trio Rooms.
show_setting_menu

boolean — The setting "Show Settings Menu" of Polycom Trio Rooms.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting Id" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.
zero_touch_provisioning

boolean — The Zero Touch Provisioning (ZTP) of Polycom Trio Rooms.

Example:

{
  "account_id": "8KajEX6-S02l5sgpaT0qpg",
  "device_management": false,
  "manage_type": "Full Management",
  "dynamic_ip_address": "Configured",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "zero_touch_provisioning": false,
  "end_user_license_agreement": false,
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "connector_log_level": "INFO",
  "enable_automatic_update": true,
  "enable_runner_automatic_update": true,
  "capset_filter": "G.729AB;G.729;G.729A;AAC-LD;H.261;H.263;H.263PP;H.265;Opus;",
  "cisco_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycon_group_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_trio_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "dolby_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_debut_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_hdx_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "blue_tooth": false,
  "show_redial_button": false,
  "show_call_button": false,
  "ppcip": false,
  "airplay": false,
  "miracast": false,
  "apply_qos_setting": false,
  "dscp_audio": 60,
  "dscp_video": 60,
  "dscp_data": 60,
  "dscp_signalling": 60,
  "show_setting_menu": false,
  "screen_capture": false,
  "beta_firmware": false,
  "firmware_key": "key",
  "dev_signed_device": false,
  "nightly_reboot": false,
  "dolby_provisioning": false,
  "show_icons_on_the_home_screen": false,
  "background_image": "https://file.zoomdev.us/s/N2vZdt_31Cm-vxBrK0FFFVMAEfWcSv0x0BeJW4t4o1Rl2C9GJACOjE943v2QJ0PdhyZ-oyQlmGJq3SzNikfHPw",
  "set_zoom_cloud_sip_proxy_region": "US"
}

Status: 401 HTTP Status Code: `401` Unauthorized Error Code: `60061001` Account Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update Cisco/Polycom Room Account Setting

Method: PATCH
Path: /crc/managed_rooms/account_setting
Tags: Account

Updates details of the managed Cisco/Polycom rooms account profile settings.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_account:write:admin

Granular Scopes: crc:update:rooms_account_settings:admin

Rate Limit Label: LIGHT

Request Body

Content-Type: multipart/form-data

additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
airplay

boolean — The setting "AirPlay" of Polycom Trio Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
apply_qos_setting

boolean — The setting "Apply QoS Settings" of Polycom Trio Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
beta_firmware

boolean — The setting "Beta Firmware" of Polycom Trio Rooms.
blue_tooth

boolean — The setting "Bluetooth" of Polycom Trio Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
capset_filter

string — The setting "Capset Filter" of Cisco Rooms.
cisco_extra_provisioning

string — The setting "Advanced Provisioning" of Cisco Rooms. Should be a JSON string.
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
connector_log_level

string, possible values: "OFF", "ERROR", "WARN", "INFO", "DEBUG" — The setting "Connector Log Level" of the Enhanced API connector.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
dev_signed_device

boolean — The setting "Dev Signed Device" of Polycom Trio Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
dolby_extra_provisioning

string — The setting "Advanced Provisioning" of Dolby Rooms. Should be a JSON string.
dolby_provisioning

boolean — The setting "Dolby Provisioning" of Dolby Rooms.
dscp_audio

integer — The setting "DSCP Audio" of Polycom Trio Rooms.
dscp_data

integer — The setting "DSCP Data" of Polycom Trio Rooms.
dscp_signalling

integer — The setting "DSCP Signalling" of Polycom Trio Rooms.
dscp_video

integer — The setting "DSCP Video" of Polycom Trio Rooms.
dynamic_ip_address

string, possible values: "Configured", "Dynamic" — The dynamic IP address of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_automatic_update

boolean — The setting "Enable Automatic Update" of the Enhanced API connector.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_runner_automatic_update

boolean — The setting "Enable Runner Automatic Update" of the Enhanced API connector.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
end_user_license_agreement

boolean — The End User License Agreement (EULA) of Polycom Trio Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
firmware_key

string — The setting "Firmware Key" of Polycom Trio Rooms.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting.
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for ad hoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends.
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
miracast

boolean — The setting "Miracast" of Polycom Trio Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
nightly_reboot

boolean — The setting "Nightly Reboot" of Dolby Rooms.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
polycom_debut_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom Debut Rooms. Should be a JSON string.
polycom_hdx_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom HDX Rooms. Should be a JSON string
polycom_trio_extra_provisioning

string — The setting "Advanced Provisioning" of Polycom Trio Rooms. Should be a JSON string.
polycon_group_extra_provisioning

string — The setting "Advanced Provisioning" of Ploycom Group Rooms. Should be a JSON string
ppcip

boolean — The setting "Polycom People+Content IP (PPCIP)" of Polycom Trio Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
screen_capture

boolean — The setting "Screen Capture" of Polycom Trio Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting "Set Zoom cloud SIP proxy region"
show_call_button

boolean — The setting "Show Call Button" of Polycom Trio Rooms.
show_icons_on_the_home_screen

boolean — The setting "Show Icons on the Home Screen" of Polycom Group Rooms.
show_redial_button

boolean — The setting "Show Redial Button" of Polycom Trio Rooms.
show_setting_menu

boolean — The setting "Show Settings Menu" of Polycom Trio Rooms.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting ID" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.
zero_touch_provisioning

boolean — The Zero Touch Provisioning (ZTP) of Polycom Trio Rooms

Example:

{
  "device_management": false,
  "manage_type": "Full Management",
  "dynamic_ip_address": "Configured",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "zero_touch_provisioning": false,
  "end_user_license_agreement": false,
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "connector_log_level": "INFO",
  "enable_automatic_update": true,
  "enable_runner_automatic_update": true,
  "capset_filter": "G.729AB;G.729;G.729A;AAC-LD;H.261;H.263;H.263PP;H.265;Opus;",
  "cisco_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycon_group_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_trio_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "dolby_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_debut_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "polycom_hdx_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "blue_tooth": false,
  "show_redial_button": false,
  "show_call_button": false,
  "ppcip": false,
  "airplay": false,
  "miracast": false,
  "apply_qos_setting": false,
  "dscp_audio": 60,
  "dscp_video": 60,
  "dscp_data": 60,
  "dscp_signalling": 60,
  "show_setting_menu": false,
  "screen_capture": false,
  "beta_firmware": false,
  "firmware_key": "key",
  "dev_signed_device": false,
  "nightly_reboot": false,
  "dolby_provisioning": false,
  "show_icons_on_the_home_screen": false,
  "set_zoom_cloud_sip_proxy_region": "US"
}

Responses

Status: 204 HTTP Status Code: `204` No Content.

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60071011` Invalid Parameter. Error Code: `60067099` Unknown Error.

Status: 401 HTTP Status Code: `401` Unauthorized Error Code: `60061001` Account Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List API Connectors

Method: GET
Path: /crc/api_connectors
Tags: Api Connector

Returns the Enhanced API Connectors for Cisco or Polycom Rooms.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:read:admin

Granular Scopes: crc:read:list_apiconnectors:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 HTTP Status Code: `200` List API Connectors returned.

Content-Type: application/json

api_connectors

array — The information about the API connectors.

Items:
- description
  
  string — The description of the Enhanced API Connector.
- enable_automatic_update
  
  boolean — When enabled, the Enhanced API Connector will automatically update to new software versions.
- id
  
  string — The ID of the Enhanced API Connector.
- networks
  
  string — The private IPv4 networks that the API connector manages. To enter them use the slash notation. Use a comma (,) to separate multiple networks.
- status
  
  string — The status of the Enhanced API Connector.
- version
  
  string — The current version of software used by this Enhanced API Connector.
next_page_token

string — The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size

integer — The number of records returned within a single API call. Constraints: Max 300 Default: 30
total_records

integer — The total number of records returned.

Example:

{
  "total_records": 10,
  "next_page_token": "IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2",
  "page_size": 1,
  "api_connectors": [
    {
      "id": "e4d89238-7a58-4003-b45b-dfd892e9b11b",
      "description": "my connector",
      "status": "online",
      "networks": "10.100.209.10",
      "enable_automatic_update": true,
      "version": "5.8.1"
    }
  ]
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create an API Connector

Method: POST
Path: /crc/api_connectors
Tags: Api Connector

Creates an Enhanced API Connector.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:write:admin

Granular Scopes: crc:write:apiconnector:admin

Rate Limit Label: MEDIUM

Request Body

Content-Type: application/json

description

string — The description of the Enhanced API Connector.
enable_automatic_update

boolean — When enabled, the Enhanced API Connector will automatically update to a new software version.
log_level

string — The Enhanced API Connector logging level. Valid values: [OFF | ERROR | WARN | INFO | DEBUG].
networks

string — The private IPv4 networks that the API connector manages. Use the slash notation to enter them. Use a comma (,) to separate multiple networks.

Example:

{
  "description": "my connector",
  "networks": "172.16.0.0/12,10.0.0.0/8,192.168.0.0/16",
  "log_level": "DEBUG",
  "enable_automatic_update": true
}

Responses

Status: 201 HTTP Status Code: `201` API Connector created successfully.

Content-Type: application/json

connector_id

string — The enhanced API connector's ID.

Example:

{
  "connector_id": "e4d89238-7a58-4003-b45b-dfd892e9b11b"
}

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60071011` Invalid Parameter Error Code: `60071007` Ip Range Overlaps Error Code: `60067099` Unknown Error

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get an API Connector

Method: GET
Path: /crc/api_connectors/{connectorId}
Tags: Api Connector

Returns the details of an enhanced API connector.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:read:admin

Granular Scopes: crc:read:apiconnector:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 HTTP Status Code: `200` An API connector returned.

Content-Type: application/json

description

string — The enhanced API connector's description.
enable_automatic_update

boolean — When enabled, the enhanced API connector will automatically update to new software versions.
id

string — The enhanced API connector's ID.
log_level

string — The enhanced API connector logging level. Valid values are `OFF`, `ERROR`, `WARN`, `INFO`, or `DEBUG`.
managed_rooms

array — The IDs of Cisco or Polycom rooms that are directly and manually assigned to this enhanced API connector.

Items:

string — The ID of Cisco or Polycom rooms.
networks

string — The private IPv4 networks that the API connector manages. Use slash notation to enter them. Separate multiple networks with commas (,).
status

string — The status of the enhanced API connector. Valid values are `offline` or `online`.
version

string — The current version of software used by this enhanced API connector.

Example:

{
  "id": "e4d89238-7a58-4003-b45b-dfd892e9b11b",
  "description": "my connector",
  "status": "online",
  "networks": "10.100.209.10",
  "log_level": "DEBUG",
  "managed_rooms": [
    "598fe412-dee4-4439-bd9a-9f864cab38e2"
  ],
  "enable_automatic_update": true,
  "version": "5.8.1"
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60071008` Connector does not exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Delete an API Connector

Method: DELETE
Path: /crc/api_connectors/{connectorId}
Tags: Api Connector

Deletes an enhanced API connector.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:write:admin

Granular Scopes: crc:delete:apiconnector:admin

Rate Limit Label: MEDIUM

Responses

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60071008` Connector does not exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update an API Connector

Method: PATCH
Path: /crc/api_connectors/{connectorId}
Tags: Api Connector

Updates the settings of an Enhanced API Connector.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:write:admin

Granular Scopes: crc:update:apiconnector:admin

Rate Limit Label: MEDIUM

Request Body

Content-Type: application/json

description

string — The description of the Enhanced API Connector.
enable_automatic_update

boolean — When enabled, the Enhanced API Connector will automatically update to a new software version.
log_level

string — The Enhanced API Connector logging level. Valid values: [OFF | ERROR | WARN | INFO | DEBUG].
managed_rooms

array — The IDs of Cisco or Polycom Rooms directly and manually assigned to this Enhanced API Connector.

Items:

string — The ID of Cisco or Polycom Rooms.
networks

string — The private IPv4 networks that the API connector manages. Use the slash notation to enter them. Use a comma (,) to separate multiple networks.

Example:

{
  "description": "my connector",
  "networks": "10.100.209.10",
  "log_level": "DEBUG",
  "managed_rooms": [
    "598fe412-dee4-4439-bd9a-9f864cab38e2"
  ],
  "enable_automatic_update": true
}

Responses

Status: 204 HTTP Status Code: `204` No content.

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60071011` Invalid parameter. Error Code: `60071007` IP range overlaps. Error Code: `60067099` Unknown Error.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061003` Device does not exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get an API Connector's private key

Method: GET
Path: /crc/api_connectors/{connectorId}/private_key
Tags: Api Connector

Retrieves the private key of an Enhanced API Connector.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:read:admin

Granular Scopes: crc:read:apiconnector_private_key:admin

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP Status Code: `200` A private key returned.

Content-Type: application/json

private_key

string — The private key used by the Enhanced API Connector to authenticate to Zoom services.

Example:

{
  "private_key": "q3dgdj1mln9x0pne8kjb9y122qatlqoe3k4czeu85fgdgkkq237mhpqe9uh3xam8f7syv1rrm9xb7xute0gzekndn9oy98n3cen4l2t63gggxlivnzsdgcovsy6kwwk3"
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60071008` Connector does not exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update an API Connector's private key

Method: PATCH
Path: /crc/api_connectors/{connectorId}/private_key
Tags: Api Connector

Regenerates the enhanced API connector's private key.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: apiconnector:write:admin

Granular Scopes: crc:update:apiconnector_private_key:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 HTTP Status Code: `200` A private key returned.

Content-Type: application/json

private_key

string — The private key the enhanced API connector uses to authenticate to Zoom services.

Example:

{
  "private_key": "q3dgdj1mln9x0pne8kjb9y122qatlqoe3k4czeu85fgdgkkq237mhpqe9uh3xam8f7syv1rrm9xb7xute0gzekndn9oy98n3cen4l2t63gggxlivnzsdgcovsy6kwwk3"
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60071008` Connector does not exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List Managed Rooms

Method: GET
Path: /crc/managed_rooms
Tags: Cisco/Polycom Rooms

Returns the Managed Cisco/Polycom rooms.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_rooms:read:admin

Granular Scopes: crc:read:list_rooms:admin

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP Status Code: `200` List Managed Rooms returned.

Content-Type: application/json

managed_rooms

array — The information about the Cisco/Polycom Rooms.

Items:
- device_id
  
  string — The Cisco/Polycom Room's ID.
- device_management
  
  boolean — The device management status of the Cisco/Polycom Rooms.
- device_type
  
  string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
- ip_address
  
  string — The private IPv4 network of the Cisco/Polycom Rooms.
- manage_type
  
  string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
- name
  
  string — The name of the Cisco/Polycom Rooms.
- serial_number
  
  string — The serial number of the Cisco/Polycom Rooms.
next_page_token

string — The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size

integer — The number of records returned within a single API call. Constraints: Max 300 Default: 30.
total_records

integer — The total number of records returned.

Example:

{
  "total_records": 10,
  "next_page_token": "IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2",
  "page_size": 1,
  "managed_rooms": [
    {
      "device_id": "be771df1-fcfd-4113-9b9d-423e0d610128",
      "name": "my room",
      "device_management": false,
      "manage_type": "Full Management",
      "device_type": "Cisco Series",
      "serial_number": "FOC1825N9DC",
      "ip_address": "10.100.11.12"
    }
  ]
}

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create a Managed Room

Method: POST
Path: /crc/managed_rooms
Tags: Cisco/Polycom Rooms

Creates a Managed Cisco/Poly Room.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_rooms:write:admin

Granular Scopes: crc:write:room:admin

Rate Limit Label: LIGHT

Request Body

Content-Type: application/json

auth_password

string — The SIP password for SIP Proxy manage type devices.
device_password

string — The login password the Cisco/Polycom Rooms.
device_type

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
device_username

string — The login username of the Cisco/Polycom Rooms.
ip_address

string — The private IPv4 network of the Cisco/Polycom Rooms.
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
name

string — The name of the Cisco/Polycom Rooms.
serial_number

string — The serial number of the Cisco/Polycom Rooms.
template_id

string — The template id used when creating the room, The room will use the room template settings

Example:

{
  "manage_type": "Full Management",
  "name": "my room",
  "template_id": "489882023b4a452ab176880c4e46da42",
  "device_type": "Cisco Series",
  "serial_number": "FOC1825N9DC",
  "ip_address": "10.100.11.12",
  "device_username": "admin",
  "device_password": "123456",
  "auth_password": "6f543g217"
}

Responses

Status: 201 HTTP Status Code: `201` A Cisco/Polycom Room created successfully.

Content-Type: application/json

auth_username

string — Auth username for sip registration when create a "SIP Proxy" manage type device.
device_id

string — The Cisco/Polycom Room's ID.
reminder

string — Reminder text when create a "SIP Proxy" manage type device.
server_address

string — SIP server address for SIP registration when create a "SIP Proxy" manage type device.

Example:

{
  "device_id": "e4d89238-7a58-4003-b45b-dfd892e9b11b",
  "server_address": "releasesipproxy.zoomdev.us",
  "auth_username": "sdfggh0986767r00fddsd@generic-device",
  "reminder": "Please go to the Admin UI to configure."
}

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60071011` Invalid Parameter. Error Code: `60067099` Unknown Error. Error Code: `60071007` IP Range Overlaps. Error Code: `60061007` Serial Number exist.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get a Managed Room

Method: GET
Path: /crc/managed_rooms/{deviceId}
Tags: Cisco/Polycom Rooms

Returns the details of a managed room.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_rooms:read:admin

Granular Scopes: crc:read:room:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 HTTP Status Code: `200` A Cisco or Polycom Room returned.

Content-Type: application/json

additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
airplay

boolean — The setting "AirPlay" of Polycom Trio Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
apply_qos_setting

boolean — The setting "Apply QoS Settings" of Polycom Trio Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
background_image

string — The background image url of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
beta_firmware

boolean — The setting "Beta Firmware" of Polycom Trio Rooms.
bind_calendar

boolean — Whether to assign calendar resources to the room
blue_tooth

boolean — The setting "Bluetooth" of Polycom Trio Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
call_status

string, possible values: "Connected", "Idle", "InMeeting", "Presentation", "Unknown", "None" — The call status of the Cisco/Polycom Rooms.
capset_filter

string — The setting "Capset Filter" of Cisco Rooms.
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
connection_status

string, possible values: "connected", "disconnected", "none" — The connection status of the Cisco/Polycom Rooms.
connector_id

string — The enhanced API connector's ID.
create_time

string — The create time of the Cisco/Polycom Rooms.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
dev_signed_device

boolean — The setting "Dev Signed Device" of Polycom Trio Rooms.
device_id

string — The Cisco/Polycom Room's ID.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
device_type

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
device_username

string — The auth username of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
dolby_provisioning

boolean — The setting "Dolby Provisioning" of Dolby Rooms.
dscp_audio

integer — The setting "DSCP Audio" of Polycom Trio Rooms.
dscp_data

integer — The setting "DSCP Data" of Polycom Trio Rooms.
dscp_signalling

integer — The setting "DSCP Signalling" of Polycom Trio Rooms.
dscp_video

integer — The setting "DSCP Video" of Polycom Trio Rooms.
dynamic_ip_address

string, possible values: "Configured", "Dynamic" — The dynamic IP address of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_sip_tls_certificate_verification

boolean — The setting "Enable SIP TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
end_user_license_agreement

boolean — The End User License Agreement (EULA) of Polycom Trio Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
extra_provisioning

string — The setting "Advanced Provisioning" of the Cisco/Polycom Rooms. Should be a JSON string
firmware_key

string — The setting "Firmware Key" of Polycom Trio Rooms.
firmware_version

string — The firmware version of the Cisco/Polycom Rooms.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hardware_version

string — The hardware version of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
ip_address

string — The private IPv4 network of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting.
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for Adhoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends.
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
miracast

boolean — The setting "Miracast" of Polycom Trio Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
name

string — The name of the Cisco/Polycom Rooms.
nightly_reboot

boolean — The setting "Nightly Reboot" of Dolby Rooms.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
personal_meeting_id

string — The setting "Personal Meeting ID or Room" of the Cisco/Polycom Rooms.
ppcip

boolean — The setting "Polycom People+Content IP (PPCIP)" of Polycom Trio Rooms.
provisioning_status

string, possible values: "none", "unregistered", "registering", "provisioned", "configured" — The provisioning status of the Cisco/Polycom Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting.
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
screen_capture

boolean — The setting "Screen Capture" of Polycom Trio Rooms.
serial_number

string — The serial number of the Cisco/Polycom Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting "Set Zoom cloud SIP proxy region"
show_call_button

boolean — The setting "Show Call Button" of Polycom Trio Rooms.
show_icons_on_the_home_screen

boolean — The setting "Show Icons on the Home Screen" of Polycom Group Rooms.
show_redial_button

boolean — The setting "Show Redial Button" of Polycom Trio Rooms.
show_setting_menu

boolean — The setting "Show Settings Menu" of Polycom Trio Rooms.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
sip_status

string, possible values: "none", "unregistered", "registering", "registered" — The SIP status of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting ID" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.
zero_touch_provisioning

boolean — The Zero Touch Provisioning (ZTP) of Polycom Trio Rooms.

Example:

{
  "device_id": "be771df1-fcfd-4113-9b9d-423e0d610128",
  "connector_id": "578dfjk1-ffgd-3643-9b9d-423e0d610128",
  "name": "my room",
  "device_management": false,
  "manage_type": "Full Management",
  "device_type": "Cisco Series",
  "create_time": "2024-07-10T02:33:59.000+00:00",
  "serial_number": "FF20382199D6D7",
  "ip_address": "10.100.22.34",
  "dynamic_ip_address": "Configured",
  "firmware_version": "ce 9.15.18.5 ed6b7b134c0 2024-03-12",
  "hardware_version": "Cisco TelePresence SX10",
  "device_username": "admin",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "connection_status": "connected",
  "provisioning_status": "provisioned",
  "sip_status": "registered",
  "call_status": "Idle",
  "zero_touch_provisioning": false,
  "end_user_license_agreement": false,
  "bind_calendar": false,
  "personal_meeting_id": "980673875",
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "capset_filter": "G.729AB;G.729;G.729A;AAC-LD;H.261;H.263;H.263PP;H.265;Opus;",
  "extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "blue_tooth": false,
  "show_redial_button": false,
  "show_call_button": false,
  "ppcip": false,
  "airplay": false,
  "miracast": false,
  "apply_qos_setting": false,
  "dscp_audio": 60,
  "dscp_video": 60,
  "dscp_data": 60,
  "dscp_signalling": 60,
  "show_setting_menu": false,
  "screen_capture": false,
  "beta_firmware": false,
  "firmware_key": "key",
  "dev_signed_device": false,
  "nightly_reboot": false,
  "dolby_provisioning": false,
  "show_icons_on_the_home_screen": false,
  "background_image": "https://file.zoomdev.us/s/N2vZdt_31Cm-vxBrK0FFFVMAEfWcSv0x0BeJW4t4o1Rl2C9GJACOjE943v2QJ0PdhyZ-oyQlmGJq3SzNikfHPw",
  "set_zoom_cloud_sip_proxy_region": "US"
}

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60061021` Invalid Parameter.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061003` Device Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Delete a managed room

Method: DELETE
Path: /crc/managed_rooms/{deviceId}
Tags: Cisco/Polycom Rooms

Deletes a managed Cisco/Poly Room.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_rooms:write:admin

Granular Scopes: crc:delete:room:admin

Rate Limit Label: LIGHT

Responses

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061003` Device Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update a Managed Room

Method: PATCH
Path: /crc/managed_rooms/{deviceId}
Tags: Cisco/Polycom Rooms

Updates the settings of a Cisco or Polycom Room.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_rooms:write:admin

Granular Scopes: crc:update:room:admin

Rate Limit Label: LIGHT

Request Body

Content-Type: application/json

additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
airplay

boolean — The setting "AirPlay" of Polycom Trio Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
apply_qos_setting

boolean — The setting "Apply QoS Settings" of Polycom Trio Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
beta_firmware

boolean — The setting "Beta Firmware" of Polycom Trio Rooms.
blue_tooth

boolean — The setting "Bluetooth" of Polycom Trio Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
capset_filter

string — The setting "Capset Filter" of Cisco Rooms.
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
connector_id

string — The enhanced API connector's ID.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
dev_signed_device

boolean — The setting "Dev Signed Device" of Polycom Trio Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
device_password

string — The login password of the Cisco/Polycom Rooms.
device_type

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
device_username

string — The login username of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
dolby_provisioning

boolean — The setting "Dolby Provisioning" of Dolby Rooms.
dscp_audio

integer — The setting "DSCP Audio" of Polycom Trio Rooms.
dscp_data

integer — The setting "DSCP Data" of Polycom Trio Rooms.
dscp_signalling

integer — The setting "DSCP Signalling" of Polycom Trio Rooms.
dscp_video

integer — The setting "DSCP Video" of Polycom Trio Rooms.
dynamic_ip_address

string, possible values: "Configured", "Dynamic" — The dynamic IP address of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
end_user_license_agreement

boolean — The End User License Agreement (EULA) of Polycom Trio Rooms
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
extra_provisioning

string — The setting "Advanced Provisioning" of the Cisco/Polycom Rooms. Should be a JSON string
firmware_key

string — The setting "Firmware Key" of Polycom Trio Rooms.
firmware_version

string — The firmware version of the Cisco/Polycom Rooms.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hardware_version

string — The hardware version of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
ip_address

string — The private IPv4 network of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for Adhoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
miracast

boolean — The setting "Miracast" of Polycom Trio Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
name

string — The name of the Cisco/Polycom Rooms.
nightly_reboot

boolean — The setting "Nightly Reboot" of Dolby Rooms.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
passcode_for_personal_meeting_id

string — The setting "Passcode for Personal Meeting ID" of the Cisco/Polycom Rooms.
personal_meeting_id

string — The setting "Personal Meeting ID for Room" of the Cisco/Polycom Rooms.
ppcip

boolean — The setting "Polycom People+Content IP (PPCIP)" of Polycom Trio Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
room_host_key

string — The setting "Room Host Key" of the Cisco/Polycom Rooms.
screen_capture

boolean — The setting "Screen Capture" of Polycom Trio Rooms.
serial_number

string — The serial number of the Cisco/Polycom Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting - *Set Zoom cloud SIP proxy region*.
show_call_button

boolean — The setting "Show Call Button" of Polycom Trio Rooms.
show_icons_on_the_home_screen

boolean — The setting "Show Icons on the Home Screen" of Polycom Group Rooms.
show_redial_button

boolean — The setting "Show Redial Button" of Polycom Trio Rooms.
show_setting_menu

boolean — The setting "Show Settings Menu" of Polycom Trio Rooms.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting ID" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.
zero_touch_provisioning

boolean — The Zero Touch Provisioning (ZTP) of Polycom Trio Rooms

Example:

{
  "connector_id": "578dfjk1-ffgd-3643-9b9d-423e0d610128",
  "name": "my room",
  "device_management": false,
  "manage_type": "Full Management",
  "device_type": "Cisco Series",
  "serial_number": "FF20382199D6D7",
  "ip_address": "10.100.22.34",
  "dynamic_ip_address": "Configured",
  "firmware_version": "ce 9.15.18.5 ed6b7b134c0 2024-03-12",
  "hardware_version": "Cisco TelePresence SX10",
  "device_username": "admin",
  "device_password": "pass1234",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "zero_touch_provisioning": false,
  "end_user_license_agreement": false,
  "room_host_key": "636047",
  "personal_meeting_id": "980673875",
  "passcode_for_personal_meeting_id": "9849703",
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "capset_filter": "G.729AB;G.729;G.729A;AAC-LD;H.261;H.263;H.263PP;H.265;Opus;",
  "extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "blue_tooth": false,
  "show_redial_button": false,
  "show_call_button": false,
  "ppcip": false,
  "airplay": false,
  "miracast": false,
  "apply_qos_setting": false,
  "dscp_audio": 60,
  "dscp_video": 60,
  "dscp_data": 60,
  "dscp_signalling": 60,
  "show_setting_menu": false,
  "screen_capture": false,
  "beta_firmware": false,
  "firmware_key": "key name",
  "dev_signed_device": false,
  "nightly_reboot": false,
  "dolby_provisioning": false,
  "show_icons_on_the_home_screen": false,
  "set_zoom_cloud_sip_proxy_region": "US"
}

Responses

Status: 204 HTTP Status Code: `204` No Content.

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60071011` Invalid Parameter. Error Code: `60067099` Unknown Error.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061003` Device Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get participant identifier code

Method: GET
Path: /crc/participant_identifier_code
Tags: Participant

Authenticate CRC meetings.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc:read:admin,crc:master

Granular Scopes: crc:read:participant_identifier_code:admin,crc:read:participant_identifier_code:master

Rate Limit Label: LIGHT

Responses

Status: 200 Identifier code details.

Content-Type: application/json

expire_in

number — Expiry time of identifier code in seconds.
paid_crc_plan_participant

boolean — CRC plan status of the API caller.
participant_identifier_code

string — Identifier code.

Example:

{
  "participant_identifier_code": "41bc4gfs3",
  "expire_in": 7200,
  "paid_crc_plan_participant": true
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 403 HTTP Status Code: `403` Forbidden

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List Room Templates

Method: GET
Path: /crc/room_templates
Tags: Room Template

Returns the Managed Cisco/Polycom rooms Templates.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_rooms:read:admin

Granular Scopes: crc:read:list_rooms_templates:admin

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP Status Code: `200` List Room Templates returned.

Content-Type: application/json

next_page_token

string — The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size

integer — The number of records returned within a single API call. Constraints: Max 300 Default: 30
templates

array — The information about the Cisco/Polycom Room Template.

Items:
- device_type
  
  string — The device type of the Cisco/Polycom Rooms. Valid Value [Cisco Series | Polycom Group Series | Polycom Trio | Polycom HDX | Polycom Debut | Lifesize Icon | Dolby].
- name
  
  string — The name of the Cisco/Polycom Rooms Template.
- template_id
  
  string — The Cisco/Polycom Room's Template ID.
total_records

integer — The total number of records returned.

Example:

{
  "total_records": 10,
  "next_page_token": "IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2",
  "page_size": 1,
  "templates": [
    {
      "template_id": "e4d89238-7a58-4003-b45b-dfd892e9b11b",
      "name": "my template",
      "device_type": "Cisco Series"
    }
  ]
}

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create a Room Template

Method: POST
Path: /crc/room_templates
Tags: Room Template

Creates a Managed Cisco/Poly Room.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_rooms:write:admin

Granular Scopes: crc:write:rooms_template:admin

Rate Limit Label: LIGHT

Request Body

Content-Type: application/json

device_type (required)

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
name (required)

string — The Name the Cisco/Polycom Rooms Template.
additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
extra_provisioning

string — The setting "Advanced Provisioning" of the Cisco/Polycom Rooms. Should be a JSON string.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for ad hoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends.
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting.
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting - *Set Zoom cloud SIP proxy region*.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms.
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting Id" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.

Example:

{
  "device_type": "Cisco Series",
  "name": "cisco template",
  "device_management": false,
  "manage_type": "Full Management",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "set_zoom_cloud_sip_proxy_region": "US"
}

Responses

Status: 201 HTTP Status Code: `201` A Cisco/Polycom Room Template created successfully.

Content-Type: application/json

template_id

string — The Cisco or Polycom Rooms Template's ID.

Example:

{
  "template_id": "120f4c26aaa84354b439335a6369fe84"
}

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60061021` Invalid Parameter.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get a Room Template

Method: GET
Path: /crc/room_templates/{templateId}
Tags: Room Template

Returns the details of a Cisco/Polycom room template.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_rooms:read:admin

Granular Scopes: crc:read:rooms_template:admin

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP Status Code: `200` A Cisco/Polycom Room Template returned.

Content-Type: application/json

additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
device_type

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
extra_provisioning

string — The setting "Advanced Provisioning" of the Cisco/Polycom Rooms. Should be a JSON string.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for ad hoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
name

string — The name of the Cisco/Polycom Rooms Template.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting.
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting "Set Zoom cloud SIP proxy region".
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
template_id

string — The Cisco/Polycom Room's Template ID.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting Id" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.

Example:

{
  "template_id": "be771df1-fcfd-4113-9b9d-423e0d610128",
  "name": "my room",
  "device_management": false,
  "manage_type": "Full Management",
  "device_type": "Cisco Series",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "set_zoom_cloud_sip_proxy_region": "US"
}

Status: 400 HTTP Status Code: `400` Bad Request

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061043` Template Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Delete a room template

Method: DELETE
Path: /crc/room_templates/{templateId}
Tags: Room Template

Deletes a Managed Cisco/Poly Room Template.

Prerequisites:

The Zoom account must have a CRC subscription.

Scopes: crc_rooms:write:admin

Granular Scopes: crc:delete:rooms_template:admin

Rate Limit Label: LIGHT

Responses

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061043` Template Not Found.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update a Room Template

Method: PATCH
Path: /crc/room_templates/{templateId}
Tags: Room Template

Updates the settings of a Cisco/Polycom Room Template.

Prerequisites

The Zoom account must have a CRC subscription

Scopes: crc_rooms:write:admin

Granular Scopes: crc:update:rooms_template:admin

Rate Limit Label: LIGHT

Request Body

Content-Type: application/json

additional_dtmf_command

string — The setting "Additional DTMF Command" of the Cisco/Polycom Rooms.
adhoc_join_meet_now_location

string, possible values: "Off", "Favorites", "Dynamic Calendar (Zoom Only)", "Local Directory/Contacts", "Speed Dial", "Manual Configuration, Not Provisioned by Zoom" — The setting "Adhoc_Join / Meet_Now Location" of the Cisco/Polycom Rooms.
alternative_room_connector

string — The setting "Alternative Room Connector" of the Cisco/Polycom Rooms.
always_show_join_button

boolean — The setting "Always Show Join Button" of the Cisco/Polycom Rooms.
audio_gain_control

string, possible values: "Off", "Use Audio Level 1", "Use Audio Level 2", "Use Audio Level 3" — The setting "Audio Gain Control" of the Cisco/Polycom Rooms.
bandwidth_allocation_preference

string, possible values: "Prioritize video over content", "Split video and content equally", "Prioritize content over video" — The setting "Bandwidth Allocation Preference: Content vs. Video" of the Cisco/Polycom Rooms.
call_controller_protocol_to_zoom_meeting

string — The setting "Call Controller Protocol to Zoom Meeting" of the Cisco/Polycom Rooms.
call_rate

Integer, possible values: -1, 192, 256, 384, 512, 768, 1024, 1472, 1920, 2048, 3072, 3840, 4096, 6144 — The setting "Call Rate" of the Cisco/Polycom Rooms. -1 means manual configuration.
closed_caption_position

string, possible values: "Top", "Bottom" — The setting "Closed Caption Position" of the Cisco/Polycom Rooms.
default_topic

string — The setting "Default Topic" of the Cisco/Polycom Rooms.
default_video_layout

string, possible values: "Gallery", "Full Screen", "Active - Bottom", "Active - Top" — The setting "Default video layout" of the Cisco/Polycom Rooms.
default_zoom_topic

string — The setting "Default Topic (Zoom)" of the Cisco/Polycom Rooms.
device_management

boolean — The device management status of the Cisco/Polycom Rooms.
device_type

string, possible values: "Cisco Series", "Polycom Group Series", "Polycom Trio", "Polycom HDX", "Polycom Debut", "Lifesize Icon", "Dolby" — The device type of the Cisco/Polycom Rooms.
dial_using_numeric_dial_plan

string — The setting "Dial Using Numeric Dial Plan" of the Cisco/Polycom Rooms.
display_layout

string, possible values: "Default", "Single Display", "Dual Display (active speaker + gallery view)", "Dual Display (gallery + gallery view)" — The setting "Optimize for Single or Dual Display" of the Cisco/Polycom Rooms.
enable_1080p

boolean — The setting "Enable 1080P" of the Cisco/Polycom Rooms.
enable_automatic_join

boolean — The setting "Automatic Join" of the Cisco/Polycom Rooms.
enable_automatic_leave

boolean — The setting "Automatic Leave" of the Cisco/Polycom Rooms.
enable_obtp

boolean — The setting "Enable OBTP" of the Cisco Rooms.
enable_sip_tls_certificate_verification

boolean — The setting "Enable Sip TLS Vertificate Verification" of the Cisco/Polycom Rooms.
enable_upcoming_meeting_reminder

boolean — The setting "Upcoming Meeting Reminder" of the Cisco/Polycom Rooms.
exclude_all_day_event

boolean — The setting "Exclude All Day Events" of Cisco Rooms.
extra_provisioning

string — The setting "Advanced Provisioning" of the Cisco/Polycom Rooms. Should be a JSON string.
force_720p

boolean — The setting "Limit CRC Maximum Transmit Video Resolution to 720p" of the Cisco/Polycom Rooms.
h323_gatekeeper

string, possible values: "Enabled, not registered", "Not supported by device model", "Custom registration", "Not provisioned by Zoom", "Disable" — The setting "H.323 Gatekeeper" of the Cisco/Polycom Rooms.
h323_mode

boolean — The setting "H.323 Mode" of the Cisco/Polycom Rooms.
hide_agenda

boolean — The setting "Hide Agenda" of the Cisco/Polycom Rooms.
hide_topic

boolean — The setting "Hide Topic" of the Cisco/Polycom Rooms.
high_quality_content_sharing

boolean — The setting "High-quality Content Sharing" of the Cisco/Polycom Rooms.
join_before_time

integer — The minute of joining meeting before the start of the meeting.
join_bluejeans

boolean — The setting "Join BlueJeans" of the Cisco/Polycom Rooms.
join_meeting_with_dtmf

boolean — The setting "Join Meeting with DTMF" of the Cisco/Polycom Rooms.
join_webex

boolean — The setting "Join Webex" of the Cisco/Polycom Rooms.
label_for_ad_hoc_button

string — The setting "Label for ad hoc Button" of the Cisco/Polycom Rooms.
leave_after_time

integer — The minute of leaving after the meeting ends.
manage_type

string, possible values: "Full Management", "SIP Proxy" — The manage type of the Cisco/Polycom Rooms.
music_mode

boolean — The setting "Music Mode" of the Cisco/Polycom Rooms.
name

string — The name of the Cisco/Polycom Rooms Template.
optimize_content_sharing_for_video

boolean — The setting "Optimize Content Sharing for Video" of the Cisco/Polycom Rooms.
out_of_band_dtmf

boolean — The setting "Out-of-Band DTMF" of the Cisco/Polycom Rooms.
reminder_before_time

integer — The minute of showing reminder before the next meeting.
remove_audio_prompt_on_join

boolean — The setting "Remove Audio Prompts on Join" of the Cisco/Polycom Rooms.
set_zoom_cloud_sip_proxy_region

string — The setting - *Set Zoom cloud SIP proxy region*.
sip_call_control_registration

string, possible values: "Enabled, not registered", "Zoom Rooms", "Register to Zoom", "Register to 3rd Party", "Dual register, 3rd Party and Zoom", "Hybrid mode, register to 3rd Party and call on demand to Zoom", "Not provisioned by Zoom", "Disable" — The setting "SIP Call Control Registration" of the Cisco/Polycom Rooms.
sip_mode

boolean — The setting "SIP Mode" of the Cisco/Polycom Rooms.
time_format

string, possible values: "12H", "24H", "Not provisioned by Zoom" — The time format of the Cisco/Polycom Rooms.
time_server

string — The alternate time server of the Cisco/Polycom Rooms.
time_zone

string — The time zone of the Cisco/Polycom Rooms. For a list of supported timezones and their formats, see our [timezone list]( https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
unmute_on_entry

boolean — The setting "Unmute on Entry" of the Cisco/Polycom Rooms.
video_mute_input

string — The setting "Video Mute Input" of Polycom HDX Rooms.
webex_meeting_id

string — The setting "Webex Meeting Id" of the Cisco/Polycom Rooms.
webex_site_name

string — The setting "Webex Site Name" of the Cisco/Polycom Rooms.

Example:

{
  "name": "my room",
  "device_management": false,
  "manage_type": "Full Management",
  "device_type": "Cisco Series",
  "time_zone": "America/Chicago",
  "time_format": "24H",
  "time_server": "pool.ntp.org,time.nist.gov",
  "join_meeting_with_dtmf": false,
  "always_show_join_button": false,
  "adhoc_join_meet_now_location": "Favorites",
  "label_for_ad_hoc_button": "Join Zoom Meeting",
  "enable_1080p": false,
  "unmute_on_entry": false,
  "default_video_layout": "Gallery",
  "high_quality_content_sharing": false,
  "enable_upcoming_meeting_reminder": false,
  "reminder_before_time": 10,
  "enable_automatic_join": false,
  "join_before_time": 10,
  "enable_automatic_leave": false,
  "leave_after_time": 10,
  "force_720p": false,
  "bandwidth_allocation_preference": "Off",
  "out_of_band_dtmf": false,
  "remove_audio_prompt_on_join": false,
  "music_mode": false,
  "optimize_content_sharing_for_video": false,
  "audio_gain_control": "Use Audio Level 2",
  "display_layout": "Default",
  "closed_caption_position": "Bottom",
  "additional_dtmf_command": "309",
  "call_rate": "384",
  "join_bluejeans": false,
  "join_webex": false,
  "webex_meeting_id": "Xkjnby8g9jgIth",
  "webex_site_name": "name",
  "hide_topic": false,
  "hide_agenda": false,
  "default_topic": "topic A",
  "default_zoom_topic": "zoom topic A",
  "enable_obtp": false,
  "exclude_all_day_event": false,
  "video_mute_input": "2",
  "sip_mode": false,
  "sip_call_control_registration": "enable",
  "h323_mode": false,
  "h323_gatekeeper": "enable",
  "call_controller_protocol_to_zoom_meeting": "SIP",
  "dial_using_numeric_dial_plan": "numeric",
  "enable_sip_tls_certificate_verification": false,
  "alternative_room_connector": "US",
  "extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}",
  "set_zoom_cloud_sip_proxy_region": "US"
}

Responses

Status: 204 HTTP Status Code: `204` No Content.

Status: 400 HTTP Status Code: `400` Bad Request Error Code: `60061021` Invalid Parameter.

Status: 401 HTTP Status Code: `401` Unauthorized

Status: 404 HTTP Status Code: `404` Not Found Error Code: `60061043` Template Not Exist.

Status: 429 HTTP Status Code: `429` Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Conference Room Connector

Servers

Operations

Get Cisco/Polycom Room Account Setting

Responses

Status: 200 **HTTP Status Code:** `200` Account setting returned.

Content-Type: application/json

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized **Error Code:** `60061001` <br> Account Not Exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update Cisco/Polycom Room Account Setting

Request Body

Content-Type: multipart/form-data

Responses

Status: 204 **HTTP Status Code:** `204` No Content.

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `60071011` <br> Invalid Parameter. <br> **Error Code:** `60067099` <br> Unknown Error. <br>

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized **Error Code:** `60061001` <br> Account Not Exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List API Connectors

Responses

Status: 200 **HTTP Status Code:** `200` List API Connectors returned.

Content-Type: application/json

Status: 400 **HTTP Status Code:** `400` <br> Bad Request

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create an API Connector

Request Body

Content-Type: application/json

Responses

Status: 201 **HTTP Status Code:** `201` API Connector created successfully.

Content-Type: application/json

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `60071011` <br> Invalid Parameter <br> **Error Code:** `60071007` <br> Ip Range Overlaps <br> **Error Code:** `60067099` <br> Unknown Error <br>

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get an API Connector

Responses

Status: 200 **HTTP Status Code:** `200` An API connector returned.

Content-Type: application/json

Status: 400 **HTTP Status Code:** `400` <br> Bad Request

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `60071008` <br> Connector does not exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Delete an API Connector

Responses

Status: 204 **HTTP Status Code:** `204` Successfully deleted.

Status: 400 **HTTP Status Code:** `400` <br> Bad Request

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `60071008` <br> Connector does not exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update an API Connector

Request Body

Content-Type: application/json

Responses

Status: 204 **HTTP Status Code:** `204` No content.

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `60071011` <br> Invalid parameter. <br> **Error Code:** `60071007` <br> IP range overlaps. <br> **Error Code:** `60067099` <br> Unknown Error. <br>

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `60061003` <br> Device does not exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get an API Connector's private key

Responses

Status: 200 **HTTP Status Code:** `200` A private key returned.

Content-Type: application/json

Status: 400 **HTTP Status Code:** `400` <br> Bad Request

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `60071008` <br> Connector does not exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update an API Connector's private key

Responses

Status: 200 **HTTP Status Code:** `200` A private key returned.

Content-Type: application/json

Status: 400 **HTTP Status Code:** `400` <br> Bad Request

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `60071008` <br> Connector does not exist. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List Managed Rooms

Responses

Status: 200 **HTTP Status Code:** `200` List Managed Rooms returned.

Content-Type: application/json

Status: 401 **HTTP Status Code:** `401` <br> Unauthorized

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create a Managed Room

Request Body

Status: 200 HTTP Status Code: `200` Account setting returned.

Status: 401 HTTP Status Code: `401` <br> Unauthorized Error Code: `60061001` <br> Account Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` No Content.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60071011` <br> Invalid Parameter. <br> Error Code: `60067099` <br> Unknown Error. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized Error Code: `60061001` <br> Account Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` List API Connectors returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 201 HTTP Status Code: `201` API Connector created successfully.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60071011` <br> Invalid Parameter <br> Error Code: `60071007` <br> Ip Range Overlaps <br> Error Code: `60067099` <br> Unknown Error <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` An API connector returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60071008` <br> Connector does not exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60071008` <br> Connector does not exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` No content.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60071011` <br> Invalid parameter. <br> Error Code: `60071007` <br> IP range overlaps. <br> Error Code: `60067099` <br> Unknown Error. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061003` <br> Device does not exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` A private key returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60071008` <br> Connector does not exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` A private key returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60071008` <br> Connector does not exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` List Managed Rooms returned.

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 201 HTTP Status Code: `201` A Cisco/Polycom Room created successfully.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60071011` <br> Invalid Parameter. <br> Error Code: `60067099` <br> Unknown Error. <br> Error Code: `60071007` <br> IP Range Overlaps. <br> Error Code: `60061007` <br> Serial Number exist. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` A Cisco or Polycom Room returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60061021` <br> Invalid Parameter. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061003` <br> Device Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061003` <br> Device Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` No Content.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60071011` <br> Invalid Parameter. <br> Error Code: `60067099` <br> Unknown Error. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061003` <br> Device Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 403 HTTP Status Code: `403` <br> Forbidden

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` List Room Templates returned.

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 201 HTTP Status Code: `201` A Cisco/Polycom Room Template created successfully.

Status: 400 HTTP Status Code: `400` <br> Bad Request Error Code: `60061021` <br> Invalid Parameter. <br>

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 200 HTTP Status Code: `200` A Cisco/Polycom Room Template returned.

Status: 400 HTTP Status Code: `400` <br> Bad Request

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061043` <br> Template Not Exist. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Status: 204 HTTP Status Code: `204` Successfully deleted.

Status: 401 HTTP Status Code: `401` <br> Unauthorized

Status: 404 HTTP Status Code: `404` <br> Not Found Error Code: `60061043` <br> Template Not Found. <br>

Status: 429 HTTP Status Code: `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).