Wildix WebRTC Kite & MCU Videoconference. Quick Start Guide

Transcription

1 Wildix WebRTC Kite & MCU Videoconference Quick Start Guide Version

2 Wildix Kite is a professional solution based on WebRTC technology for real-time communication with the customer through the company website, totally integrated into the Wildix UC system. Introduction 3 Configuration 3 Requirements 3 Dialplan configuration 4 Try Wildix Kite 4 Customize Kite 5 Wildix APIs 5 A ready HTML template 6 Limit access to Kite service 6 Add a Kite Widget to your website 7 MCU Videoconference 8 Features and limitations 8 Create and access a conference 8 Desktop Sharing component 10 Wildix WebRTC Kite and MCU Conference - Quick Start Guide 2

3 Introduction Wildix Kite is a professional solution for business communication based on the WebRTC technology that brings Unified Communications to the corporate website. With Wildix Kite a website visitor can communicate with the company call agents via chat, audio and video, desktop and data sharing, all this with just one click. Features supported: Chat Audio call Video streaming Desktop sharing File exchange MCU Video conference (chat, audio conference, video streaming, screensharing) Wildix WebRTC Kite can be added to the website in the form of: A customizable Call button (simple HTML template) Widget (embedded into the website or into a separate web page) An example of Kite implementation can be found here: Wildix Kite is fully integrated into the Wildix telephony system: Chat requests are managed by PBX users via Wildix Collaboration interface. Audio calls can be managed from all Wildix devices, including: WP phones, W-AIR phones, PC (Zero Distance), mobile devices (Wildix Mobile Collaboration for ios and Android). Wildix Kite uses a separate Dialplan which makes it easy to customize the service. Chat requests from Kite service can be routed to separate call agents or to call groups Configuration Requirements Browser compatibility: Google Chrome Mozilla Firefox Opera We recommend to use the latest stable version of browser. Licenses enabled on the PBX: Wildix Collaboration Wildix WebRTC Kite and MCU Wildix WebRTC Kite and MCU Conference - Quick Start Guide 3

4 Dialplan configuration 1. Create a Dialplan procedure and name it kite (WMS > Dialplan > Dialplan rules) 2. Add internalcalls (Users dialplan) to Included procedures. Now all the users registered to your PBX can receive calls via Kite service. Try Wildix Kite 1. Open supported web browser and type: where PBX_Serial_Number is the Serial Number of your PBX and Extension_Number is the extension number of user registered to this PBX Example: 2. Enter your name and (optional) and click Connect (it is also possible to sign in via your social networks account): 3. In case the extension entered into the URL exists (on step 1), chat with this user starts automatically: User receives chat request to Wildix Collaboration interface. Use the buttons in the upper right part of the window to make a call or start video streaming with the user. Use the paperclip icon to send a file (or simply drag the file into the input field). Click Options to: Logout Make an audio echo test Change the language Wildix WebRTC Kite and MCU Conference - Quick Start Guide 4

5 Customize Kite Wildix APIs Thanks to Wildix APIs it s possible to display on the website page the information about call agent s presence and availability status, users personal images, geolocation, this information is synchronized with Wildix Collaboration and status of devices registered to the user s account. Note: Information is not taken from the PBX in real time, it is synchronized every 10 seconds, so it s necessary to specify the refresh time in the JavaScript that loads the information. Display call agent information Show user avatar: Show user status image: Show user status and geolocation in JSON format: Example: { type":"result","result":{"online":true,"show":false,"device_show":false,"status":false,"location": {"address":false,"lat":false,"lng":false}}} Information about the user that includes all the data in JSON format: Example: {"type":"result","result":{"uid":"xxxxxxx","name":"user Name,"avatar":" \/XXX.png","pbx":" XXXXX","presence": {"online":true,"show":false,"device_show":false,"status":false,"location": {"address":false,"lat":false,"lng":false}},"pbxip":"xxx.xx.x.xx"}} Wildix WebRTC Kite and MCU Conference - Quick Start Guide 5

6 Variables explanation: uid: unique ID of the user name: user name avatar: pbx: PBX Serial number Presence: online: online or offline show: the status set up by the user (away, dnd) device_show: device status (talking, ringing) status: status message location: serves for geolocation ({address, latitude, longitude}) pbxip: PBX IP address A ready HTML template Download a ready HTML template HERE. Note: you can use a call group ID instead of an extension number, in this way you can route the chat requests to group of users. Here is how the call agent appears on the webpage: Limit access to Kite service Via ACL groups you can forbid a user s presence status and avatar visualization: 1. Go to WMS > Users > Groups 2. Select a group 3. Add the Ability cannot, Share status via Kite 4. Click Save Via Dialplan you can can limit the numbers that can be dialed: 1. Go to WMS > Dialplan > Dialplan rules 2. Select kite procedure 3. Program the Dialplan procedure according to your needs You can remove Internalcalls from Included procedures and add only those numbers that can be dialed. Otherwise you can set up the system to route the incoming calls to certain numbers to VM or to other users. Wildix WebRTC Kite and MCU Conference - Quick Start Guide 6

7 Add a Kite Widget to your website Example of Wildix Kite Widget can be found on 1. Go to the page of code generation: 2. Fill out the fields and click Generate 3. The code is generated, copy the code and paste it into your website between the tags and or into a single web page. Note: it is possible to perform a test to see how the widget will look on your website: After filling out the fields, press Test instead of Generate, you will see the widget simulation. Wildix WebRTC Kite and MCU Conference - Quick Start Guide 7

8 MCU Videoconference Features and limitations WebRTC based HD Audio/Video Max 6 video/audio participants + 4 audio only participants Screen sharing Access for external users via invitation by , via link, via phone number Mute/unmute participants Dynamic video allocation Browser: Google Chrome, Chromium, Opera Create and access a conference A PBX user can create a conference from Wildix Collaboration interface (Messaging tab): Wildix WebRTC Kite and MCU Conference - Quick Start Guide 8

9 Access to the conference for PBX users Access the conference by a link received via chat: Call the internal number from Wildix device (WP, W-AIR, Zero Distance, ios or Android application) The internal number (for PBX users) is in the following format: 98XXXXXXX, where 98 is the feature code to access to the conference, XXXXXXX is the conference ID number consisting always of seven digits. NOTE: While calling from Zero Distance, it is necessary to first dial the feature code 98, and then follow the audio instructions which would invite you to enter the conference number (containing seven digits). Access to the conference for external users Kite users can access the conference by a link received via chat: External users can enter the conference by following a link or calling a phone number sent to them via Example of the letter: Dear Mario Rossi, you have been invited to a Wildix hosted conference by Elena Kornilova. You can access the conference either by opening the following url using Google Chrome: or by calling the following numbers: Italy Local Number: France Local Number: when asked enter the following conference id: XXXXXXX and follow the instructions. Regards, Wildix Hosted Conference Solutions Wildix WebRTC Kite and MCU Conference - Quick Start Guide 9

10 Desktop Sharing component The first time you click on screen sharing icon during a conference, you are invited to add the Wildix Desktop Sharing component to Chrome extensions: Once the extension has been added, you can check its permissions and status by clicking the button Customize and control Google Chrome (in the upper right part of Google Chrome browser) > More tools > Extensions Wildix WebRTC Kite and MCU Conference - Quick Start Guide 10