Zoom Enhanced API Connector (Cisco H.323/SIP Device Settings)
When a Cisco H.323/SIP device is managed by the Zoom Enhanced API Connector, specific settings on the Cisco device will be adjusted. The device settings that are altered will depend on the settings configured in the Zoom admin portal. This section outlines 3 call control/SIP proxy registration scenarios to illustrate this process.
The Zoom Admin portal section describes Cisco H.323/SIP video conferencing device configurations that are modified by common settings changes in the Cisco/Polycom Rooms section of the Zoom admin portal.
Using Zoom-provided call control (Zoom cloud SIP proxy)
In this scenario, a Cisco device is using Zoom-provided call control, in the form of Zoom’s cloud SIP proxy. This scenario assumes the use of default Cisco & Polycom Room account-level settings.
At the individual room level, the following configurations have been applied in this scenario.
Rooms Profile
Room Name (required)
All other settings are set to defaults
Meeting
No calendar integration configured
All settings are set to defaults
H.323/SIP Integration
SIP Call Control Configuration: set to “Register to Zoom”
H.323 Mode: set to disabled
H.323 Gatekeeper: set to “Not provisioned by Zoom”
All other settings are set to defaults
Advanced
All settings set to defaults
With this configuration, the following Cisco device configurations are modified (Names in the Cisco Setting Item column are taken from a Cisco device backup file):
SIP Authentication Password
<blank>
[varies]
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy.
SIP Authentication UserName
<blank>
[serial number]@cisco-device
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy.
SIP DefaultTransport
Auto
Tls
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to “TLS” to use TLS for SIP connectivity to Zoom’s cloud SIP proxy.
SIP DisplayName
<blank>
[the configured Room Name]
SIP/H.323 Integration > SIP Call Control Configuration
Rooms Profile > Room Name
Zoom provisions this setting to the configured Room Name so that when the device joins a Zoom meeting, it will be named appropriately in the participants list and on its video tile in the video layout for other meeting participants.
SIP Proxy Address
<blank>
us01sipproxy.zoom.us
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy.
SIP TlsVerify
On
Off
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to “Off” because endpoints on older firmware may not have current security certificates. If TlsVerify were “On,” the endpoint may be blocked from registering.
SIP URI
<blank>
[serial number]@cisco-device
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy.
SystemUnit Name
<blank>
[the configured Room Name]
Rooms Profile > Room Name
Zoom provisions this setting to the configured Room Name so that the Cisco device UI shows the Room Name.
Other common system configurations include the following (see Zoom Admin portal section for details):
Rooms Profile
Time Zone
Time Format
Meeting
Calendar Resources
Join Meeting with DTMF
Call Rate
Using Zoom-provided call control (Zoom cloud SIP proxy + Zoom Phone)
In this scenario, a Cisco H.323/SIP video conferencing device is using Zoom-provided call control in the form of Zoom’s cloud SIP proxy. The Cisco device is also configured with Zoom Phone.
This scenario assumes the use of default Cisco & Polycom Room account-level settings.
At the individual room level, the following configurations have been applied in this scenario.
Rooms Profile
Room Name (required)
All other settings are set to defaults
Meeting
No calendar integration configured
All settings set to defaults
H.323/SIP Integration
SIP Call Control Configuration: set to “Register to Zoom”
H.323 Mode: set to disabled
H.323 Gatekeeper: set to “Not provisioned by Zoom”
All other settings are set to defaults
Advanced
All settings are set to defaults
With this configuration, the following Cisco device configurations are modified (the names in the Cisco Setting Item column are taken from a Cisco device backup file):
SIP Authentication Password
<blank>
[varies]
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy
SIP Authentication UserName
<blank>
[number]
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy with Zoom Phone features
SIP DefaultTransport
Auto
Tls
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to “TLS” to use TLS for SIP connectivity to Zoom’s cloud SIP proxy
SIP DisplayName
<blank>
[the configured Room Name]
SIP/H.323 Integration > SIP Call Control Configuration
Rooms Profile > Room Name
Zoom provisions this setting to the configured Room Name so that when the device joins a Zoom meeting, it will be named appropriately in the participants list and on its video tile in the video layout for other meeting participants.
SIP Proxy Address
<blank>
[varies]
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy with Zoom Phone features.
SIP TlsVerify
On
Off
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to “Off” because endpoints on older firmware may not have current security certificates. If TlsVerify were “On,” the endpoint may be blocked from registering.
SIP URI
<blank>
[varies]
SIP/H.323 Integration > SIP Call Control Configuration
Zoom provisions this setting to support SIP registration to Zoom’s SIP cloud proxy with Zoom Phone features.
SystemUnit Name
<blank>
[the configured Room Name]
Rooms Profile > Room Name
Zoom provisions this setting to the configured Room Name, so that the Cisco device UI shows the Room Name.
Other common system configurations include the following (see Zoom Admin portal section for details):
Rooms Profile
Time Zone
Time Format
Meeting
Calendar Resources
Join Meeting with DTMF
Call Rate
Using third-party call control (“not provisioned by Zoom”)
In this scenario, a Cisco H.323/SIP video conferencing device is using third-party call control in the form of registration to Cisco cloud services (Cisco Webex Control Hub). This scenario assumes the use of default Cisco & Polycom Room account-level settings.
At the individual room level, the following configurations have been applied in this scenario.
Rooms Profile
Room Name (required)
All other settings are set to defaults
Meeting
No calendar integration configured
All settings set to defaults
H.323/SIP Integration
SIP Mode: set to disabled
SIP Call Control Configuration: set to “Not provisioned by Zoom”
H.323 Mode: set to disabled
H.323 Gatekeeper: set to “Not provisioned by Zoom”
All other settings are set to defaults
Advanced
All settings set to defaults
With this configuration, the following Cisco device configurations are modified (the names in the Cisco Setting Item column are taken from a Cisco device backup file):
SystemUnit Name
<blank>
[the configured Room Name]
Rooms Profile > Room Name
Zoom provisions this setting to the configured Room Name so that the Cisco device UI shows the Room Name.
Other common system configurations include the following (see Zoom Admin portal section for details):
Rooms Profile
Time Zone
Time Format
Meeting
Calendar Resources
Join Meeting with DTMF
Call Rate
Cisco device configurations are modified by settings in the Cisco/Polycom Rooms section of the Zoom admin portal
This section describes common configuration changes in the Cisco & Polycom Rooms section of the Zoom admin portal and how they affect the configuration of Cisco H.323/SIP video conferencing devices.
The names in the Cisco Setting Item column in the table below are taken from a Cisco device backup file. The Cisco Default Value column is based on the configuration of a Cisco device that has been factory reset and taken through the out-of-the-box wizard with default selections, where possible.
Rooms Profile Settings in the Zoom web portal
Room Name
SystemUnit Name
<blank>
[the configured Room Name]
Time Zone
Time Zone
Etc/UTC
<varies>
Time Format
Time TimeFormat
24H
12H | 24H
Alternate Time Server
NetworkServices NTP Mode
NetworkServices NTP Server 1 Address
Auto
0.tandberg.pool.ntp.org
Manual
[customer provided address]
This setting has no direct effect on devices registered to Cisco cloud services.
Meeting Settings in the Zoom web portal
Calendar Resources
n/a
n/a
[customer provided address]
This setting has no direct effect on Cisco device configuration.
Personal Meeting ID for Room
n/a
n/a
[customer provided meeting ID]
Join Meeting with DTMF
n/a
n/a
n/a
This setting may cause a new item to appear in the Favorites (and therefore phonebook). See the Ad-hoc Join/meet Now location for more details.
Always Show Join Button
n/a
n/a
n/a
This setting will cause calendar events with no recognized meeting join information to offer a join button that, when pressed, dials the equivalent of the Favorite for ad-hoc join destination.
Ad-hoc Join/meet Now location
If set to Favorites, a new item will appear in the Favorites (and therefore phonebook) of the Cisco device. The title is configured by the setting Label for ad hoc Button. The XML for the phonebook entry can be found in the Favorite for ad-hoc join section.
Unmute on Entry
n/a
n/a
n/a
This setting adds SIP Dial Code “12” to the Favorite for ad-hoc join and calendar join button calls for Zoom meetings.
High-quality Content Sharing
n/a
n/a
n/a
This setting adds SIP Dial Code “100001” to the Favorite for ad-hoc join and calendar join button calls for Zoom meetings.
Upcoming Meeting Reminder
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings.
Automatic Join
n/a
n/a
n/a
If calendar integration is enabled, this setting causes the Cisco device to automatically start calendar events at the event start time.
Enable OBTP
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings, but if calendar integration is enabled, this setting causes the Enhanced API Connector to insert bookings corresponding to calendar events on the associated calendar resource’s calendar.
Automatic Leave
n/a
n/a
n/a
If calendar integration is enabled, this setting causes the Cisco device to automatically leave calendar events at the event end time.
Prioritize highest resolution (max 720p)
n/a
n/a
n/a
This setting adds SIP Dial Code “100003” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Bandwidth Allocation Preference: Content vs. Video >
Prioritize video over content
n/a
n/a
n/a
This setting adds SIP Dial Code “100004” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Bandwidth Allocation Preference: Content vs. Video >
Split video and content equally
n/a
n/a
n/a
This setting adds SIP Dial Code “100005” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Bandwidth Allocation Preference: Content vs. Video >
Prioritize content over video
n/a
n/a
n/a
This setting adds SIP Dial Code “100006” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Out-of-Band DTMF
n/a
n/a
n/a
This setting adds SIP Dial Code “200001” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Remove Audio Prompts on Join
n/a
n/a
n/a
This setting adds SIP Dial Code “200006” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Music Mode
n/a
n/a
n/a
This setting adds SIP Dial Code “306” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Video Sharing Mode
n/a
n/a
n/a
This setting adds SIP Dial Code “200009” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Exclude All Day Events
n/a
n/a
n/a
If calendar integration is enabled, this setting causes the Enhanced API Connector to ignore “all day” events when reading the calendar resource calendar associated with the Cisco device.
Audio Level > Use Audio Level 1
n/a
n/a
n/a
This setting adds SIP Dial Code “300001” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Audio Level > Use Audio Level 2
n/a
n/a
n/a
This setting adds SIP Dial Code “300002” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Audio Level > Use Audio Level 3
n/a
n/a
n/a
This setting adds SIP Dial Code “300003” to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Additional DTMF Command
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings, but if used, it will add the specified SIP Dial Code(s) to the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Call Rate
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings, but if used, it will cause the specified call rate to be used for the “Favorite for ad-hoc join”.
Join Webex
n/a
n/a
n/a
This setting causes a new item to appear in the “Favorites” (and therefore phonebook). See “Favorite for Webex” for details.
Webex Meeting ID
n/a
n/a
n/a
This setting forms the “user” portion of the URI used by the “Favorite for Webex.”
Webex Site URL
n/a
n/a
n/a
This setting forms the “domain” portion of the URI used by the “Favorite for Webex.”
Hide Topic
n/a
n/a
n/a
If calendar integration is enabled, this setting causes the Enhanced API Connector to suppress the meeting topic/subject when reading the calendar resource calendar associated with the Cisco device.
Hide Agenda
n/a
n/a
n/a
If calendar integration is enabled, this setting causes the Enhanced API Connector to suppress the meeting body/comment when reading the calendar resource calendar associated with the Cisco device.
Default Topic
n/a
n/a
n/a
If calendar integration and “Hide Topic” are enabled, this setting causes the Enhanced API Connector to replace the meeting topic/subject with the supplied value for calendar events that are not detected to have any meeting information.
Default Topic (Zoom)
n/a
n/a
n/a
If calendar integration and “Hide Topic” are enabled, this setting causes the Enhanced API Connector to replace the meeting topic/subject with the supplied value for calendar events detected as containing Zoom meeting information.
H.323/SIP Integration Settings in the Zoom web portal
SIP Mode
NetworkServices SIP Mode
On
On | Off
SIP Call Control Registration > Enabled, not registered
SIP Authentication UserName
SIP DefaultTransport
SIP DisplayName
SIP Proxy 1 Address
SIP TlsVerify
SIP URI
<blank>
Auto
<blank>
<blank>
On
<blank>
<blank>
Tls
[Room name]
<blank>
Off
[serial number]@cisco-device
This setting will overwrite existing SIP settings if they vary from the defaults.
SIP Call Control Registration > Enabled, Register to Zoom
SIP Authentication Password
SIP Authentication UserName
SIP DefaultTransport
SIP DisplayName
SIP Proxy 1 Address
SIP TlsVerify
SIP URI
<blank>
<blank>
Auto
<blank>
<blank>
On
<blank>
[varies, redacted]
<blank>
Tls
[Room name]
us01sipproxy.zoom.us
Off
[serial number]@cisco-device
Zoom provisions these settings to support SIP registration to Zoom’s cloud SIP proxy.
SIP Call Control Registration > Not provisioned by Zoom
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings.
SIP Call Control Registration > Enabled, Register to 3rd party
<varies>
<varies>
<varies>
This setting allows manual provisioning of several Cisco device SIP configurations.
H.323 Mode
NetworkServices H323 Mode
On
On | Off
This setting has no direct effect on devices registered to Cisco cloud services
H.323 Gatekeeper > Enabled, not registered
n/a
n/a
n/a
This setting has no direct effect on devices registered to Cisco cloud services
H.323 Gatekeeper > Not supported by device model
n/a
n/a
n/a
This setting has no direct effect on devices registered to Cisco cloud services
H.323 Gatekeeper > Not provisioned by Zoom
n/a
n/a
n/a
This setting has no direct effect on devices registered to Cisco cloud services
H.323 Gatekeeper > Custom registration
<varies>
<varies>
<varies>
This setting allows manual provisioning of several Cisco device SIP configurations.
Call Control Protocol to Zoom Meetings
n/a
n/a
n/a
If calendar integration or the “Favorite for ad-hoc join” is enabled, this setting controls what call control protocol is used by the Cisco endpoint to dial the calendar event or Favorite, respectively.
Dial Using Numeric Dial Plan
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings, but if set to numeric, will cause the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings and other types of calendar meetings to be dialed digits-only (no URI domain).
Advanced settings in the Zoom web portal
Alternative Room Connector
n/a
n/a
n/a
This setting modifies the Cloud Room Connector SIP domain used by the “Favorite for ad-hoc join” and calendar join button calls for Zoom meetings.
Connector
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings but modifies which Enhanced API Connector will manage the device.
Background Image
n/a
n/a
n/a
This setting has no direct effect on Cisco device settings but does affect the device branding, by replacing the default Cisco background image with the provided image file.
Capset Filter
Conference CapsetFilter
[the configured value]
This setting modifies the CapsetFilter used when negotiating SIP or H323 calls. This setting has no direct effect on devices registered to Cisco cloud services.
Advanced Provisioning
[varies]
[varies]
[varies]
Advanced provisioning commands may modify Cisco device settings.
The ad-hoc Favorite join button will connect your H.323/SIP video conferencing device to the Zoom CRC gateway to join Zoom Meetings
Using this Favorite button will initiate a call to the Zoom CRC meeting splash screen where a user may enter the Zoom Meeting ID and numeric passcode.
If the feature Join Meeting with DTMF is enabled and the Ad-hoc Join/meet Now location is set in the web portal, the Zoom Enhanced API Connector will automatically insert a phonebook entry into the device. The default “Label for ad hoc Button” is Join Zoom Meeting.
The SIP URI is constructed of multiple parts. The example below shows the default.
The “[security code]” portion changes randomly, with a lifetime of 2 hours—Zoom Enhanced API Connector will update the entry before it expires.
The “[domain]” depends on the setting Alternate Room Connector.
The Protocol varies based on the setting Call Control Protocol to Zoom Meetings.
The CallRate varies based on the setting Call Rate—the default is 1920.
Example: XML for Ad-hoc favorite button
<?xml version="1.0" encoding="UTF-8"?>
<Local Phonebook>
<Contact localId="localContactId-1" type="Person">
<DisplayName>Join Zoom Meeting</DisplayName>
<Tag>Favorite</Tag>
<ContactMethodGroup type="only_one_group">
<ContactMethod type="Video" localId="1">
<Uri>0.....[security code]@[domain]</Uri>
<Protocol>[varies]</Protocol>
<CallRate>[varies]</CallRate>
<CallType>Video</CallType>
</ContactMethod>
</ContactMethodGroup>
</Contact>
</LocalPhoneBook>
The Webex Favorite join button will connect your H.323/SIP video conferencing device to the Webex meeting interface
If the feature Join Webex is enabled and the related settings Webex Meeting ID and Webex Site URL are configured, Zoom Enhanced API Connector will automatically insert a phonebook entry with the name “Webex”.
The SIP URI is constructed of multiple parts - the “Webex Meeting ID” provides the “[user]” portion, while the “Webex Site URL” provides the “[domain]” portion.
The Protocol varies based on the setting Call Control Protocol to Zoom Meetings.
The CallRate varies based on the setting Call Rate—the default is 1920.
Using this Favorite will initiate a call to Webex.
Example: XML Webex Favorite Button
<?xml version="1.0" encoding="UTF-8"?>
<LocalPhoneBook>
<Contact localId="localContactId-1" type="Person">
<DisplayName>Webex</DisplayName>
<Tag>Favorite</Tag>
<ContactMethodGroup type="only_one_group">
<ContactMethod type="Video" localId="1">
<Uri>[user]@[domain]</Uri>
<Protocol>[varies]</Protocol>
<CallRate>[varies]</CallRate>
<CallType>Video</CallType>
</ContactMethod>
</ContactMethodGroup>
</Contact>
</LocalPhoneBook>
Calendar Invites
If the calendar integration feature is enabled, the Zoom Enhanced API Connector will automatically read the associated calendar resource and insert a BookingsList entry.
The “Title” may be overridden by the Zoom web portal setting Hide Topic.
The “Agenda” may be overridden by the Zoom web portal setting Hide Agenda.
The SIP URI is constructed of multiple parts. The example below shows the default.
The “[meeting ID]” and “[meeting passcode]” portions are based on the Zoom meeting information. The “[security code]” portion changes randomly, with a lifetime of two (2) hours - Zoom Enhanced API Connector will update the entry before it expires.
The “[domain]” depends on the setting Alternate Room Connector.
The Protocol varies based on the setting Call Control Protocol to Zoom Meetings.
The “MeetingPlatform” will be set to “Zoom” for Zoom meetings.
The CallRate varies based on the setting Call Rate—the default is 1920
Example: XML for Calendar Invites
<?xml version="1.0" encoding="UTF-8"?>
<Command>
<BookingsListResult status="OK">
<ResultInfo>
<TotalRows>1</TotalRows>
</ResultInfo>
<LastUpdated>[varies]</LastUpdated>
<Booking item="1" maxOccurrence="n">
<Id>[varies]</Id>
<MeetingId></MeetingId>
<Title>[varies]</Title>
<Agenda>[varies]</Agenda>
<Privacy>Public</Privacy>
<Organizer>
<FirstName>[varies]</FirstName>
<LastName>[varies]</LastName>
<Email>[varies]</Email>
<Id></Id>
</Organizer>
<Time>
<StartTime>[varies]</StartTime>
<StartTimeBuffer>1800</StartTimeBuffer>
<EndTime>[varies]</EndTime>
<EndTimeBuffer>1800</EndTimeBuffer>
</Time>
<MaximumMeetingExtension>5</MaximumMeetingExtension>
<MeetingExtensionAvailability></MeetingExtensionAvailability>
<BookingStatus>OK</BookingStatus>
<BookingStatusMessage></BookingStatusMessage>
<MeetingPlatform>Zoom</MeetingPlatform>
<Cancellable>False</Cancellable>
<Webex>
<Enabled>False</Enabled>
<Url></Url>
<MeetingNumber></MeetingNumber>
<Password></Password>
<HostKey></HostKey>
<DialInNumbers/>
</Webex>
<Encryption>BestEffort</Encryption>
<Recording>Disabled</Recording>
<DialInfo>
<Calls>
<Call item="1" maxOccurrence="n">
<Number>[meeting ID].[meeting passcode]....[security code]@[domain]</Number>
<CallType>Video</CallType>
</Call>
</Calls>
<ConnectMode>OBTP</ConnectMode>
</DialInfo>
</Booking>
</BookingsListResult>
</Command>
Last updated
Was this helpful?