Web
Integrate Voximplant into your web application based on JavaScript or web frameworks like jQuery, Angular, Vue, or React. You can achieve this by including Voximplant libraries via CDN or NPM.
Ensure your web application uses the HTTPS protocol to avoid restrictions on audio and video playback on non-secure pages.
CDN
The simplest way to add Voximplant libraries is by including the following script tag in your application’s main HTML file:
<script type="text/javascript" src="https://unpkg.com/voximplant-websdk@VERSION"></script>
Replace the VERSION with an exact version from the Web SDK changelog.
We recommend specifying the exact SDK version when building both development and production applications. If you omit the version or use the @latest keyword, your application will always load the latest version, potentially causing breaking changes and application crashes during major SDK releases. For more information, refer to unpkg.com.
NPM
If you are using NPM to build your app, execute the following command to install Voximplant libraries:
npm i voximplant-websdk --save
or
yarn add voximplant-websdk
Initialize the SDK
Use the getInstance method to obtain an instance of the Voximplant client and the init method to initialize it.
When initializing and connecting the SDK to the Voximplant cloud, you need to specify the node to connect to. Your node is bound to your Voximplant account.
To find which node your account belongs to, log in to your control panel and see the Credentials for working with API, SDK, SIP section on the main dashboard.
Connect and log in
You can use JavaScript try…catch statements to catch errors.
Refer to this code example to understand how it works:
Start implementing functionality
Now that you have your application and SDK set up and successfully connected to the Voximplant cloud, you can begin implementing the desired functionality, such as making calls, participating in conferences, sending messages, and more. To achieve this, visit the Guides section of our documentation and select the features that align with your needs.
Web SDK demos
To implement the desired functionality, follow the step-by-step Guides or download and test our latest Web SDK here:
Basic audio and video calls: Demonstrates how to use the Voximplant Web SDK to create audio and video calls with call transfer, DTMF, and many other features.
Click-to-call: Demonstrates how to use a click-to-call widget for your website that allows your customers to make a call over VoIP without leaving the website.
Call features: Demonstrates the full Web SDK demo list. Here you will find the information on how to automatically restore the current call, enable push notifications, and so on.
Video conference: Demonstrates the basic video conferencing functionality of Voximplant's Web SDK. Using it, you can make calls and conferences, send DTMF, make call transfers, share screens, etc.
Videoconf solution: Demonstrates how videoconf.voximplant.com works. Using it, you can create conferences, join existing conferences, use reactions, create chats, and do many more useful things.
Messaging: Demonstrates how to create your web and mobile messaging client based on the Voximplant SDKs.
Chat moderation: Demonstrates how to create a moderated chat so people cannot use certain words via the Voximplant instant messaging SDK.