The VidyoPortal exposes a set of web services APIs that allow third parties to develop their own custom portals or endpoints based on Vidyo’s technology. These services are exposed via following SOAP/WSDL interfaces:
One of the advantages of utilizing Vidyo’s Web Services Platform is the small number of APIs that are needed. Only a set of very basic and obvious APIs need be employed when interfacing the Conferencing Endpoint Subsystem to the Conferencing Middleware Subsystem hosted by Vidyo’s Web Services Platform.
The following sets of APIs are provided:
Super APIs – (com.vidyo.portal.super) – A set of super administrative APIs to manage tenants, licenses and System components etc. as defined in this document. These APIs are restricted to authorized user with “super admin” privileges. These APIs can be used towards developing “super admin” tools.
Admin APIs – (com.vidyo.portal.admin) – A set of administrative APIs to manage members, rooms, gateways, etc. as defined in this document. These APIs are restricted to authorized users with “admin” or “operator” privileges. These APIs can be used towards developing “admin” tools.
Guest APIs – (com.vidyo.portal.guest) – A set of APIs for developing guest user functionality via Web Services API. The concept of Vidyo Portal Guest API is to allow temporary users to login, temporarily link to an endpoint client and join a conference. These guest users will be automatically deleted by the VidyoPortal once they leave the conference.
User APIs – (com.vidyo.portal.user) – A set of APIs for developing third party endpoints or applications targeted for end users, providing functionality like search, join meeting rooms, make direct calls, and so on, as defined in this document.
To start using the web services API, it’s important to understand the User Login process. An overview of the login process is included in this section.