JavaScript API - Video Conference

The JavaScript Video Conference API can be used to start video conferences within your current website. Please note that the calling feature is not supported by older browsers. For details see the compatibility table.

For a sample integration please have a look at Integrations

Start conference

Use the following methods to start a video conference in the current browser tab. A HTML overlay is created.

/**
 * @param customerId (optional) You can either choose an existing customerId or use a new UID (there are no special characters allowed)
                If it is left empty it is checked if there is already a active tagged customer (CV.user.tag) otherwise an error is thrown.
 * @param additionalProperties (optional) { firstName: '', lastName: '', email: '' }
 */
CV.conference.start(customerId, additionalProperties);

Join conference

This is useful if want to use a waiting queue before the customer can start the conference. The customer already joins the conference but he has to wait unit he gets assigned to an agent.

For an integration usecase see Integrations.

/**
 * @param customerId You can eiter choose an existing customerId or use a new UID (there are no special characters allowed)
 * @param additionalProperties (optional) { firstName: '', lastName: '', email: '' }
 * @param callback which is called after the customre successfully joined the queue
 */
CV.conference.join(customerId, additionalProperties, callback);

Get queue status

Check the queue status of the current customer which has joined the conference before.

The polling stops when the user is assigned. The callback returns -1 when the user got assigned.

/**
 * @param customerId Give the customerId which has joined the conference before
 * @param callback Is called every 3 seconds and gives the current queue index as first parameter
 */
CV.conference.queueStatus(customerId, callback);