Build secure video chat into your own app or website with the VSee API

Looking for an OpenTok alternative or an easy way to integrate video chat into your own application? The VSee Application Programming Interface (API) allows you to easily integrate VSee’s simple, secure video conference and screen share so you can create your own innovative telehealth, e-learning, or whatever app for mobile, web, and desktop platforms.

*VSee also has a simple Waiting Room widget for quick integration of VSee video chat into your website. Please contact sales for more info

The VSee API allows partners to manage their VSee users, check for user presence, as well as send commands to the VSee client to initiate calls, meetings and auto-accept calls from specific users.

VSee requires no servers and no admin privileges, saving up to 10 times the cost of traditional video conference solutions. VSee is also HIPAA-compliant and supports complex telehealth workflows such as virtual waitrooms and triage centers.

VSee API is fully supported on Windows, Mac, and iOS to provide the best video communication experience.

How does the VSee API work?

Integrating video chat into your app is as simple as sending a POST request to VSee API to be able to leverage on our API. Information will be returned to the users via JSON thus allowing it to be easily integrated into any system.

Managing VSee users

VSee API allows partners to be able to create, update, list and delete users on the fly using POST requests without going through the normal signup flow. In addition, partners could also detect VSee user presence to determine what commands to send to the VSee client. This allows partners to easily manage their own pool of users and interaction between them.

Interaction with the client

VSee API allows partners to create commands and compress them to a simple URI that could be opened in the browser or any app. For VSee URI to work, a VSee client (version 614 or more) must be installed.

Commands now supported by VSee URI is as follows:

  1. Sign in to VSee account
  2. Customize various user experience upon signing in. e.g. Disable first time tutorial
  3. Adjust window size
  4. Display local video
  5. Pin window
  6. Set address book visibility
  7. Set survey toggle
  8. Set tutorial toggle
  9. Set history toggle
  10. Set statistic toggle
  11. Make a call
  12. Hang up on a call
  13. Auto accept a call
  14. Wait for a call
  15. Exit VSee

VSee vs other video conferencing APIs

Companies Platforms Remarks
OpenTok Browser, iOS, Android API mainly server implementation
Vidyo PC, Mac, iOS Versatile API, not fully specified
Skype URI only: Windows 8 apps, browser, Android, iOS URI does not provide for user management
WebRTC Browser Still in development as a standard, more complicated to implement
VSee PC, Mac, iPad, iPhone, Android Rich API, no libraries to integrate to other platforms

VSee vs Skype

Skype provides 2 types of API. One is a set of APIs similar to the VSee URI and works like a normal web browser link. It allows users to be able to make calls, initiate chats and switch focus to the Skype client.

The other type is the Skype desktop API (discontinued), which allows users to add video calling capabilities or create real-time streaming video devices for their applications from Skype. Learn more.

VSee vs OpenTok

OpenTok requires users to set up their own servers. VSee, on the other hand, has its own client which can be used anytime without installing servers. Thus OpenTok provides 2 sets of API, the server side API and front facing API, for delivering a video conferencing solution.

The bulk of the OpenTok API is the server side API which gives users the ability to design their server infrastructure so they can manage and maintain the video connection between users. Users can create their own user management / authentication system since OpenTok has no notion of user accounts. Learn more.

VSee vs Vidyo

Vidyo has 9 different types of product ranging form VidyoRoom to Vidyo Mobile. Vidyo's API "are available for the desktop client or the VidyoPortal™ interface for end users, administrators or super administrators."

Vidyo API allows users to customize web portal for user experiences and establish personal conference and initiate calls to credentialed users. Vidyo API also provides the capability to search for users / room for their status and join one.

In addition, Vidyo also provides a VidyoDesktop API to customize the VidyoDesktop client graphic user interface, such as embedding the video to an existing application and to control audio. Learn more.

VSee API Showcase:

Telehealth - Build a health portal for virtual doctor visits that includes scheduling and secure one-click video calling.

Sales and Virtual Teams - Easily add video calls to your website or communication dashboard to strengthen relationships with clients and team members.

Last updated: Aug 6, 2013