API
This section is dedicated to Vidaoo's users who wish to experience external system Integrations into Vidaoo software.
To perform Integrations, APIs are crucial to the connection process.
What's an API?
API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other.
When you use an application on your devices, the application connects to the Internet and sends data to a server. The server then retrieves that data, interprets it, performs the necessary actions and sends it back to your devices. The application then interprets that data and presents you with the information you wanted in a readable way. This is what an API is - all of this happens via API.
A complete set of APIs for the integration of user applications is at Vidaoo's users disposal. In fact, by accessing an API, you have the power to perform several actions, for example:
Create, retrieve, delete meetings
Update automations
Verify an account's token
Start, download recordings
How does it work?
Vidaoo's APIs:
Are organized around REST, which stands for stands for Representational State Transfer
Have predictable resource-oriented URLs
Accept form-encoded request bodies
Return JSON-encoded responses. JSON, that is JavaScript Object Notation, is a syntax for storing and exchanging data. In other words, it's a language and format used to send and receive information.
Use standard HTTP response codes, authentication, and verbs. HTTP methods or protocol operate with these terms:
What you want to do | Method to use |
|---|---|
Create | POST |
Retrieve | GET |
Update | PUT |
Delete | DELETE |
Vidaoo APIs
All Vidaoo's APIs are listed on this page. Be sure to test them all!
VIDAOO Integration with a web browser button
The customers can engage a Video Communication Session with the Agent using a simple Web browser button (on PC, Mobile, Kiosk, etc.), like in the following examples:
In order to activate the Web browser button, follow these steps:
Create the Web Browser Button
Activate the web project
Check and edit parameters
Authenticate on VIDAOO
Connect XCALLY to VIDAOO
Create an OpenChannel Account
Associate the Agents to the OpenChannel Account
Track the video call route
Create a Webhook automation
Notify Agents of incoming video call
Create the Web Browser Button
Activate the web project
The web button is able to connect the website and VIDAOO using a web project, through the API. In order to create the web button or a more complete contact form with the web button on the specific website, you need to edit your website code.
Download the web project Vidaoo-contact form:
| View file | ||
|---|---|---|
|
The project is based on:
HTML (HyperText Markup Language)- standard markup language for documents designed to be displayed in a web browser.
Java- high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible.
CSS (Cascading Style Sheets)- style sheet language used for describing the presentation of a document written in a markup language such as HTML.
PHP- server side scripting language embedded in HTML, used for programming dynamic web pages.
Drag the Vidaoo-contact form project into the domain directory (a server host supporting HTML and PHP is needed)
Check and edit parameters
The PHP file is responsible for making the API request. For the purpose of successfully activating and editing the request, check the parameters in the PHP directory.
You have the possibility to edit the Contact Form with the web button, choosing and personalizing the fields shown to the Customer
You have the possibility to edit the string $data in vidaoo.php, setting various fields of the meeting session
For example:
'topic' is the topic of the meeting (i.e. MY_WEBSITE), which appears also in the video call session and in VIDAOO reports.
'metadata' are video call data in JSON format useful for VIDAOO automations.
Authenticate on VIDAOO
The API links the website to the VIDAOO solution, to which we must have access. So, you need to authenticate your account VIDAOO on the web project, inserting your API KEY.
Login into VIDAOO. Check here VIDAOO documentation.
Create a role with customized permissions (i.e. you can create the "Clicktocall" role only to generate and manage meetings)
Create a user, associating the customized role (i.e. you can create a user "Clicktocall" dedicated to the web project)
Generate the token connected to the new user, clicking on the key button and then create the API token
Copy the token
Move to the Vidaoo-contact form web project
Paste the token in the PHP directory string 'X-APIKEY', aimed at having your authentication done
Connect XCALLY to VIDAOO
The Customer can now click a button and generate a video call (VIDAOO Quick Meeting).
In order to let Agents receive notifications and answer the video call, you have to connect XCALLY to the VIDAOO project:
Create an OpenChannel Account (i.e. Clicktocall Vidaoo)
Add agents to the new OpenChannel Account to associate specific Agents to VIDAOO account and manage the video call
Track the video call route
Create a Webhook automation
From the XCALLY new OpenChannel Account, copy the URL included in the Receive URL section. This URL will be fundamental to create an XCALLY webhook from VIDAOO.
Move to VIDAOO
Create an XCALLY webhook automation : When the Customer clicks on the web button, the Agent receives a notification and can join the video call.
Select the condition when: a meeting is created
Among the Actions, select the XCALLY Webhook
In the field Url, paste the URL included in the Receive URL section of the XCALLY Openchannel Account
You can also customize your webhook, according to your needs
Notify Agents of incoming video call
When the Customer click on the web button, the Agents belonging to the VIDAOO OpenChannel Account receive the notification of a video request on XCALLY Motion Omni Desktop Interface
When one of the Agents accepts the interaction, he/she finds the video session link
After entering the link, the session is established and the VIDAOO meeting starts!