WILDIX WEBRTC KITE GUIDE


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

Wildix WebRTC Kite can be added to the website in the form of:

  • Customizable Call button (simple HTML template) with customer authorization or without
  • Customizable Widget (embedded into the website or into a separate web page) with customer authorization or without
  • HTML email signature with call button, with customer authorization or without

An example of Kite implementation can be found here: www.wildix.com/contacts

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

We recommend to use the latest stable version of browser.

Applications enabled on the PBX:

  • Collaboration
  • KITE-MCU08

Dialplan configuration

    1.  Create a Dialplan procedure and name it “kite” (WMS > Dialplan > Dialplan rules)

  1.  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:https://kite.wildix.com/PBX_Name/Extension_Numberwhere
      • PBX_Name is the PBX Name (or Serial Number)
      • Extension_Number is the extension number of user registered to this PBX or Call Group Number

      Example:
      https://kite.wildix.com/ucit/324

 

  1. Enter your name and email (optional) and click “Connect” (it is also possible to sign in via your social networks account):
  2. 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.

Using the buttons in the upper right part of the window, kite user can initiate a call, start video streaming or desktop sharing with the PBX 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

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 limit the numbers that can be dialed via Kite service:

  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 Voicemail or to other users.


Customize Kite

Display call agent information

The API allows you 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:

https://kite.wildix.com/PBX_Serial_Number/Extension_Number/api/avatar

  • Show user status image:

https://kite.wildix.com/PBX_Serial_Number/Extension_Number/api/presence/image

  • Show user status and geolocation in JSON format:

https://kite.wildix.com/PBX_Serial_Number/Extension_Number/api/presence

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:

 

https://kite.wildix.com/PBX_Serial_Number/Extension_Number/api/info

Example:
{“type”:”result”,”result”:{“uid”:”XXXXXXX”,”name”:”User Name”,”avatar”:”http:\/\/XXX.XX.X.XX\/user_avatar\/XXX.png”,”pbx”:”0050568XXXXX”,”presence”:{“online”:true,”show”:false,”device_show”:false,”status”:false,”location”:{“address”:false,”lat”:false,”lng”:false}},”pbxIp”:”XXX.XX.X.XX”}}

Variables explanation:

    • uid: unique ID of the user
    • name: user name
    • avatar: http:\/\/[PBX_IP_address]\/user_avatar\/[Extension_Number].png
    • 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

Auto fill name and email of Kite user

You can enable each customer to access Kite service without having to fill in his / her personal data each time.

Use Kite link in the following format:

https://kite.wildix.com/PBX_Name/Extension_Number?name=Customer_Name&email=Customer_Email

    where

 

  • PBX_Name is the name or serial number of your Wildix PBX (you can also use the Serial Number of the PBX)
  • Extension_Number is the extension number of the PBX user or the call group number
  • Customer_Name is the Kite user name
  • Customer_Email is the Kite user email address

 

Example: https://kite.wildix.com/ucit/324?name=Elena&email=elena.kornilova@wildix.com

Customer authorization information is already filled out automatically:

To allow Kite user to connect automatically, add the value “&autologin=1” in the end of the link:

Example: https://kite.wildix.com/ucit/324?name=Elena&email=elena.kornilova@wildix.com&autologin=1


DIRECT call (without entering chat)

In order to make a direct call without opening chat, type into the URL:

https://kite.wildix.com/pbx_name/phone_number

    where

  • pbx_name is the name or serial number of your Wildix PBX
  • phone_number is the called number present in the “kite” Dialplan procedure (known issue: letters are not currently supported, only digits)

Note: phone number must not coincide with any existing extension number of user or call group


Kite link in iframe

To insert Kite link into the website page in an iframe, add /embedded in the end of the link, example:

<iframe src=”https://kite.wildix.com/0123456a7b89/60/embedded” width=”300″ height=”300″ frameborder=”0″ scrolling=”no”>


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:


Add a Kite Widget to your website

Example of Wildix Kite Widget can be found on www.wildix.com:

 

  1. Go to the page of code generation: http://kite.wildix.com/pages/widget/
  2. Fill out the fields:
    • Serial: serial number of PBX name
    • Extension: extension of PBX user or call group number
    • Site URL: URL of your website
    • Top title: you can enter your value
    • Bottom title: you can enter your value
    • Default language: select the default language of the Kite user authorization window, or keep the option “Auto-detection”
    • Auto connect: allows PBX users to receive notification once Kite user opens the page (even if Kite widget is not open)
    • Auto login: after you enable the option, you can fill out “Name” and “Email” of Kite user for pre-authorization
    • Widget behavior: select whether to expand the widget by default, expand the widget after a timeout, or open the widget in a new window
    • Position and offsets: select and optimize the widget position on your website
  3. click “Generate”
  4. The code is generated, copy the code and paste it into your website between the tagsandor 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.

Note: you can edit Kite user name or email (or other values) inside the code after the Kite widget code has been generated (edit the corresponding line of the code).


Create your own HTML signature with Kite button

Follow the link to generate the HTML signature for email

Example:

avatar

Elena Kornilova
Documentation & Release Manager | www.wildix.com
Tel: 39 0461 1715111

Click here to contact me

 

 

    1 Star2 Stars3 Stars4 Stars5 Stars (9 votes, average: 4.56 out of 5)
Loading...

Leave a Reply

Your email address will not be published. Required fields are marked *