Acano solution Customization Guidelines R1.9

Acano solution Customization Guidelines R1.9
Acano solution
Acano Server & VM Release R1.9
Customization Guidelines
September 2016
76-1032-05-C
Contents
1 Introduction
4
1.1 License Keys
5
1.2 Web Server Requirements
5
1.3 Using this guide
5
2 WebRTC Client Customization
7
2.1 File Properties and Names
7
2.1.1 Sign-in page background image and logo
8
2.1.2 Join call pane colors
8
2.1.3 Other settings in sign_in_settings.json
2.2 Overview of Customization Procedure
3 Call Customization
3.1 IVR Message Customization
10
10
12
12
3.1.1 IVR Messages to be customized
12
3.1.2 Recording format for IVR messages
13
3.1.3 IVR background image properties
13
3.1.4 Overview of customization procedure
13
3.2 SIP/Lync Call Message Customization
14
3.2.1 Audio messages to be customized
14
3.2.2 Recording format for audio messages
16
3.2.3 Background image properties
17
3.2.4 Overview of customization procedure
17
4 Customizing the text shown in invitations
4.1 Creating the invitation_template.txt
19
19
4.1.1 Permitted conditional statements and placeholders
19
4.1.2 Example invitation template
20
4.2 Overview of customization procedure
21
5 Detailed Customization Procedure Using Postman
22
5.1 Setting up the web server
22
5.2 Using the API for branding
25
5.2.1 Installing Chrome Postman
25
5.2.2 Applying branding to WebRTC clients
28
5.2.3 Applying branding to SIP calls and/or customized invitations
30
5.2.4 Applying branding to an IVR
32
76-1032-05-C: Customization Guidelines R1.9
2
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
35
35
38
41
44
Figures:
Figure 1: Overview of guides covering the Acano Solution
4
Figure 2: Creating zip file for Web RTC client assets
8
Figure 3: Example contents of sign_in_settings.json and resultant Join call pane
9
76-1032-05-C: Customization Guidelines R1.9
3
1 Introduction
1 Introduction
Note: coSpace has been renamed space. This document has been changed to using
space, except where it refers to coSpace API objects.
This document covers the customized features in the Acano solution release 1.8. 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 the figure below).
In addition to this guide, the material shown in the figure below can be found at the
Acano Documentation & software page. If you need any technical assistance with the
configuration, or you want to report a suspected bug, email [email protected]
Figure 1: Overview of guides covering the Acano Solution
76-1032-05-C: Customization Guidelines R1.9
4
1 Introduction
1.1 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 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 Acano partner with the following information:
n
level of branding required (single/multiple)
n
MAC address of interface A on Acano X series or VM server
Note: From release 1.8, customization of the invitation text is available with single
brand and multiple brand licenses.
1.2 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 Acano 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.3 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.
76-1032-05-C: Customization Guidelines R1.9
5
1 Introduction
Chapter 4 describes customizing the text shown in invitations which is sent to
participants inviting them to join a call or space. 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
76-1032-05-C: Customization Guidelines R1.9
6
2 WebRTC Client Customization
2 WebRTC Client Customization
The recommended procedure for customization of the WebRTC client is via the API,
which requires a branding license (see Section 1.1).
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).
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.
76-1032-05-C: Customization Guidelines R1.9
7
2 WebRTC Client Customization
Figure 2: Creating zip file for Web RTC client assets
Table 1: Web RTC client assets
Use
Filename to use
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 500kB 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 250kB in size.
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.
76-1032-05-C: Customization Guidelines R1.9
8
2 WebRTC Client Customization
Table 2: Color parameters for Join Call pane
Color
Description
Default
panelTopColor
Color used at top of panel.
#DC2D0F
panelBottomColor
Color used at bottom of panel.
#B41E00
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
footerColor
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
Figure 3: Example contents of sign_in_settings.json and resultant Join call pane
{
"panelTopColor" : "#FFFF00",
"panelBottomColor" : "#FF0000",
"panelForegroundTextColor" : "#3333FF",
"panelErrorTextColor" : "#00FF00",
"panelHyperlinkTextColor" : "#CCFFFF",
"panelLoaderColor" : "#FFFFFF",
"footerColor" : "#FFFFFF",
"footerTextColor" : "#000000"
}
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.
76-1032-05-C: Customization Guidelines R1.9
9
2 WebRTC Client Customization
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.
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
Filename to use
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
supportFirefoxWebrtc
Join conference directly using Firefox
WebRTC stack without calling out to client
false
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
Note: From R1.6 we recommend that you use the API to customize the WebRTC
landing page.
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.
76-1032-05-C: Customization Guidelines R1.9
10
2 WebRTC Client Customization
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
Acano 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.
76-1032-05-C: Customization Guidelines R1.9
11
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 into an Acanospace as a SIP
(including Lync) call
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. Those for which the wording has changed in R1.8 are
identified
Table 4: IVR messages for customization
Changed
in R1.8
Text of message
Filename to use
Please enter the call ID,
followed by the '#'(pound) key.
ivr_id_entry.wav
Unable to recognize that call ID.
Please try again.
ivr_id_incorrect_
try_again.wav
Please try again: this is your last
attempt.
ivr_id_incorrect_
final_attempt.wav
Unable to recognize that call ID.
Goodbye.
ivr_id_incorrect_
goodbye.wav
Yes
entering three incorrect call ID’s to join
the space
Welcome to an Acano meeting.
ivr_welcome.wav
Yes
joining a space
Unable to connect you. Goodbye.
ivr_timeout.wav
Yes
after dialling via IVR and not entering
the call ID, the call times out
76-1032-05-C: Customization Guidelines R1.9
Played when ......
dialling via IVR to enter a specific space
Yes
the incorrect call ID is entered to join
the space
two incorrect pins/call ID’s have been
entered to join the space
12
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
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
Acano 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 Acano server uses these details to retrieve the files from the web server.
3. Use this ivrBrandingProfile to customize your calls on:
76-1032-05-C: Customization Guidelines R1.9
13
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 an
Acano 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.
76-1032-05-C: Customization Guidelines R1.9
14
3 Call Customization
Table 6: SIP call messages for customization
Filename to use
Changed or
new (*) in
R1.8
Repeats
for audio
calls
Played when ......
Welcome to an
Acano meeting
welcome.wav
Yes
No
joining a call
Unable to
connect you.
Goodbye.
timeout.wav
Yes
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 an
Acano call.
call_outgoing_
welcome.wav
Yes
No
Press '1' to
enter the
meeting.
cospace_join_
confirmation.wav
Yes
No
calling a phone number from a space
You are
entering the
meeting now.
cospace_join.wav
Yes
No
after dialling the URI of aspace from a
SIP endpoint, or after dialling the IVR
and entering the call ID of the space
(plays after passcode if space has a
passcode)
You are invited
to an Acano
meeting.
cospace_
outgoing_
welcome.wav
Yes
No
calling a mobile from a space
Please enter
the passcode,
followed by the
'#'(pound) key.
passcode_
entry.wav
No
a passcode is required to enter the
spacee
That passcode
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
Text of
message
76-1032-05-C: Customization Guidelines R1.9
15
3 Call Customization
Text of
message
Filename to use
That passcode
isn't correct.
Goodbye.
passcode_
incorrect_
goodbye.wav
You have been
disconnected
from the
meeting
disconnected.wav
Your meeting
has ended
Changed or
new (*) in
R1.8
Repeats
for audio
calls
Played when ......
No
after entering three incorrect pins to join
the spacee
Yes*
No
the participant has been disconnected
from the meeting.
meeting_
ended.wav
Yes*
No
the meeting has ended.
You are the
only participant
only_
participant.wav
Yes*
Yes
there is only one participant in the meeting .
Waiting for
your host to
join
waiting_for_
host.wav
Yes*
Yes
while waiting for the meeting host to
join
This meeting is
being recorded
meeting_recorded.wav
recording starts or when joining a call
that is being recorded
Note: The voice prompts labelled 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.
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:
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.
76-1032-05-C: Customization Guidelines R1.9
16
3 Call Customization
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),
release 1.9 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
Call logo
background.jpg
Screen can be shown when a passcode needs to be entered.
Available from release 1.9.
passcode_background.jpg
Screen can be shown when awaiting activation, (waiting for host to
join, meeting needs to be unlocked etc). Available from release 1.9.
deactivated_background.jpg
Note: The behaviour and choice of background image for /callBrandingProfiles does
not affect the /ivrBrandingProfiles
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.
Acano 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.
76-1032-05-C: Customization Guidelines R1.9
17
3 Call Customization
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: From R1.9, if the 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 Acano server uses these details to retrieve the files from the web server.
Note: : If no resourceLocation is specified, then by default the Acano 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.
76-1032-05-C: Customization Guidelines R1.9
18
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.
Note: Customizing the text shown in invitations requires release 1.8 of the Acano
server combined with users using version 1.8 of the Acano 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 passcode 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.
Table 9: Conditional statements in invitation template
76-1032-05-C: Customization Guidelines R1.9
19
4 Customizing the text shown in invitations
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 Acano 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
76-1032-05-C: Customization Guidelines R1.9
20
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
Acano server uses these details to retrieve the template from the webserver.
Note: invitationTemplate iswas a new field for the callBrandingProfile object in
release 1.8.
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.
76-1032-05-C: Customization Guidelines R1.9
21
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.
76-1032-05-C: Customization Guidelines R1.9
22
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
76-1032-05-C: Customization Guidelines R1.9
23
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.
76-1032-05-C: Customization Guidelines R1.9
24
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
76-1032-05-C: Customization Guidelines R1.9
25
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
76-1032-05-C: Customization Guidelines R1.9
26
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
Acano Server. Click Refresh headers. Enter the URL of the Acano server 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.
76-1032-05-C: Customization Guidelines R1.9
27
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 Acano 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.
76-1032-05-C: Customization Guidelines R1.9
28
5 Detailed Customization Procedure Using Postman
14. Change the request type back to GET, and press Send. The response should look like
this:
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.
76-1032-05-C: Customization Guidelines R1.9
29
5 Detailed Customization Procedure Using Postman
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.
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:
76-1032-05-C: Customization Guidelines R1.9
30
5 Detailed Customization Procedure Using Postman
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:
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-ee90-4e08-9d50-22d634d93c65" above
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.
76-1032-05-C: Customization Guidelines R1.9
31
5 Detailed Customization Procedure Using Postman
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 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:
76-1032-05-C: Customization Guidelines R1.9
32
5 Detailed Customization Procedure Using Postman
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:
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.
76-1032-05-C: Customization Guidelines R1.9
33
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.
76-1032-05-C: Customization Guidelines R1.9
34
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 22 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.
76-1032-05-C: Customization Guidelines R1.9
35
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 Acano server, and
the Username and Password for the API. Press GET.
76-1032-05-C: Customization Guidelines R1.9
36
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
76-1032-05-C: Customization Guidelines R1.9
37
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:
76-1032-05-C: Customization Guidelines R1.9
38
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 eea60a42-4435-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
76-1032-05-C: Customization Guidelines R1.9
39
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:
76-1032-05-C: Customization Guidelines R1.9
40
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
76-1032-05-C: Customization Guidelines R1.9
41
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
76-1032-05-C: Customization Guidelines R1.9
42
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 Acano 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:
76-1032-05-C: Customization Guidelines R1.9
43
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:
76-1032-05-C: Customization Guidelines R1.9
44
Appendix A Using Other Popular API Tools
13. Change the request type back to GET, and press Send. The response should look like
this:
76-1032-05-C: Customization Guidelines R1.9
45
Appendix A Using Other Popular API Tools
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
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-9cb42c818dfba821" above 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
76-1032-05-C: Customization Guidelines R1.9
46
Appendix A Using Other Popular API Tools
a space. Make sure the call displays the background picture, and that the voice
prompt is audible.
76-1032-05-C: Customization Guidelines R1.9
47
Appendix A Using Other Popular API Tools
© 2016 Cisco Systems, Inc. All rights reserved.
This document is provided for information purposes only and its contents are subject to change without notice. This
document may not be reproduced or transmitted in any form or by any means, for any purpose other than the recipient’s
personal use, without our prior written permission.
Acano is now part of Cisco, and a trademark of Cisco. Other names may be trademarks of their respective owners.
76-1032-05-C: Customization Guidelines R1.9
48
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

advertisement