Audio conferencing service

This project contains the VoxEngine scenarios, a Web service (PHP), a DB schema (MySQL) and a Web client for conference management. This README file describes how to use the provided files to build audio conferencing service. The only thing you need to start building your audio conferencing is a Voximplant developer account - you can get it for free at https://voximplant.com/sign-up

Quickstart

Webservice Installation

Use voximplant.sql from DB_schema to create database structure, in addition to the structure there will be one user admin/admin created in the managers table.

Upload files from Webservice folder on your web server (with PHP support) and change database connection settings in shim.php file:

// MySQL DB connection configuration
`$config = array();
$config["hostname"]  = "127.0.0.1";
$config["database"]  = "voxconf";
$config["username"]  = "root";
$config["password"]  = "";

And specify your Voximplant API access settings (you can get this info at https://manage.voximplant.com/settings/api_keys and the rule ID will be generated automatically later - see the Voximplant Setup):

/**
*   VoxImplant HTTP API access settings
*/
define("API_URL", "https://api.voximplant.com/platform_api/");
define("API_KEY", "YOUR VOXIMPLANT API_KEY");
define("ACCOUNT_NAME", "YOUR VOXIMPLANT ACCOUNT_NAME");
define("RULE_ID", "YOUR APPLICATION RULE_ID"); // Rule which starts conference via HTTP request

You can also specify your SMTP server info in sendEmail function if you plan to send email notifications with conference access info to participants and uncomment this string to enable this functionality:

// sendEmail($participant->name, $participant->email, $participant->passcode, array('access_number' => $access_number, 'access_code' => $access_code ));

Manager Inteface Setup

Upload Manager folder on your web server (with PHP support) and change window.WEBSERVICE_URL in index.php to real path to your shim.php on a web server.

// SPECIFY PATH TO shim.php ON YOUR WEBSERVER
window.WEBSERVICE_URL = "path/to/shim.php"; 

Voximplant Setup

After you successfully created and activated your Voximplant developer account you need to login to the Voximplant Control panel and complete these steps to set up the conferencing service:

• Buy a phone number at https://manage.voximplant.com/numbers/

• Create a Voximplant application called conference at https://manage.voximplant.com/#applications, its full name will look like conference.youraccountname.voximplant.com

• Being within this newly created application, switch to the Scenarios tab and create 3 new scenarios using the files from the VoxEngine folder of the project (ConferenceGatekeeper.js, StandaloneConference.js, VoxConference.js). Warning: don't forget to change WEBSERVICE_URL, BEEP_URL, MUSIC_URL to real URLs

• On the Routing tab, specify rules for the application, they will be used to launch the scenarios using HTTP API or after the incoming call reaches the platform. Overall, 3 rules are required:

  1. Name: IncomingCall, Pattern: Voximplant phone number bought in the Voximplant Control Panel (i.e. 18001231213), Assigned scenario: ConferenceGatekeeper. It will handle incoming calls to phone number connected to the application and first part of the authorization process (access code check).
  2. Name: FwdToConf, Pattern: conf, Assigned scenarios: VoxConference, StandaloneConference (in this order)
  3. Name: StartConfHTTP, Pattern: .*, Assigned scenarious: VoxConference, StandaloneConference (in this order)

• Connect phone number(s) your've bought before to the application at https://manage.voximplant.com/numbers/

Creating conference

Open Manager interface in your browser and log in using admin/admin login/passowrd pair. If everything was done correctly you should see the conference settings including the dropdown list with the phone number(s) you've bought and connected to your Voximplant conference application:

Version

1.0