Rate this page:

Audio conferencing

Audio conferencing functionality offered by VoxImplant is one of the most advanced and flexible audio conferencing implementations you can find. Developers have full control of every call connected to the conference via VoxEngine. For example, it's possible to record particular calls connected to the conference or the whole conference, developers can record only one audio stream that goes to the conference (if you need to get the audio from particular participant). It's possible to play audio file (or TTS) into the conference or to particular participant (call connected to the conference), mute/unmute participants, and even join different conferences together. Our Web SDK lets developers create web client applications for the conference in minutes (WebRTC will be used Chrome/Firefox/Opera or Flash in IE/Safari), same with Mobile SDKs. It's possible to implement convenient conference controls using messaging functionality (inside the call). In addition, SIP software and devices can be connected to the conference. It's hard to imagine audio conferencing service you can't build using VoxImplant. There are only few things we haven't finished yet - wideband audio support and voice activity detection (both are being developed by our brilliant engineering team, so they should become available soon).

Overview

There are two types of conferences that can be created, let's call them Local and Standalone. The main difference between them is in the type of calls that can be connected to the conference. Local conference exists only inside the VoxEngine session, it means you can make some call (session will be created together with the call) then create conference inside the session and connect additional outbound calls (up to 49 calls per session) initiated from the session to the conference. You won't be able to connect new incoming calls to Local conference. It's useful for scenarios when you need to add additional participants on-the-fly during the call (for example, for call whisper in contact center). Standalone conference also exists inside its own VoxEngine session, so you have full control of the conference on VoxEngine level, but in this case the call limit per session is 100 and you can forward incoming calls to the conference (of course, you can make outbound calls from the same session and join them to the conference like with Local conference). VoxEngine sessions don't exist more than 1 minute without any active calls inside, so this type of conference can be started either by specific HTTP request, or by incoming call. We have created this image to help understand the difference between two types of conferences:

Local conference

As you can see on the scheme there are two ways of starting the VoxEngine session with Local conference - by making a call or by making StartScenarios request to HTTP API. To create the conference after the session start, use the following code:

Creating a conference

Creating a conference

The following example shows VoxEngine scenario where conference created after the session was started by call:

After the session was started by call

After the session was started by call

And another example where conference created after the session was started by an HTTP request:

After the session was started by an HTTP request

After the session was started by an HTTP request

Developers have full control of all calls in the conference. For example, if we need to mute one of the participants

Muting one of the participants

Muting one of the participants

or if we want to play some audio file to the participant

Playing audio to the participant

Playing audio to the participant

If we need to play audio to all conference participants we will need something like that:

Playing audio to all conference participants

Playing audio to all conference participants

Of course, there is a way to record the conference (or particular calls):

Recording the conference

Recording the conference

Standalone conference

Let's see how Standalone conference can be created.

It can be done either by StartConference request to HTTP API, where you have to specify the name of the conference or by forwarding call to the conference using VoxEngine.callConference. In both cases, the conference will be created in a new session (if the conference doesn't exist) where all calls can be processed on VoxEngine scenario level. We will need to create two scenarios for the conference – Conference Gatekeeper (to forward calls to the conference) and Conference Manager (where inbound calls from the gatekeeper can be processed and connected to the conference, and where outbound calls can be initiated and connected to the conference). In addition to the scenarios, we will need to create appropriate VoxImplant application rules that will be used for launching the required scenarios.

Create a Conference Gatekeeper scenario with the following code (pay attention to the argument passed to the callConference call):

Conference Gatekeeper scenario

Conference Gatekeeper scenario

It's pretty straightforward - we just forward an incoming call to our conference. Now we need to create a rule for incoming calls: specify a rented Voximplant number in the Pattern field and assign the Conference Gatekeeper scenario.

QUICK TIP

If you want to start the conference by making a real call to a rented phone number, don't forget to bind this number to the application. To do so, go to the the Numbers tab with the Attached and Available sections. Switch to Available, select your number, and click Attach. In the window opened, specify Conference Gatekeeper, then click Attach.

Next, create a Conference Manager scenario with the following code:

Conference Manager scenario

Conference Manager scenario

Now create a rule for this scenario with the following settings. Here, the Pattern filed should contain the same value as was passed to the callConference call in the previous scenario. In our case, it's "conferenceId":

That's it. These scenarios can be modified according to developer needs. For example, to create an outbound call and join it to the conference remotely, we could use media_session_access_url and make a call to the existing conference session:

Joining an outbound call to the conference remotely

Joining an outbound call to the conference remotely

Adding different standard conferencing features is easy - write some JS code to add access code and passcode check, authorization by Caller ID, or web management interface. Check our GitHub page to get ready-to-use audio conferencing service scenarios and interfaces.