Versions Compared

Old Version 5

changes.mady.by.user XCALLY Knowledge (Unlicensed)

Saved on

compared with

New Version 6

changes.mady.by.user XCALLY Knowledge (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ON THIS PAGE 

Table of Contents


Administration

Image RemovedImage Added

In the Menu Administration you can create new Buttons you want to be displayed on the user interface and configure specific Automations, automatic tasks that are activated when specific conditions occur. In the Reports section meetings historical data is available.

Buttons

In this section you'll find all the custom Buttons already created for your account :

Image RemovedImage Added

or create new ones.

The buttons created here, will be used to add new functions to the Vidaoo Toolbar in the Meetings.

You can use the command bar on the up right side in order to:

  • Create: create a new button 

  • Edit: edit and eventually update the button selected from the list

  • Delete: permanently delete the button selected from the list

  • Refresh: refresh the table rows

  • Filter: hide/show filters

  • Export: export the current table rows in a csv format file.


Info

Filter View

Use the fields at the top of the columns to filter the list of items showing only those that meet certain conditions:

Click  and insert the string to filter:

When a filter is applied the funnel icon is displayed near the column name: 

Remember to delete the filter when you don't need it anymore.


Create new Buttons

New custom buttons can be added to the VIDAOO tool bar:

Image RemovedImage Added

To create a new button, click the  command on the top-right of table, fill the form and Save it.

Image RemovedImage Added

Parameter

Name

URL

Target

Specs

Icon

Description

Mandatory. The name of the button (this name will be shown when you hover the button during the meeting).

Mandatory. Specifies the URL of the page to open when you click the button.

Optional. Specifies the target attribute or the name of the window. The following values are supported:

  • blank - URL is loaded into a new window, or tab. This is default

  • _parent - URL is loaded into the parent frame

  • _self - URL replaces the current page

  • _top - URL replaces any framesets that may be loaded

Specs

Optional. A comma-separated list of items, no whitespaces. The following values are supported:

channelmode=yes|no|1|0

Whether or not to display the window in theater mode. Default is no. IE only

directories=yes|no|1|0

Obsolete. Whether or not to add directory buttons. Default is yes. IE only

fullscreen=yes|no|1|0

Whether or not to display the browser in full-screen mode. Default is no. A window in full-screen mode must also be in theater mode. IE only

height=pixels

The height of the window. Min. value is 100

left=pixels

The left position of the window. Negative values not allowed

location=yes|no|1|0

Whether or not to display the address field. Opera only

menubar=yes|no|1|0

Whether or not to display the menu bar

resizable=yes|no|1|0

Whether or not the window is resizable. IE only

scrollbars=yes|no|1|0

Whether or not to display scroll bars. IE, Firefox & Opera only

status=yes|no|1|0

Whether or not to add a status bar

titlebar=yes|no|1|0

Whether or not to display the title bar. Ignored unless the calling application is an HTML Application or a trusted dialog box

toolbar=yes|no|1|0

Whether or not to display the browser toolbar. IE and Firefox only

top=pixels

The top position of the window. Negative values not allowed

width=pixels

The width of the window. Min. value is 100

Icon

Insert in this field the name of the icon you want to be displayed for this button.  The value must be the icon name preceded by the suffix "fab fa-" if you like a brands icon or "fas fa-"  if you like a solid icon. Refer to FontAwsome Free Icon website for the complete list of all the available free icons

Here it is an example: 

Image RemovedImage Added

You can create as many buttons you like and, when a Meeting will be set up to use them, on your VIDAOO Toolbar you will find them:

Image RemovedImage Added

Info

About Custom Buttons

Custom Buttons can be used only in Scheduled Meetings. Quick meetings allow using them only via API

Automations

The Automations are actions or procedures that operate automatically when certain conditions occur. (Each time an automated action is initiated, the system logs it. See later in Logs section).

You can set up the automatic tasks for your organization meetings in this section:

 

You can use the command bar on the up right side in order to:

  • Create: create a new automation

  • Edit: edit and eventually update the automation selected from the list

  • Delete: permanently delete the automation selected from the list

  • Refresh: refresh the table rows

  • Filter: hide/show filters

  • Export: export the current table rows in a csv format file.


Create Automation

Click :

and enter the automation conditions and actions (in the format: if this event occurs and these conditions are met, then the action/actions to trigger is/are..):

  • Name of the Automation

  • Description (optional)

  • When is the condition in which the automation is activated 

  • Conditions (optional) that you can specify to activate automation

  • Actions (at least one) to be initiated triggered by the occurrence of the condition. You can choose (clicking on

    Image Removed

    ) among the following:

    • Send Mail 

    • Sip Invite

    • Webhook

    • XCALLY Webhook

If you want you can add more then one action; when you finish just toggle the selector to activate the automationand save it

Info

Anytime you need to modify the automation just select it, click Image Modifiedand Image Modified and change the automation parameters or, if you just want to deactivate the automation, switch the selector from on Image Modified to off Image Modified

In the following paragraphs we see how to use the various types of actions.


Send Mail Action

The Send Mail action triggers the sending of a preset email message to a specific set of email addresses. In in the following example we want set up an automation to be started anytime a meeting starts :

Image RemovedImage Added

Click on Image RemovedAdd in the Action section and select Send Mail:

Image RemovedImage Added

Now enter the email recipients, the subject and the body of the email message and confirm:

SIP Invite Action

The SIP Invite action triggers a request sent by a calling party, inviting a recipient for a session:

Image RemovedImage Added

Click on Image RemovedAdd in the Action section and select SIP Invite:

Image RemovedImage Added

Now enter the following information:

  • SIP URI is the SIP address or IP (server:port) followed by the port number where the call center platform expects to receive a sip invite packet

  • Calling Number is the internal number of the call center that generates the call

  • Called Number is the internal, queue or IVR number of the call center called

  • Authentication: sometimes the internal number to generate the call requires authentication (in this case, by clicking here you can enter username and password)

and confirm.

Info

SIP Server

In case of a SIP invite set up for an XCALLY platform, remember to use the pjsip module. 

This is an example of pjsip.conf on XCALLY:


[transport-udp]
type=transport
protocol=udp
bind=0.0.0.0:5065

[6001]
type=endpoint
context=from-sip
disallow=all
allow=ulaw
auth=6001
aors=6001

[6001]
type=auth
auth_type=userpass
password=YOUR_PASSWORD
username=6001

[6001]
type=aor
max_contacts=1

Webhook

Web applications can communicate with each other, sending real-time data from one application to another whenever a given event occurs, using the Webhooks (http request to an external webservice):

Image RemovedImage Added

Click on Image RemovedAdd in the Action section and select Webhook:

Image RemovedImage Added

Now enter the following information:

Image RemovedImage Added

  • URL endpoint (the place where you’ll be sending the information that you’re capturing in the webhook)

  • Method can be chosen among GET/PUT/POST/PATCH/DELETE

  • Headers Key and Value: endpoints may require that you include headers in your request (common use cases for request headers include a content type specification, e.g XML or JSON, and authorization headers that contain your credentials with your  system). Insert and Add as many of them you need

  • Body Key and Value: these fields are displayed only if you choose a POST/PUT/PATCH method

and confirm.


XCALLY Webhook

You find on Vidaoo a Webhook for XCALLY Motion that is almost ready to use: 

Image RemovedImage Added

It can be used as an example when you create a webhook for any other external webservice or to integrate XCALLY Motion, entering your XCALLY address, account ID and modify/add any other of the proposed parameters.

Info

In this example, you find in the Body the following values (but you can add new ones or modify them):

  • from  video_<$data.id$>  to pass the meeting id

  • firstName <$user.username$>  to pass the first name of the user

  • mapKey firstName to associate any interaction related to this user (without creating a new identity in the db)

  • body Click here to join: <$&data.join_url$> to pass the meeting link in the body of the interaction

Reports

In Reports section historical data about meetings is available.

  • Clicking in the Action button, it is possible to visualize the participants information about the specific meeting.

Image RemovedImage Added

  • From the command bar on the up-right side, data can be exported in CSV and in Excel format. 

Image RemovedImage Added

  • You can export meetings, applying filters and generating detailed files. 

  • The list of exported files is shown in the "Exports" window, where it is possible to download the files (Actions-->Download)

Monitoring

In this section you can monitor all the realtime activities taking place in the Account environment.

  • You will find some Cards, which show general data:

Image RemovedImage Added


  • You have the possibility to see pie charts that show the kind of devices and browsers used:

Image RemovedImage Added


  •  A line chart that shows active meetings is available:

           


  • You can also see detailed information of a specific active meeting: