Cisco Meeting Server 2.1 Customization Guidelines

Cisco Meeting Server 2.1 Customization Guidelines
Cisco Meeting Server
Cisco Meeting Server 2.1
Customization Guidelines
July 24, 2017
Cisco Systems, Inc.
www.cisco.com
Contents
Change History
4
1 Introduction
5
1.1 What’s new or changed in Cisco Meeting Server 2.1 that affects customization
5
1.2 License Keys
7
1.3 Web Server Requirements
7
1.4 Using this guide
7
2 WebRTC Client Customization
9
2.1 File Properties and Names
9
2.1.1 Sign-in page background image and logo
10
2.1.2 Join call pane colors
11
2.1.3 Other settings in sign_in_settings.json
14
2.2 Overview of Customization Procedure
3 Call Customization
3.1 IVR Message Customization
14
15
15
3.1.1 IVR Messages to be customized
15
3.1.2 Recording format for IVR messages
16
3.1.3 IVR background image properties
16
3.1.4 Overview of customization procedure
16
3.2 SIP/Lync Call Message Customization
17
3.2.1 Audio messages to be customized
17
3.2.2 Recording format for audio messages
19
3.2.3 Background image properties
20
3.2.4 Overview of customization procedure
21
4 Customizing the text shown in invitations
22
4.1 Creating the invitation_template.txt
22
4.1.1 Permitted conditional statements and placeholders
22
4.1.2 Example invitation template
23
4.2 Overview of customization procedure
24
5 Detailed Customization Procedure Using Postman
25
5.1 Setting up the web server
25
5.2 Using the API for branding
28
5.2.1 Installing Chrome Postman
Cisco Meeting Server 2.1 : Customization Guidelines
28
2
5.2.2 Applying branding to WebRTC clients
31
5.2.3 Applying branding to SIP calls and/or customized invitations
32
5.2.4 Applying branding to an IVR
35
Appendix A Using Other Popular API Tools
A.1 Using Firefox Poster
A.1.1 Applying branding to SIP calls using Firefox Poster
A.2 Using Chrome Advanced Rest Client
A.2.1 Applying branding to SIP calls using Chrome Advanced Rest Client
38
38
41
44
47
Cisco Legal Information
50
Cisco Trademark
51
Figures:
Figure 1: Overview of guides covering the Meeting Server
6
Figure 2: Creating zip file for Web RTC client assets
10
Figure 3: Example contents of sign_in_settings.json and resulting Join call panes
12
Cisco Meeting Server 2.1 : Customization Guidelines
3
Change History
Change History
Date
Change Summary
August 03, 2016
Rebranded for Cisco Meeting Server 2.0
December 20, 2016
Four additional .wav files for call branding in version 2.1; passcode_or_blank_
required_entry.wav, passcode_or_blank_timeout_entry.wav, meeting_
streamed.wav, meeting_streaming_ended.wav.
Cisco Meeting Server 2.1 : Customization Guidelines
4
1 Introduction
1 Introduction
The Cisco Meeting Server was formerly called the Acano Server. The Cisco Meeting Server can
be hosted on specific servers based on Cisco Unified Computing Server (UCS) technology as
well as on the Acano X-Series hardware, or on a specification-based VM server.
This document covers the features for customizing release 2.1 of the Meeting Server. These
features allow modification of the voice prompts, background images and logos, and the text
shown in invitations.
It follows on from the appropriate Deployment Guide (see Figure 1).
1.1 What’s new or changed in Cisco Meeting Server 2.1 that affects
customization
The following additions and changes have been made to version 2.1 that impact upon
customizing the Meeting Server.
n
From Meeting Server 2.1.2 the Meeting Server no longer supports the redesigned Web
Bridge 2.0. Instead it supports Web Bridge 1.9 which allows rebranding the background
image for the login page to the WebRTC app.
n
Additional voice prompts and background images are provided which allow new
combinations of URIs and passcodes, these alter the join meeting experience for participants
using SIP endpoints. These new voice prompts and background images can be customized,
see Section 3.2.
Cisco Meeting Server 2.1 : Customization Guidelines
5
1 Introduction
Figure 1: Overview of guides covering the Meeting Server
Cisco Meeting Server 2.1 : Customization Guidelines
6
1 Introduction
1.2 License Keys
Customization is controlled by license keys with different keys providing different levels of
customization.
The levels of customization supported are:
n
No key: control of the background image and logo on the WebRTC landing page of a single
Web Bridge via the Web Admin Interface; no API configuration is allowed
n
Single brand via API: only a single set of resources can be specified (1 WebRTC page, 1 set of
voice prompts ,1 invitation text etc). These resources are used for all spaces, IVRs and Web
Bridges.
n
Multiple brand via API: different resources can be used for different spaces, IVRs and Web
Bridges. These resources can be assigned at the system, tenant, space or IVR level.
To purchase license keys, contact your Cisco partner with the following information:
n
level of branding required (single/multiple)
n
MAC address of interface A on Cisco Meeting Server1000, Acano X series server or VM
server
Customization of the invitation text is available with single brand and multiple brand licenses.
1.3 Web Server Requirements
All the customizations described in this document require a directory on a web server on which
.wav, jpg, png or archive (e.g. zip) files can be stored. The web server must be reachable by the
Call Bridge, and must not require the Call Bridge to perform any form of HTTP authentication.
The import occurs when the Call Bridge first needs to use the customized files.
Note: If you require more than one customization; for example one per tenant, currently you
require a separate Web Bridge for each one. This can be a standalone Web Bridge on a VM
server.
1.4 Using this guide
Chapter 2 covers branding the WebRTC clients. It details the elements that can be branded on
WebRTC clients and explains how to customize the clients with your branding.
Chapter 3 covers branding the images and messages that participants see and hear when
dialing into an IVR or dialing directly into a space using a SIP endpoint or Lync.
Chapter 4 describes customizing the text shown in invitations which is sent to participants
inviting them to join a call or space. Cisco Meeting Server 2.1 : Customization Guidelines
7
1 Introduction
Chapter 5 provides a step by step procedure on customizing calls using the Chrome Postman
application.
As an alternative to Chrome Postman Appendix A details the steps on customizing calls using
Firefox Poster and Chrome Advanced Rest Client
Cisco Meeting Server 2.1 : Customization Guidelines
8
2 WebRTC Client Customization
2 WebRTC Client Customization
Note: Web Bridge 2.0, which was included in Meeting Server 2.1.0 and 2.1.1, cannot be
customized. If you are using Meeting Server 2.1.0 or 2.1.1 you cannot change the following
files: sign_in_background.jpg, sign_in_logo.png, sign_in_settings.json. From Meeting Server
2.1.2 the Meeting Server no longer supports the redesigned Web Bridge 2.0. Instead it supports
Web Bridge 1.9 which allows rebranding the background image for the login page to the
WebRTC app.
The recommended procedure for customization of the WebRTC client is via the API, which
requires a branding license (see Section 1.2).
Using the API allows customization of these elements of the WebRTC client:
n
sign in background image,
n
sign in dialog box – icon displayed,
n
sign in dialog box – colours used.
The branding files are held within an archive (zip) file stored on the web server. The location of
this resourceArchive is set via the API (a POST method to the "/webBridges" node or a PUT to a
"/webBridges/<web bridge id>").
The Call Bridge retrieves the archive file from the web server and pushes it to the Web Bridge to
be served. In the event of a failure (for example, if the configured URI can't be reached) an alarm
is displayed in the Web Admin Interface and on the API "/system/alarms" node, but users can
still log in using the WebRTC Client.
Note: Without a branding license you can only control the background image and logo on the
WebRTC landing page of a single Web Bridge, and this must be done via the Web Admin
Interface Configuration > General page.
2.1 File Properties and Names
The branding files must be placed together in an archive file such as a zip file. The total file size of
the zipped file must be less than 1MB. The zip file is retrieved by the Call Bridge and then used by
the Web Bridge to brand WebRTC client pages.
When you zip the files, do not zip the folder containing the branded files. If this is done, this will
create an extra layer of folder (zipped file -> folder -> branded files). Instead, highlight the
branded files and right-click to zip them (or open a zip application and zip the files together).
This will create a zipped file with the branded files without creating an extra layer of folder (e.g.
zipped file -> branded files).
Cisco Meeting Server 2.1 : Customization Guidelines
9
2 WebRTC Client Customization
For example, in Figure 2, WebRTC_client.zip folder contains the branded files so when
configuring for Web Bridge customization (either via the Web Admin or API), you can use the
path http://<webserver address>/Branding/webRTC_client.zip.
Figure 2: Creating zip file for Web RTC client assets
Table 1: Web RTC client assets
Use
Filename to use (filenames are case sensitive)
Sign in page background image
sign_in_background.jpg
Sign in page logo
sign_in_logo.png
Join call pane colors and other settings
sign_in_settings.json
2.1.1 Sign-in page background image and logo
The background image must be in .jpg format and the logo file must be in .png format.
Transparency in .png files is supported, and recommended, for the logo.
Maximum size for the background image is 1920 pixels wide and 1200 pixels high, and less
than 500 kB in size. It will be scaled isotropically and then cropped at either the right or bottom
to fit the browser window.
The recommended resolution for the logo image is 282 pixels wide by 68 pixels high; these
dimensions fill the space to the edges of the Sign in box horizontally and use the top half of the
space between the 'Join call / Sign in' and the Call id box. This file must be less than 250 kB in
size.
Cisco Meeting Server 2.1 : Customization Guidelines
10
2 WebRTC Client Customization
2.1.2 Join call pane colors
The colors used for the Join call pane are
controlled by the use of a .json file. Up to four
colors can be specified using the HTML
hexadecimal format. If any are missing, then
default colors are used.
Table 2: Color parameters for Join Call pane
Color
Description
Default
panelTopColor
Color used at top of panel.
#0387B9
panelBottomColor
Color used at bottom of panel.
#0387B9
panelForegroundTextColor
Color used for text shown on panel.
#FFFFFF
panelErrorTextColor
Color used for error text shown on panel.
#FFD200
panelHyperlinkTextColor
Color of link at bottom of panel, shown when user tries to join a call
with an incompatible browser and they’re prompted to use the
desktop client.
#FFFF00
footerBackgroundColor
Background color used for footer on sign in page, if displayed.
#49555F
footerTextColor
Color used for text in footer.
#FFFFFF
panelLoaderColor
Color used for spinning wheel when loading WebRTC client
#FFFFFF
panelShadeColor
Rgba color used for panel in browsers that do not support gradient.
Note: this is not HEX
00000000
ie8backgroundColor
Background color for IE8
#FFFFFF
Cisco Meeting Server 2.1 : Customization Guidelines
11
2 WebRTC Client Customization
Figure 3: Example contents of sign_in_settings.json and resulting Join call panes
{
"panelTopColor" : "#9540E4",
"panelBottomColor" : "#7FFF00",
"panelForegroundTextColor" : "#FFFFFF",
"panelErrorTextColor" : "#DD1600",
"panelHyperlinkTextColor" : "#C40B92",
"panelLoaderColor" : "#813131",
"footerColor" : "#FF8000",
"footerTextColor" : "#010101"
}
this uses:
panelTopColor
#9540E4 purple
panelBottomColor
#7FFF00 green
panelForegroundTextColor
#FFFFFF white
in addition, this uses:
panelErrorTextColor
Cisco Meeting Server 2.1 : Customization Guidelines
#DD1600 red
12
2 WebRTC Client Customization
and the spinning wheel uses:
panelLoaderColor
#813131 brown
this uses:
panelHyperlinkTextColor
#C40B92 purple
footerColor
#FF8000 orange
footerTextColorColor
#010101 black
Note: The sign_in_settings.json file must use straight quotes. If your system uses smart quotes
by default, be sure to change the setting.
Note: if you are testing your branding, be sure to refresh the page twice (or use CTRL+F5 on
Chrome) as the browser does not actually re-fetch images on a single refresh.
Cisco Meeting Server 2.1 : Customization Guidelines
13
2 WebRTC Client Customization
2.1.3 Other settings in sign_in_settings.json
Other settings in sign_in_settings.json are shown in the table below:
Table 3: Other parameters in sign_in_settings.json
Text of message
Description
Default
supportFirefox
supportSafari
supportInternetExplorer
Join conference by calling out to installed client
true,
true,
true
supportWebkitWebrtc
Join conference directly using webkit based
WebRTC browsers, for example Google Chrome
and Opera
true
showDialInformation
Show dial-in information in the footer of the web
page
true
showFooter
Show footer on Join call pane
true
2.2 Overview of Customization Procedure
The following steps provide an overview of the customization procedure, for a detailed
procedure refer to Chapter 5.
1. Create a zip archive file containing these files:
l
sign_in_background.jpg
l
sign_in_logo.png
l
sign_in_settings.json
2. On the web server create a directory for the customization files and place the zip file in it.
3. Using the API, create a webBridge node specifying the resourceArchive field and URL on the
web server where the zip file is held. (See the Section 5.2.2 for details). The Meeting Server
uses these details to retrieve the zip file from the web server.
Note: you can only apply one archive file per Web Bridge.
Note: If you specify a port value in the path, this will be used in place of the default port values of
:80 for http and :443 for https. If you do not specify a port value then the default value will be
used. If you specify a port value make sure that the web server used in step 2 is listening on this
port.
Cisco Meeting Server 2.1 : Customization Guidelines
14
3 Call Customization
3 Call Customization
There are two types of call customization:
n
Messages heard and image seen when dialing into an IVR
n
Messages heard and images seen when dialing directly as a SIP (including Lync) call into a
space on a Meeting Server
Note: The use of API objects /ivrBrandingProfiles and /callBrandingProfiles requires a branding
license.
3.1 IVR Message Customization
The messages heard when calling an IVR can be customized via the API by using the
ivrBrandingProfile. This profile replaces the Custom In-call Resources Location field in the Web
Admin Interface Configuration > General page. This profile can be applied at the system level,
on a per-tenant basis or for individual IVRs.
3.1.1 IVR Messages to be customized
The following table lists all the IVR messages required for and the associated filenames to use
for the recordings.
Table 4: IVR messages for customization
Text of message
Filename to use (filenames are case
sensitive)
Played when ......
Please enter the call ID, followed
by the '#'(pound) key.
ivr_id_entry.wav
dialling via IVR to enter a
specific space
Unable to recognize that call ID.
Please try again.
ivr_id_incorrect_try_again.wav
the incorrect call ID is entered
to join the space
Please try again: this is your last
attempt.
ivr_id_incorrect_final_attempt.wav
two incorrect pins/call ID’s
have been entered to join the
space
Unable to recognize that call ID.
Goodbye.
ivr_id_incorrect_goodbye.wav
entering three incorrect call
ID’s to join the space
Welcome to a Cisco meeting.
ivr_welcome.wav
joining a space
Unable to connect you. Goodbye.
ivr_timeout.wav
after dialling via IVR and not
entering the call ID, the call
times out
Cisco Meeting Server 2.1 : Customization Guidelines
15
3 Call Customization
3.1.2 Recording format for IVR messages
Use audio files created with Audacity and saved as a single track PCM16, at 8, 16, 22.05, 32,
44.1 or 48 kHz sample rate, 16 bits per sample and mono. The file size for each recording must
be less than 400kB.
Note: We have not tested other audio tools and, if used, they may cause problems.
Note: It is not necessary to include any additional periods of silence at the start or end of these
prompts.
3.1.3 IVR background image properties
The background image file must be .jpg format, less than 500kB in size and a maximum of 1920
pixels wide by 1200 pixels. Images will be centered, scaled and padded with black to preserve
their aspect ratio. Progressive JPEG is not supported.
Table 5: IVR background image for customization
Image use
Filename to use (filenames are case sensitive)
IVR background image
ivr_background.jpg
3.1.4 Overview of customization procedure
The following steps provide an overview of the customization procedure, for a detailed
procedure refer to Chapter 5.
Note: Please ensure that your web server is configured correctly with the proper MIME type for
the WAV and JPEG file extensions (e.g. audio/wav and image/jpeg MIME type).
1. On the web server create a directory for the IVR customization files and place in it all the files
listed in Section 3.1.1 and Section 3.1.3. Do not zip these files
Cisco have created an archive with their audio and video files. These can be individually used
when a mix of custom and default files are required. The necessary files must be copied into
the directory.
If any files are missing then no alternative or default file will be used in their place.
2. Using the API, create an ivrBrandingProfile specifying the resourceLocation field and URL on
the web server where the customized ivr files are held. (See Section 5.2.4 for details). The
Meeting Server uses these details to retrieve the files from the web server.
3. Use this ivrBrandingProfile to customize your calls on:
Cisco Meeting Server 2.1 : Customization Guidelines
16
3 Call Customization
a. a system level (that is, as part of the global systems profile)
b. a per-tenant basis (as part of the tenant definition)
c. a per-IVR basis (as part of an IVR definition)
Note: When the multi brands feature key is present and the IVR branding is applied at more
than one level then the lowest level ivrBrandingProfile defined is the one that it used in a call
leg. If the single brand feature key is present then only the system level ivrBrandingProfile is
used. See the Using Profiles section in the API Reference.
3.2 SIP/Lync Call Message Customization
This section describes how to customize the in-call experience when dialing into a Meeting
Server space from a SIP or Lync endpoint.
Note: If you change the background image or the audio messages, then the images and audio
files will not be utilized until cache memory has expired on your web server, and any calls utilizing
call branding have completed.
If the format of your replacement audio files is invalid, then after the cache has expired the web
server will play nothing.
3.2.1 Audio messages to be customized
The following list is all the audio messages required for and the associated filenames to use for
the recordings.
Cisco Meeting Server 2.1 : Customization Guidelines
17
3 Call Customization
Table 6: SIP call messages for customization
Filename to use (filenames are
case sensitive)
Repeats for
audio calls
Played when ......
Welcome to a
Cisco meeting
welcome.wav
No
joining a call
I haven't been
able to connect
you. Goodbye.
timeout.wav
No
after dialling via an IVR and not entering
the call id, the call times out
Press '1' to join
the call.
call_join_confirmation.wav
No
You are joining
the call now.
call_join.wav
No
Hello. You are
invited to a
Cisco call.
call_outgoing_welcome.wav
No
Press '1' to
enter the
meeting.
cospace_join_confirmation.wav
No
calling a phone number from a space
You are
entering the
meeting now.
cospace_join.wav
No
after dialling the URI of a space from a
SIP endpoint, or after dialling the IVR
and entering the call ID of the space
(plays after PIN if space has a PIN)
Hello. You are
invited to a
Cisco meeting.
cospace_outgoing_welcome.wav
No
calling a mobile from a space
You have been
disconnected
from the
meeting
disconnected.wav
No
the participant has been disconnected
from the meeting.
This meeting is
being recorded
meeting_recorded.wav
No
recording starts or when joining a call
that is being recorded
This meeting is
no longer being
recorded
meeting_recording_ended.wav
No
recording ends
This meeting is
being streamed
meeting_streamed.wav
No
streaming starts (from version 2.1)
This meeting is
no longer being
streamed
meeting_streaming_ended.wav
No
streaming stops (from version 2.1)
Text of message
Cisco Meeting Server 2.1 : Customization Guidelines
18
3 Call Customization
Filename to use (filenames are
case sensitive)
Repeats for
audio calls
Played when ......
Your meeting
has ended
meeting_ended.wav
No
the meeting has ended.
You are the only
participant
only_participant.wav
Yes
there is only one participant in the
meeting.
Please enter the
PIN, followed by
the '#'(pound)
key.
passcode_entry.wav
No
a PIN is required to enter the space
Please enter the
PIN, followed by
the '#'(pound)
key.
passcode_or_blank_required_
entry.wav
No
a PIN is required for the host to enter the
space as host, but guests only need to
use the # (pound) key (from version 2.1)
Please enter the
PIN, followed by
the '#'(pound)
key.
passcode_or_blank_timeout_
entry.wav
No
a PIN is required for the host to enter the
space as host, but guests join after a
short timeout (from version 2.1)
That PIN isn't
correct. Please
try again.
passcode_incorrect_try_
again.wav
No
the incorrect PIN is entered to join the
space
Please try again:
this is your last
attempt.
passcode_incorrect_final_
attempt.wav
No
two incorrect PINs/call ID’s have been
entered to join the space
That PIN isn't
correct.
Goodbye.
passcode_incorrect_goodbye.wav
No
after entering three incorrect PINs to
join the space
Waiting for your
host to join
waiting_for_host.wav
Yes
while waiting for the meeting host to join
Text of message
Note: The voice prompts labeled as repeating are played repeatedly for audio callers. They are played a single time
for video callers. To prevent voice prompts that are repeated from sounding repetitive, record a quiet period (2 to
3 seconds, or longer if you want them to repeat less frequently) after the voice.
Note: participant_join.wav and participant_leave.wav are joining and leaving tones respectively, to indicate that a
participant has joined or left the space; neither tone can be customized.
3.2.2 Recording format for audio messages
If you plan to record your own audio messages, then save each prompt as type “WAV
(Microsoft) signed 16 bit PCM”. Audio files can be converted into the correct format using
Audacity. The project rate should be one of 8000, 16000, 22050, 32000, 44100, 48000 Hz.
If creating files using another application, the output must be:
Cisco Meeting Server 2.1 : Customization Guidelines
19
3 Call Customization
l
single track PCM format
l
16 bits per sample
l
Mono
l
8, 16, 22.05, 32, 44.1 or 48 kHz sample rate
For recordings that repeat, the file size must be less than 1000kB. This is sufficient for 32
seconds when using a 16 kHz sample rate. The file size for all other recording must be less than
400kB
Note: We have not tested other audio tools and, if used, they may cause problems.
Note: It is not necessary to include any additional periods of silence at the start or end of the
prompts that do not repeat. For those that repeat, silence can be used to create a gap between
the instances.
3.2.3 Background image properties
The background file must be in .jpg format, less than 500kB in size and a maximum of 1920
pixels wide and 1200 pixels high. Images will be centered, scaled and padded to preserve their
aspect ratio. Progressive JPEG is not supported.
To enhance the pre-meeting experience for participants on SIP calls (including Lync), the
Meeting Server supports two additional background images for the callBrandingProfiles API
method, see Table 7.
Table 7: SIP call background image for customization
Image use
Filename to use (filenames are case sensitive)
Call logo
background.jpg
Screen can be shown when a PIN needs to be entered.
passcode_background.jpg
Screen can be shown when a PIN is required for the host
to enter the space as host, but guests only need to use the
# (pound) key (from version 2.1)
passcode_or_blank_required_background.jpg
Screen can be shown when a PIN is required to enter the
coSpace as host, but guests join after a short timeout (from
version 2.1)
passcode_or_blank_timeout_background.jpg
Screen can be shown when awaiting activation, (waiting for
host to join, meeting needs to be unlocked etc).
deactivated_background.jpg
Note: The behaviour and choice of background image for /callBrandingProfiles does not affect
the /ivrBrandingProfiles
Cisco Meeting Server 2.1 : Customization Guidelines
20
3 Call Customization
3.2.4 Overview of customization procedure
The following steps provide an overview of the customization procedure, for a detailed
procedure refer to Chapter 5.
Note: Please ensure that your web server is configured correctly with the proper MIME type for
the WAV and JPEG file extensions (e.g. audio/wav and image/jpeg MIME type).
1. On the web server create a directory for the customization files and place in it all the files
listed in Section 3.2.1 and Section 3.2.3. Do not zip these files.
Cisco has created an archive with their audio and video files. These can be individually used
when a mix of custom and default files are required. The necessary files must be copied into
the directory.
If any file is missing then no alternative or default file will be used in its place, except for
passcode_background.jpg and deactivated_background.jpg, see note below.
Note: If the passcode_or_blank_required_background.jpg, passcode_or_blank_timeout_
background.jpg, passcode_background.jpg and deactivated_background.jpg image files
are missing, then the background.jpg file (if present) will be used in place of the missing files.
You do not need to load multiple copies of background.jpg , the single file will be used
automatically to replace the missing images. If background.jpg is not present then the screen
remains black.
2. Using the API, create a callBrandingProfile specifying the resourceLocation field and URL on
the webserver where the customized files are held. (See Section 5.2.3 for details). The
Meeting Server uses these details to retrieve the files from the web server.
Note: : If no resourceLocation is specified, then by default the Cisco logo will be used.
3. Use this callBrandingProfile to customize your SIP/Lync calls on:
a. a system level (that is, as part of the global systems profile)
b. a per-tenant basis (as part of the tenant definition)
c. a per-space basis (as part of the space definition)
Note: When the multi brands feature key is present and call branding is applied at more than
one level, then the lowest level callBrandingProfile defined is the one that it used in a call leg. If
the single brand feature key is present then only the system level callBrandingProfile is used.
See the Using Profiles section in the API Reference.
Cisco Meeting Server 2.1 : Customization Guidelines
21
4 Customizing the text shown in invitations
4 Customizing the text shown in invitations
Customization of the invitation text is done via the use of a template which the client requests
from the Web Bridge. The templates are cached by the client so any changes to a template will
not immediately appear in the client.
4.1 Creating the invitation_template.txt
1. Create an invitation_template.txt file in UTF-8 using the information in Section 4.1. An
example that you can copy and customize is shown in Section 4.1.2.
4.1.1 Permitted conditional statements and placeholders
The template can contain both conditional statements and placeholders. This allows a single
template to be used for multiple spaces and gives a consistent feel to the invitations.
Six placeholders are currently defined, each starts and ends with a % character, see table
below:
Table 8: Placeholders in invitation template
Placeholder
Type
%name%
Conference name
%uri%
Dial-in URI of the conference
%numeric_
id%
Numeric ID of the conference
%hyperlink%
Direct hyperlink to the conference on the web bridge
%passcode%
Numeric PIN for the conference
%%
Always replaced with %
Note: that any % within the text will be interpreted as the start of a placeholder. To insert a
single ‘%’ in the text use the placeholder %%
Three conditional statements are supported, see table below. They can be nested if required.
Cisco Meeting Server 2.1 : Customization Guidelines
22
4 Customizing the text shown in invitations
Table 9: Conditional statements in invitation template
Conditional
statement
Meaning
#if
condition
If the condition is true then include the lines until an else or endif statement. The condition
section of this if statement takes the form of one of the placeholders. For example. “#if name”
#else
If the condition in the previous if statement was false then include the lines until an endif
statement
#endif
4.1.2 Example invitation template
Note:
l
There is a 10000 byte limit on the size of the invitation_template.txt file.
l
All invitation templates must be provided in UTF-8 format.
l
l
Extended ASCII characters are not supported, Terminate the invitation_template.txt file
with a carriage return.
Omitting the carriage return at the end of the file will result in the file not working.
Use the example below and customize with your specific values in the placeholders. Save it as
invitation_template.txt.
#if name
You're invited to %name%
#else
You're invited to my Cisco space
#endif
#if hyperlink
Click to join: %hyperlink%
#else
#if numeric_id
Click to join: https://join.example.com
Call ID: %numeric_id%
#endif
#endif
#if uri
Or call in:
- Video system, Jabber or Lync: %uri%
#endif
Cisco Meeting Server 2.1 : Customization Guidelines
23
4 Customizing the text shown in invitations
#if numeric_id
Phone Access: Call the regional access number, then enter %numeric_id%
US Toll Free: (800)-555-1234
UK Toll Free: 0800-800-8000
#endif
#if passcode
Passcode: %passcode%
#endif
4.2 Overview of customization procedure
The following steps provide an overview of the customization procedure, for a detailed
procedure refer to Chapter 5.
Note: All invitation templates must be provided in UTF-8 format. Extended ASCII characters are
not supported
1. Create your invitation_template.txt file
2. On the web server create a directory for the customized invitation file and place the file
invitation_template.txt into it.
3. Using the API, create a callBrandingProfile specifying the invitationTemplate field and URL on
the webserver where the template is held, you need to specify the full filename including the
path to the file, for example: http://192.0.2.0/branding/invitation_template.txt. (See
Section 5 for details). The Meeting Server uses these details to retrieve the template from the
webserver.
4. Use this callBrandingProfile to customize invitations at:
l
a system level (that is, as part of the global systems profile)
l
a per-tenant basis (as part of the tenant definition)
l
a per-space basis (as part of the space definition)
Note: When the multi brands feature key is present and call branding is applied at more than
one level, then the lowest level callBrandingProfile defined is the one that is used in a call leg. If
the single brand feature key is present then only the system level callBrandingProfile is used.
See the Using Profiles section in the API Reference.
Cisco Meeting Server 2.1 : Customization Guidelines
24
5 Detailed Customization Procedure Using Postman
5 Detailed Customization Procedure Using
Postman
This section provides a step by step example of call branding using Microsoft Windows. It
assumes that Microsoft Internet Information Services (IIS) Manager is installed with the latest
patches on the web server that will host your call branding files.
5.1 Setting up the web server
1. On the web server create a directory structure under the default IIS Manager location
c:\inetpub\wwwroot to hold the branding/custom files. The example below shows a
Branding folder with four subfolders: Call_customization, Invitation_template, ivr_
customization, webRTC_client.
2. Open IIS Manager and expand the Default Web Site. The newly created folders should show
within the list.
Cisco Meeting Server 2.1 : Customization Guidelines
25
5 Detailed Customization Procedure Using Postman
Note: If the newly created folders do not show within the list or your folders are outside of the
standard IIS Manager location, you will need to create a new Virtual Directory. Within IIS,
navigate to Default Web Site, right click and select Virtual Directory. Provide an Alias for this
folder and browse for the physical path where the files will reside.
3. Place all the files into the folders, for the appropriate to the level of branding you intend to do.
a. For WebRTC Client customization these will be the zip files from Section 2.1.
Note: in the above screenshot the WebRTC Client customization files are zipped together
by location.
b. For ivr customization these will be the files from Section 3.1
Cisco Meeting Server 2.1 : Customization Guidelines
26
5 Detailed Customization Procedure Using Postman
Note: the files for ivr customization are not zipped together.
c. For call customization these will be the files from Section 3.
Note: the files for call customization are not zipped together.
d. For the invitation template, this will be the file you created from Chapter 4.
Cisco Meeting Server 2.1 : Customization Guidelines
27
5 Detailed Customization Procedure Using Postman
4. Verify the web service is working. Open a browser and enter the full URL for the background
image file used to customize the WebRTC client, including the file name background.jpg to
see if the file opens. For example:
5.2 Using the API for branding
The remainder of this chapter covers using the Chrome tool Postman, to brand the webRTC
client, IVR, SIP calls and apply custom invitations. Appendix A details the steps to applying call
customization to SIP calls using Firefox Poster, and the Chrome Advanced Rest Client.
5.2.1 Installing Chrome Postman
5. Install Postman into Chrome (if not already installed) by opening the Apps button in the upper
left corner. If Postman is already installed go to step 10.
6. Click on Web Store to open the Chrome App Store
Cisco Meeting Server 2.1 : Customization Guidelines
28
5 Detailed Customization Procedure Using Postman
7. Enter Postman in the Search field and press Enter.
8. Install Postman – REST Client by clicking on the + FREE button to the right
9. Click Add to continue with the installation
Once installed, Postman – REST Client will appear on the Apps page
Cisco Meeting Server 2.1 : Customization Guidelines
29
5 Detailed Customization Procedure Using Postman
10. Open Postman by clicking on the Icon from within the Apps page of Chrome
11. Select the Basic Auth tab and enter the Username and Password for the API of the Meeting
Server. Click Refresh headers. Enter the URL of the Meeting Serverr and press SEND
A 200 OK Response should be returned.
Note: if you have difficulty logging in, then try to log into the Web Admin interface, accept any
certificate warnings and add them as a permanent exception. (If you do not do this and there
is a certificate warning, Poster will not work.)
12. To verify API connectivity is working, perform a GET operation on the /system/status node of
your server.
Cisco Meeting Server 2.1 : Customization Guidelines
30
5 Detailed Customization Procedure Using Postman
If it fails, verify that the login is correct and that you can access the Web URL from this PC.
Once connectivity is verified, in addition to WebRTC client branding, you can apply the
branded/customized files to SIP calls (see Section 5.2.3), invitations (see Section 5.2.3) and
IVRs (see Section 5.2.4) at a system level, per tenant level or per space or ivr level.
5.2.2 Applying branding to WebRTC clients
Branding files for WebRTC clients are applied to a webBridge node. You can only configure one
Web Bridge on an Meeting Server. If you need different WebRTC client branding for different
tenants, then you need to set up a Web Bridge for each branded WebRTC client.
13. POST to the webBridges node the url parameter and the address for the Call Bridge to use to
reach this Web Bridge. Press Send to submit the data.
Note: Select the x-www-form-urlencoded format.
A 200 OK Response should be returned.
14. Change the request type back to GET, and press Send. The response should look like this:
Cisco Meeting Server 2.1 : Customization Guidelines
31
5 Detailed Customization Procedure Using Postman
15. PUT to the webBridges node the resourceArchive parameter and the url where the webRTC
client branding files are held on your web server.
A 200OK Response should be returned.
16. To verify the data has been set correctly, simply change the request type to GET using the
same URL as the previous PUT. Press Send. The response should look like this:
That is it, your Web RTC client branded files should now be used for Web RTC client calls to the
Web Bridge, providing you have installed the Branding License key on your server. Make a test
call to check that the branded files are applied.
5.2.3 Applying branding to SIP calls and/or customized invitations
Branding files for SIP calls and customized invitation templates are applied to the
callBrandingProfiles node.
Cisco Meeting Server 2.1 : Customization Guidelines
32
5 Detailed Customization Procedure Using Postman
17. POST to the callBrandingProfiles node the parameter appropriate to the type of branding
(resourceLocation/invitationTemplate) and the urls where the branding files are held on your
web server. Be sure to specify the full filename including the path to the file for the
invitationTemplate URL only, for example: http://192.0.2.0/branding/invitation_
template.txt. You can also use https. Set the request type to POST and press Send to submit
the data.
Note: If you have created subfolders under /Branding then you need to POST the url of each
subfolder to callBrandingProfiles.
A 200OK Response should be returned.
18. Change the request type back to GET, and press Send. The response should look like this:
19. Make a note of the ID number listed next to “callBrandingProfile id=”, in this example it is:
5cf83076-ee90-4e08-9d50-22d634d93c65
20. Assign this callBrandingProfile ID to the branding level required. Depending on your branding
license level, you can apply the callBrandingProfile to:
Cisco Meeting Server 2.1 : Customization Guidelines
33
5 Detailed Customization Procedure Using Postman
l
the system level (that is, as part of the global systems profile),
l
a per-tenant basis (as part of the tenant definition),
l
a per-space basis (as part of the space definition).
The example below applies the branding to a previously created tenant:
a. change the request type to PUT
b. enter the /tenant/<tenant id> in this example e46eb768-2d87-41f1-ba9b742bb471ca61
c. enter the callBrandingProfile parameter and the id from step "Make a note of the ID
number listed next to “callBrandingProfile id=”, in this example it is: 5cf83076-ee904e08-9d50-22d634d93c65" on the previous page
d. press Send, and you should get another 200OK Response
21. To verify the data has been set correctly, simply change the request type to GET using the
same URL as the previous PUT. Press Send.
22. That is it, your Call Branding files should now be used for calls for that tenant, providing you
have installed the Branding License key on your server. Place a call from a SIP endpoint to a
Cisco Meeting Server 2.1 : Customization Guidelines
34
5 Detailed Customization Procedure Using Postman
space setup for the tenant. Make sure the call displays the background picture, and that the
voice prompt is audible.
5.2.4 Applying branding to an IVR
Branding files for IVR are applied to the ivrBrandingProfiles node.
23. POST to ivrBrandingProfiles node the resourceLocation parameter and the url where the ivr
branding files are held on your web server. Be sure that you set the request type to POST.
Press Send to submit the data.
Note: If you have created subfolders under /Branding then you need to POST the url of the ivr
subfolder to ivrBrandingProfiles.
A 200OK Response should be returned.
24. Change the request type back to GET, and press Send. The response should look like this:
25. Make a note of the ID number listed next to “ivrBrandingProfile id=”, in this example it is:
9d4fb901-28e8-43c3-95e5-58d1ccce781e
26. Assign this ivrBrandingProfile ID to the branding level required. Depending on your branding
license level, you can apply the ivrBrandingProfile to:
Cisco Meeting Server 2.1 : Customization Guidelines
35
5 Detailed Customization Procedure Using Postman
l
the system level (that is, as part of the global systems profile),
l
a per-ivr basis (as part of the ivr definition).
l
enter the ivrBrandingProfile field and from step 25
The example below applies the ivr branding to a previously created ivr (using POST to /ivrs
followed by a GET to /ivrs to retrieve the ivr id):
a. change the request type to PUT
b. enter /ivrs/<ivr id> in this example the ivr id = 0e045363-1275-46ad-b131f546541fdd11
c. enter the ivrBrandingProfile field and <ivrBrandingProfile id> from step25
27. Press Send, and you should get another 200OK Response.
28. To verify the data has been set correctly, simply change the request type to GET using the
same URL as the previous PUT. Press Send.
Cisco Meeting Server 2.1 : Customization Guidelines
36
5 Detailed Customization Procedure Using Postman
29. That is it, your IVR Branding files should now be used for calls to the specified ivr, providing
you have installed the Branding License key on your server. Make test calls to the ivr to check
that the branded ivr files are applied.
Cisco Meeting Server 2.1 : Customization Guidelines
37
Appendix A Using Other Popular API Tools
Appendix A Using Other Popular API Tools
This appendix covers using Firefox Poster and the Chrome Advanced Rest Client, to create and
apply a callBrandingProfile.
A.1 Using Firefox Poster
Follow steps "On the web server create a directory structure under the default IIS Manager
location c:\inetpub\wwwroot to hold the branding/custom files. The example below shows a
Branding folder with four subfolders: Call_customization, Invitation_template, ivr_
customization, webRTC_client." on page 25 to in Chapter 5 before proceeding with these
steps.
Install Poster into Firefox (if not already installed) by opening the Menu button in the upper right
corner and choosing Add-ons. If Poster is already installed go to step "Once enabled, access
Poster through Tools > Poster" on the next page .
5. Enter Poster in the Search field and press Enter.
Cisco Meeting Server 2.1 : Customization Guidelines
38
Appendix A Using Other Popular API Tools
6. Click Install and follow directions to restart Firefox once complete.
7. Enable the Menu Bar by right clicking just to the right of the + sign that opens a new tab and
selecting Menu Bar.
8. Once enabled, access Poster through Tools > Poster
9. To verify that API connectivity is working, enter the URL of the Meeting Server, and the
Username and Password for the API. Press GET.
Cisco Meeting Server 2.1 : Customization Guidelines
39
Appendix A Using Other Popular API Tools
A 200OK Response should be returned with the Status Data, for example:
If the GET fails, verify that:
l
the login is correct,
l
you can access the Web URL from this PC
Cisco Meeting Server 2.1 : Customization Guidelines
40
Appendix A Using Other Popular API Tools
l
Firefox trusts the certificate assigned to Web Admin, or make a Permanent exception by
adding this Trust to the browser’s Trust store. Do this by opening a standard browser session
to Web Admin using Firefox, and accept the warnings and add the exception.
A.1.1 Applying branding to SIP calls using Firefox Poster
This example only covers branding SIP calls at a system level using Firefox Poster. To configure
the other types of branding, review Chapter 5 and adapt the steps to be suitable with Firefox
Poster.
11. Once connectivity is verified, define the Call Branding Profile as below defining the URL
where the Branding files are located.
For example: resourceLocation=https<url of branding files>
12. Press POST to submit the data, you should get a 200OK Response like this:
Cisco Meeting Server 2.1 : Customization Guidelines
41
Appendix A Using Other Popular API Tools
13. Make a note of the Location field in this response and record the ID number shown, it is the
long number after the /callBrandingProfiles/ text. In the example above, the ID is eea60a424435-4c1f-99b7-6999e884abf4.
14. Assign this ID to the Call Branding Profile to be used:
a. enter the /system/profiles URL
b. enter the id from step 13 into the callBrandingProfile. For example:
callBrandingProfile= eea60a42-4435-4c1f-99b7-6999e884abf4
c. change the request type to PUT
Cisco Meeting Server 2.1 : Customization Guidelines
42
Appendix A Using Other Popular API Tools
You should receive another 200OK Response like this:
15. To verify the data has been set correctly, simply press GET using the same URL as the
previous PUT and it should return the settings as such:
Cisco Meeting Server 2.1 : Customization Guidelines
43
Appendix A Using Other Popular API Tools
16. That is it, your Branding files should now be used for calls, providing you have installed the
Branding License key on your server. Place a call from a SIP endpoint to a space. Make sure
the call displays the background picture, and that the voice prompt is audible.
A.2 Using Chrome Advanced Rest Client
Follow steps 1 to in Chapter 5 before proceeding with these steps.
5. Install the Advanced REST Client into Chrome (if not already installed) by opening the Apps
button in the upper left corner. If Advanced REST Client is already installed go to step
6. Click on Web Store to open the Chrome App Store
Cisco Meeting Server 2.1 : Customization Guidelines
44
Appendix A Using Other Popular API Tools
7. Enter Advanced REST Client in the Search field and press Enter. Install Advanced REST Client
by clicking on the + FREE button to the right.
8. Click Add to continue with the installation
9. Once installed, the Advanced REST Client will appear on the Apps page
Cisco Meeting Server 2.1 : Customization Guidelines
45
Appendix A Using Other Popular API Tools
10. Open the Advanced REST Client by clicking on the Icon from within the Apps page of
Chrome. To verify API connectivity is working, enter the URL of the Meeting Server and press
SEND.
11. Enter the API login when prompted and press Log In.
A 200OK Response should be returned with the Status Data, for example:
Cisco Meeting Server 2.1 : Customization Guidelines
46
Appendix A Using Other Popular API Tools
If it fails, verify that the login is correct and that you can access the Web URL from this PC.
A.2.1 Applying branding to SIP calls using Chrome Advanced Rest Client
This example only covers branding SIP call
12. Once connectivity is verified, define the Call Branding Profile by specifying the URL where the
Branding files are located. Make sure that you set the request type to POST. Press Send to
submit the data.
A 200OK Response should be returned, for example:
Cisco Meeting Server 2.1 : Customization Guidelines
47
Appendix A Using Other Popular API Tools
13. Change the request type back to GET, and press Send. The response should look like this:
14. Make a note of the ID number listed next to “callBrandingProfile id=”, in this example it is it is
59ba0728-8650-4936-9cb4-2c818dfba821
Cisco Meeting Server 2.1 : Customization Guidelines
48
Appendix A Using Other Popular API Tools
15. Assign this ID to the Call Branding Profile to be used (see note below)
a. enter the /system/profiles URL
b. enter the id from step "Make a note of the ID number listed next to “callBrandingProfile
id=”, in this example it is it is 59ba0728-8650-4936-9cb4-2c818dfba821" on the
previous page into the callBrandingProfile field
c. change the request type to PUT
You should receive another 200OK Response like this:
16. To verify it has been set correctly, simply change the request type to GET using the same URL
as the previous PUT. Press Send.
17. That is it, your Branding files should now be used for calls, providing you have installed the
Branding License key on your server. Place a call from a SIP endpoint to a space. Make sure
the call displays the background picture, and that the voice prompt is audible.
Cisco Meeting Server 2.1 : Customization Guidelines
49
Cisco Legal Information
Cisco Legal Information
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE
SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND
RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE
PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE
FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT
ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE
INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE
SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE
FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program
developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version
of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University
of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND
SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE
ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED,
INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING,
USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST
PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE
THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended
to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative
purposes only. Any use of actual IP addresses or phone numbers in illustrative content is
unintentional and coincidental.
All printed copies and duplicate soft copies are considered un-Controlled copies and the
original on-line version should be referred to for latest version.
Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are
listed on the Cisco website at www.cisco.com/go/offices.
© 2017 Cisco Systems, Inc. All rights reserved.
Cisco Meeting Server 2.1 : Customization Guidelines
50
Cisco Trademark
Cisco Trademark
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates
in the U.S. and other countries. To view a list of Cisco trademarks, go to this url:
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their
respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (1110R)
Cisco Meeting Server 2.1 : Customization Guidelines
51
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising