Web Services API

User Guide

Product Version 19.3.0

Document Version A
August, 2020

© 2020 Vidyo, Inc. all rights reserved. Vidyo’s technology is covered by one or more issued or pending United States patents, as more fully
detailed on the Patent Notice page of Vidyo's website http://www.vidyo.com/about/patent-notices/, as well as issued and pending
international patents. The VIDYO logotype is a registered trademark of Vidyo, Inc. in the United States and certain other countries, and is a
trademark of Vidyo, Inc. throughout the world. VIDYO and the Vidyo family of marks are trademarks of Vidyo, Inc. in the United States and
throughout the world.
 TABLE OF CONTENTS
Overview ................................................................................................................................1
About the Web Services Platform ....................................................................................................... 1
The System in Brief ............................................................................................................................. 1
Vidyo Solution Benefits Summary vs. H.264 AVC ............................................................................... 4
Acronyms Used in This Guide .............................................................................................................. 5
1. Customizable Architecture ....................................................................................................7
2. VidyoPortal API Overview .................................................................................................... 8
Data Model ......................................................................................................................................... 8
Overview of Super APIs ..................................................................................................................... 10
Overview of Admin APIs.................................................................................................................... 11
Overview of Guest APIs ..................................................................................................................... 12
Overview of User APIs ....................................................................................................................... 15
Getting the VidyoDesktop Version .................................................................................................... 19
3. Web Services Super API ...................................................................................................... 21
addClientVersion .............................................................................................................................. 21
ListTenants ....................................................................................................................................... 23
createTenant .................................................................................................................................... 25
deleteTenant .................................................................................................................................... 28
updateTenant ................................................................................................................................... 28
getTenantDetails .............................................................................................................................. 32
setMobileLoginMode ........................................................................................................................ 34
GetLicenseData ................................................................................................................................ 35
GetServiceComponentsData ............................................................................................................ 36
saveDB .............................................................................................................................................. 37
backupDB ......................................................................................................................................... 37
listDB ................................................................................................................................................ 38
deleteDB ........................................................................................................................................... 38
ListNetworkComponents .................................................................................................................. 39
getIpcAccessControl ......................................................................................................................... 40
getIpcDomainList.............................................................................................................................. 40
setIpcAccessControl.......................................................................................................................... 41
setIpcDomains .................................................................................................................................. 42
getRouterPoolList ............................................................................................................................. 43

ii
 TABLE OF CONTENTS
getLocationTags ............................................................................................................................... 44
setLoginAndWelcomeBanner ........................................................................................................... 45
SetChatStateSuper ........................................................................................................................... 46
getChatStateSuper ........................................................................................................................... 47
4. Web Services Admin API .....................................................................................................49
addClientVersion .............................................................................................................................. 49
getEndpointBehavior ........................................................................................................................ 51
createEndpointBehavior ................................................................................................................... 53
updateEndpointBehavior .................................................................................................................. 56
deleteEndpointBehavior ................................................................................................................... 59
searchMembers ................................................................................................................................ 60
GetMembers ..................................................................................................................................... 62
GetMember ...................................................................................................................................... 63
AddMember ...................................................................................................................................... 65
UpdateMember................................................................................................................................. 66
DeleteMember .................................................................................................................................. 66
GetRooms ......................................................................................................................................... 67
GetRoom .......................................................................................................................................... 69
GetRoomProfile ................................................................................................................................ 70
SetRoomProfile ................................................................................................................................ 70
RemoveRoomProfile ..........................................................................................................................71
GetRoomProfiles .............................................................................................................................. 72
AddRoom .......................................................................................................................................... 73
UpdateRoom .................................................................................................................................... 75
DeleteRoom ...................................................................................................................................... 76
enableRoom...................................................................................................................................... 76
RoomIsEnabled ..................................................................................................................................77
enableScheduledRoom ..................................................................................................................... 78
ScheduledRoomIsEnabled ................................................................................................................ 79
GetGroups ........................................................................................................................................ 80
GetGroup .......................................................................................................................................... 82
AddGroup ......................................................................................................................................... 83
UpdateGroup .................................................................................................................................... 84

iii
 TABLE OF CONTENTS
DeleteGroup ..................................................................................................................................... 84
GetParticipants ................................................................................................................................. 85
inviteToConference........................................................................................................................... 86
LeaveConference .............................................................................................................................. 87
MuteAudio ........................................................................................................................................ 87
UnmuteAudio ................................................................................................................................... 88
StartVideo......................................................................................................................................... 89
StopVideo ......................................................................................................................................... 90
CreateRoomURL ............................................................................................................................... 90
RemoveRoomURL ............................................................................................................................ 92
CreateRoomPIN ................................................................................................................................ 93
RemoveRoomPIN ............................................................................................................................. 94
GetLicenseData ................................................................................................................................ 95
inviteToConference........................................................................................................................... 96
createModeratorPIN ......................................................................................................................... 97
removeModeratorPIN ....................................................................................................................... 97
GetPortalVersion .............................................................................................................................. 98
GetLocationTags............................................................................................................................... 99
ScheduledRoomEnabled ................................................................................................................. 101
disableScheduledRoom .................................................................................................................. 102
cancelOutboundCall........................................................................................................................ 103
SetChatStateAdmin ........................................................................................................................ 103
startLectureMode ........................................................................................................................... 104
stopLectureMode............................................................................................................................ 106
GetLectureModeParticipants ...........................................................................................................107
DismissRaisedHand......................................................................................................................... 108
DismissAllRaisedHand .................................................................................................................... 109
SetPresenter ................................................................................................................................... 110
RemovePresenter ............................................................................................................................ 111
SetTenantRoomAttributes.............................................................................................................. 112
createPublicRoom............................................................................................................................113
createScheduledRoom .................................................................................................................... 114
TransferParticipantRequest ............................................................................................................ 116

iv
 TABLE OF CONTENTS
setLayout ......................................................................................................................................... 117
5. Web Services Guest API .................................................................................................... 119
LogInAsGuest ................................................................................................................................. 119
LinkEndpointToGuest ..................................................................................................................... 120
createTestcallRoom ........................................................................................................................ 122
GuestJoinConference ...................................................................................................................... 123
joinIPCConference .......................................................................................................................... 124
getClientVersion ............................................................................................................................. 125
setEndpointDetails ......................................................................................................................... 126
WhatIsMyIPAddress .........................................................................................................................127
RaiseHand ....................................................................................................................................... 128
UnraiseHand ................................................................................................................................... 129
6. Web Services User API ...................................................................................................... 130
logIn ................................................................................................................................................ 130
linkEndpoint.....................................................................................................................................131
logOut..............................................................................................................................................133
myEndPointStatus ...........................................................................................................................133
search ..............................................................................................................................................135
searchMyContacts ........................................................................................................................... 137
searchByEnityID.............................................................................................................................. 139
searchMembers .............................................................................................................................. 141
searchRooms .................................................................................................................................. 143
addToMyContacts........................................................................................................................... 145
RemoveFromMyContacts ............................................................................................................... 146
inviteToConference..........................................................................................................................147
createTestcallRoom ........................................................................................................................ 149
joinConference................................................................................................................................ 150
directCall ..........................................................................................................................................151
getParticipants.................................................................................................................................151
GetUserName ................................................................................................................................. 152
leaveConference ..............................................................................................................................153
muteAudio ...................................................................................................................................... 154
unmuteAudio .................................................................................................................................. 154

v
 TABLE OF CONTENTS
startVideo ....................................................................................................................................... 155
stopVideo........................................................................................................................................ 156
myAccount.......................................................................................................................................157
createRoomURL ............................................................................................................................. 158
createRoomPIN .............................................................................................................................. 159
getPINLengthRange ....................................................................................................................... 160
removeRoomPIN ............................................................................................................................ 160
updatePassword ............................................................................................................................. 162
updateLanguage ............................................................................................................................. 163
DeleteRoom .................................................................................................................................... 163
createRoom .................................................................................................................................... 164
lockRoom ........................................................................................................................................ 165
unlockRoom .................................................................................................................................... 166
createModeratorPIN ........................................................................................................................167
removeModeratorPIN ..................................................................................................................... 168
GetRoomProfile .............................................................................................................................. 169
SetRoomProfile .............................................................................................................................. 169
RemoveRoomProfile ........................................................................................................................170
GetRoomProfiles ............................................................................................................................. 171
SetMemberMode .............................................................................................................................172
GetEntityByEntityID ........................................................................................................................175
getEntityDetailsByEntityID ..............................................................................................................176
GetEntityByRoomKey ......................................................................................................................178
setThumbnailPhoto .........................................................................................................................179
GetInviteContent .............................................................................................................................179
GetPortalVersion ............................................................................................................................ 180
GetConferenceID ............................................................................................................................ 181
generateAuthToken ........................................................................................................................ 182
getActiveSessions ........................................................................................................................... 183
logoutAllOtherSessions .................................................................................................................. 183
getOnetimeAccessUrl ..................................................................................................................... 184
PortalPrefix ..................................................................................................................................... 185
createScheduledRoom .................................................................................................................... 186

vi
 TABLE OF CONTENTS
createPublicRoom............................................................................................................................187
updatePublicRoomDescription ....................................................................................................... 188
joinConference................................................................................................................................ 189
disconnectConferenceAll ................................................................................................................ 189
muteAudioServerAll........................................................................................................................ 190
muteAudioClientAll ........................................................................................................................ 191
muteVideoServerAll ........................................................................................................................ 192
muteVideoClientAll......................................................................................................................... 193
SilenceSpeaker ............................................................................................................................... 194
SilenceSpeakerServerAll ................................................................................................................. 195
createModeratorURL ...................................................................................................................... 196
removeModeratorURL .....................................................................................................................197
getModeratorURL ........................................................................................................................... 198
getModeratorURLWithToken ......................................................................................................... 198
cancelOutboundCall........................................................................................................................ 199
getPortalFeatures ........................................................................................................................... 201
getUserAccountType ...................................................................................................................... 203
getLoginAndWelcomeBanner ......................................................................................................... 203
startLectureMode ........................................................................................................................... 204
stopLectureMode............................................................................................................................ 205
GetLectureModeParticipants .......................................................................................................... 206
RaiseHand ....................................................................................................................................... 208
UnraiseHand ................................................................................................................................... 209
DismissRaisedHand......................................................................................................................... 209
DismissAllRaisedHand .................................................................................................................... 210
SetPresenter ................................................................................................................................... 211
RemovePresenter ........................................................................................................................... 212
SetEndpointDetails ......................................................................................................................... 213
WhatIsMyIPAddress ........................................................................................................................ 214
7. Web Services License API .................................................................................................. 215
getClientVersion ............................................................................................................................. 215
8. User Status Notification ................................................................................................... 218
User Status Notification Service Overview ...................................................................................... 218

vii
 TABLE OF CONTENTS
Configuring User Status Notification............................................................................................... 220
9. Status Notification Service................................................................................................ 221
Status Notification Service Data ..................................................................................................... 221
Configuring the Status Notification Service .................................................................................... 230
10. Authentication Using Web Services .................................................................................. 232
Authentication Service Overview .................................................................................................... 232
Configuring the Authentication Server............................................................................................ 232
11. VidyoReplay API ............................................................................................................. 234
GetRecordingProfiles ...................................................................................................................... 234
startRecording ................................................................................................................................ 235
StopRecording ................................................................................................................................ 236
PauseRecording ...............................................................................................................................237
ResumeRecording ........................................................................................................................... 238
createWebcastURL ......................................................................................................................... 239
removeWebcastURL ....................................................................................................................... 240
GetWebcastURL ............................................................................................................................. 240
createWebcastPin ........................................................................................................................... 241
removeWebcastPin ......................................................................................................................... 242
RecordsSearch ................................................................................................................................ 243
RecordsById .................................................................................................................................... 245
updateRecord ................................................................................................................................. 246
deleteRecord................................................................................................................................... 247
getVidyoReplayLibrary ................................................................................................................... 247
12. VidyoGateway API .......................................................................................................... 249
Call Notification .............................................................................................................................. 249
13. REST Web Services Authentication API ............................................................................ 251
restAuthentication .......................................................................................................................... 251
availableUserTypes ......................................................................................................................... 254
localAuthentication......................................................................................................................... 255
samlMetadata ................................................................................................................................. 256
samlAttributeMappings .................................................................................................................. 258
samlAdditionalAttributeMappings .................................................................................................. 263

viii
 TABLE OF CONTENTS
EPIC Integration REST Services ....................................................................................................... 266

ix
 Overview

About the Web Services Platform

The Vidyo Web Services Platform offers access to its state of the art, internet-based video conferencing
technology.
The Vidyo Web Services Package consists of the Web Services API, sample code, and this Web Services
API User Guide for users who wish to develop their own front-end portals or video endpoint
applications.
This User Guide describes how to use the Web Services API for developing custom applications for user
and admin management in order to facilitate everything required to initiate and manage a conference
call.

The System in Brief

Vidyo’s end-to-end enterprise solution leverages the ground breaking possibilities offered by the H.264
SVC standard combined with Vidyo’s patent pending VidyoTechnology to produce a rate-matched,
personal layout, HD VidyoConference experience on any IP based general purpose network—even the
Internet. The diagram below illustrates a typical deployment.

This chapter provides a high level description for the major VidyoConferencing components:
 VidyoPortal
 VidyoRouter
 VidyoGateway

1
Overview

 VidyoRoom
 VidyoDesktop
 VidyoMobile

VidyoPortal—Central Management and User Access

The VidyoPortal provides central management of all of the Vidyo components on the network. It is an
easy to use secure web portal that allows for integration with existing secure LDAP and Active
Directory databases for user authentication, as well as maintaining its own user database. The
VidyoPortal allows administrators from any location on the network to control every aspect of the
VidyoConferencing solution from a central location. Administrators can control system-wide
parameters and policies, establish end-user and association privileges, and customize user
conferencing capabilities.
The VidyoPortal also acts as a web front end for all users of the system. Its flexible user interface
facilitates everything required to initiate and manage a call. Users have control over adding,
disconnecting, muting and unmuting participants along with many other conference control
parameters. The interface allows users to manage and customize their own contact lists and to initiate
reservation-less multipoint conferences as well as point to point calls.

VidyoRouter—Multipoint Bridging
The VidyoRouter is the core infrastructure product for conducting all videoconferences. It is an
intelligent routing appliance that uses patented scalable video packet switching technology to achieve
unprecedented performance and features without the need for expensive, time consuming
transcoding. All video traffic is managed by the VidyoRouter. Additionally, conferences can span across
multiple VidyoRouters, achieving maximized WAN utilization as well as redundancy and efficiency.
The VidyoRouter’s technology provides each individual conference participant with the following
critical features:
Rate and resolution matching – This allows conference participants to join from any network location
and environment. It eliminates the lowest common denominator aspect of videoconferencing and
allows every participant to send and receive the best possible video based on network condition,
available CPU and screen resolution. Users on low capacity desktops and mobile devices can receive
video from HD participants without the need for transcoding, and users at low bandwidth locations can
receive video from participants sending at high bit rates. These calculations are all done by the
VidyoRouter on the fly, as it dynamically adjusts to changing network conditions.
Error resilience – The VidyoRouter is at the heart of Vidyo’s ability to overcome network issues such as
latency, packet loss, and jitter. The VidyoRouter was built to provide resilient video over any kind of
network and eliminates the need for expensive dedicated networks and QoS. By utilizing Scalable
Video Coding in conjunction with the VidyoRouter’s patented video packet switching technology, the
video can withstand upwards of 20% packet loss without experiencing the typical picture breaking that
other videoconference solutions experience at less than 1% packet loss.

2
Overview

Low latency – A critical aspect of videoconferencing is the natural interaction between participants. In
order to achieve this level of interaction, a solution must maintain low end to end latency. Typical
videoconference solutions have higher latency because they must transcode as well as implement other
technologies that introduce more latency. The result is an unreliable experience that is unnatural and
uncomfortable for interactive communications. The VidyoRouter is optimized for real time interactive
communication and typically adds less than 20ms to any multipoint videoconference in real world
global deployments. This is especially critical for a globally distributed enterprise where geographic
distances heavily impact the total round trip time of video.
Cascading and redundancy – The VidyoRouter further extends the capabilities of the
VidyoConferencing infrastructure by providing built in router to router cascading and redundancy
features. VidyoRouter cascading creates a cloud network of VidyoRouters that communicate with each
other and allow conferences to span across them in an intelligent manner. This minimizes the amount
of WAN bandwidth required for location to location conferences, and maximizes use of inexpensive and
abundant LAN bandwidth. Also built in to the VidyoRouter architecture is native fall back where upon if
a router fails, the system will utilize the next available VidyoRouter in the pool.
Secure network traversal – The VidyoRouter supports secure conferences using AES 128bit
encryption. This provides industry standard protection for all conference content. Additionally, with
VidyoRouter cascading, routers can be placed on the inside and outside of a trusted network location.
This allows IT administrators to create specific rules for router to router communication firewalls. Doing
so protects the inside trusted network from ever being directly accessed from any outside element. This
also eliminates costly session border controlling devices that create artificial bottlenecks on the
network and impede performance while raising costs dramatically.

Vidyo Endpoints
VidyoRoom – The VidyoRoom system is a hardware appliance endpoint which uses Vidyo’s SVC
technology. It can deliver HD Quality at 60 frames per second. Designed specifically for use over
converged IP networks, the VidyoRoom can decode and display multiple HD participants at video
quality unequaled by systems that require dedicated bandwidth to perform at their best.
The VidyoRoom system is simple to use, easy to configure and voice-activated with continuous
presence. Flexible conference control options make it simple to manage, using either the VidyoPortal
or a remote control device. And because video conferencing should be a natural extension of the way
people normally work, the VidyoRoom interoperates seamlessly with VidyoDesktop clients, making it
possible for people to join a conference from their home office or wherever they happen to be at the
moment.
VidyoDesktop – VidyoDesktop is a software client that’s easy to use and manage via the VidyoPortal,
and it can send and receive in HD. All users are assigned a password-protected personal space, thus
making it possible for meetings to be held anytime—whether impromptu or by prior arrangement. It
supports standard USB webcams and runs on Macs and PCs, providing an unparalleled personalized
multipoint collaborative experience.

3
Overview

VidyoMobile – A program that allows users of smart phones and tablets to participate in point-to-point
calls and VidyoConferences. There are versions for both Android and Apple iOS devices and copies are
available from the platforms’ respective stores (the Google Play™ store and the AppStore™).
VidyoGateway – The VidyoGateway allows the VidyoConferencing infrastructure to connect to
traditional H.323 and SIP devices. It supports standards, such as H.239 for data collaboration, that are
required for those devices to communicate, regardless of whether they are endpoints, MCUs,
gatekeepers or gateways. For example, the VidyoGateway can be integrated with SIP PBX. It
seamlessly integrates into the network providing the end user with an easy experience regardless of
whether they’re calling a Vidyo device or traditional H.323/SIP device.

Vidyo Solution Benefits Summary vs. H.264 AVC

This table summarizes the main advantages of the Vidyo solution.

Technology Benefits

Vidyo Quality VidyoTechnology displays excellent video quality in respect to

bandwidth availability, CPU usage and peripheral devices.
Since no MCU is needed, VidyoTechnology provides a better
image quality under identical conditions. With Legacy H.264
AVC products the MCU adds additional encode-compose-
decode function which reduces overall experience, and adds
significant delays.

Vidyo Intelligence and Native Rate VidyoTechnology is able to automatically adjust the quality,
Matching resolution and frame rate based on the availability, processing
power and screen resolution. Additionally, Vidyo maintains
the best possible quality without any freezing or tearing while
network conditions are changing versus constant frame rate-
resolution combination at legacy H.264 AVC endpoints.

Vidyo Independence VidyoTechnology allows each endpoint to negotiate rates and

resolution independently of the other participants in the
conference. This allows every participant to have the best
video quality possible without having to lower video quality to
the lowest common denominator.

Vidyo IP Error Resilience VidyoTechnology can provide a good teleconferencing

experience while facing 15-20 percent packet loss. Legacy
H.264 AVC products become useless and break down in when
than packet loss exceeds two to three percent.

4
Overview

Technology Benefits

Vidyo End to End Delays The VidyoRouter introduces a delay lower than 20ms. Overall,
the VidyoTechnology implementation has significantly lower
end to end delays than legacy AVC endpoints. Typical end to
end latency for multipoint conference on a VidyoRouter is less
than 250ms. This is extremely low compared to legacy
videoconferencing systems, which can experience end to end
multipoint latency at close to 500 ms.

Vidyo Ease of Use Vidyo provides an intuitive interface that dynamically adjusts
the layout as users join or leave the conference. The users can
toggle between different modes and numbers of remote users
with one single click. Regular users are able to set up and join
conferences without the need for a special operator—a
capability few legacy videoconferencing products possess.

Vidyo Redundancy With VidyoTechnology, adding redundancy involves just

adding another low cost VidyoRouter, while retaining existing
licenses. For comparison with legacy MCU products a
complete MCU with identical capacity needs to be acquired if
redundancy is desired.

Vidyo Security Vidyo supports secure conferencing thanks to the use of AES
128-bit encryption.

Vidyo Low Cost per Conference Vidyo Technology requires less hardware, thus significantly
Line lowering the costs per active line.

Vidyo Savings: No need for MCU. VidyoTechnology does not require an expensive MCU to
No need for Room ports. create a multipoint conference. Unlike traditional
videoconferencing solutions, Vidyo’s room-based endpoints
do not require any additional licenses.

Acronyms Used in This Guide

The following table includes acronyms used in this guide and what they stand for.

Acronym Detail

AES Advanced Encryption Standard

API Application Programming Interface

HTTP Hypertext Transfer Protocol

LDAP Lightweight Directory Access Protocol

5
Overview

Acronym Detail

MCU Multipoint Control Unit

NAT Network Address Translator

RTCP Real-time Transport Control Protocol

RTP Real-time Transport Protocol

SOAP Simple Object Access Protocol

WSP Web Services Platform

WSDL Web Services Description Language

6
 1. Customizable Architecture
The diagram below shows the customizable components of the VidyoConferencing architecture The
Web Services APIs allow third parties to develop their own custom portals or endpoints based on
Vidyo’s technology
This document does not discuss the VidyoClient API. Please refer to the Vidyo Client API User Guide for
information about the VidyoClient API.

Custom Custom
Application Portal

VidyoDesktop VidyoPortal

VidyoClient API Web Services API

VidyoConferencing
VidyoClient Server

Library
VidyoRouter

7
 2. VidyoPortal API Overview
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:
 VidyoPortalSuperService.wsdl
 VidyoPortalAdminService.wsdl
 VidyoPortalGuestService.wsdl
 VidyoPortalUserService.wsdl
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.

Data Model
The data model for 2.x logically consists of Members, Rooms, Gateways, and legacy devices as
illustrated in this figure:

8
2. VidyoPortal API Overview

Members—Members are users who have authorized accounts to use the portal. Members always use
their login name and password for authentication. Members can originate/receive direct calls (also
known as two party calls), join meeting rooms and they can be “invited” to meeting rooms. Members
may have a display name and other parameters. Each Member belongs to a Group.
Rooms—Rooms are named conferences that members (or guests) may join, depending on the status,
PIN, availability, etc. Rooms are of three types:
 Personal
 Public
 Scheduled
Each room has an owner. The owner can modify the room’s properties; control the conference when in
session, etc. Each member has one personal room. When a member or a legacy device (via gateway)
tries to reach a member with a personal room, they will have an option of either joining the personal
room or placing a direct call to the member. Like members, Rooms may also have more descriptive
display names. Rooms may also have multiple aliases for addressing purposes. For example, the unique
names “alice meeting” and “2001” could both refer to the same meeting room, which has the display
name “Alice Jones’ Meeting.”
Group—A group has a set of properties. All the members belonging to a group share these properties.
Gateways—Gateways are used to make and receive calls to external legacy devices that are not part of
Vidyo Conferencing system. Calls to these legacy devices are identified by prefixes followed by the

9
2. VidyoPortal API Overview

devices address. Based on the prefix, the request is routed to the appropriate gateway to bring a legacy
device to the conference.
Guests—Guests do not belong to the system; however, they are allowed to join the room without any
authentication. Guest can be invited to a meeting room by using Guest WS API.

Overview of Super APIs

This section describes the Super interface. Implicit in each request are authorization parameters (login
and password) identifying the requester These APIs can be used towards developing “super admin”
tools. Only members with the role defined as “Admin” are able to use these APIs.
VidyoPortal Super Service URL:
http://VIDYOPORTAL/services/VidyoPortalSuperService?wsdl
The following functionality is available under Super APIs:

Member Tenants Management

 Create a new Tenant
 Delete a Tenant
 Update a Tenant
 Get Tenant’s details—all or search based on matching prefixes
 Get list of tenants in the system

Other Methods
 Get system licenses
 Get list of service
 Delete Database
 Get System components
 Get IPC domain access control level
 Get allowed / blocked IPC Domains
 Set IPC control
 Add / Remove allowed IPC Domain
 Get router pool
 Get location tags

10
2. VidyoPortal API Overview

Overview of Admin APIs

This section describes the Admin interface. Implicit in each request are authorization parameters (login
and password) identifying the requester These APIs can be used towards developing “admin” tools.
Only members with the role defined as “Admin” are able to use these APIs.
VidyoPortal Admin Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalAdminService?wsdl
VidyoReplay Content Management Service URL:
http://VIDYOPORTAL/replay/services/VidyoReplayContentManagementService?wsdl
The following functionalities are available under admin APIs:

Member Account Management

 Create a new Member
 Delete a Member
 Update a Member
 List Member’s details—all or search based on matching prefixes

Meeting Room Management

 Create a Room
 Delete a Room
 Update a Room
 List Rooms—all or search based on matching prefixes

Group Management
 Create a Group
 Delete a Group
 Update a Group
 List Groups – all or search based on matching prefixes
The functionality available under the Admin > Settings tab like Shutdown, Restart, Upgrade Software,
Changing IP address, adding Gateways, etc. are not exposed via web services APIs.

Record Control
 Start Recording
 Stop Recording

11
2. VidyoPortal API Overview

 Resume Recording
 Pause Recording
 Get Recording Profiles

Content Management
 Search Recorded File
 Update Recorded File
 Delete Recorded file

Webcasting
 Create Webcast URL
 Remove Webcast URL
 Get Webcast URL
 Remove Webcast Pin
 Get Recording Profiles

Using Search APIs

When using search APIs, follow these guidelines:
 Searches are not case sensitive.
 Hyphens and periods are delimiters that modify the query to only return exact matches for entire
strings.
 Underscores are always treated as part of a string.
 All other special characters are treated as delimiters between strings.
 All strings in the query need to have a match for a record to be returned.

Overview of Guest APIs

This section describes the Guest APIs aimed at developing third party endpoints or applications
targeted for end users providing functionality like login as a guest and Join the conference as defined in
this section. Guest API methods do not require authorization parameters (login and password).
VidyoPortal Guest Service URL:
http://VIDYOPORTAL/services/VidyoPortalGuestService?wsdl
The following functionality is available under Guest APIs:
 Login as a guest

12
2. VidyoPortal API Overview

 Link EndPoint
 Join a Conference as a guest

Guest User Login Process Overview

Definitions
The following parameters are used as part of the Guest Login process:
 guestName
 roomKey
 Portal Access Key (PAK)
PAK is provided as part of login response by VidyoPortal
 EndpointID (EID)
A unique identifier representing an Endpoint.
This is provided by the VidyoDesktop.
 guestID
A unique identifier representing a Guest within the VidyoPortal.
This is provided as part of login response by VidyoPortal.
The following steps describe the sequence of events in the Guest Login process:
1. SOAP-Request from Application to VidyoPortal
LogInAsGuest (roomKey, guestName)
2. SOAP-Response from VidyoPortal to Application
LogInAsGuest (PAK)
3. For WS Application only:
a. HTTP-Request from Application to VidyoDesktop on 127.0.0.1:63457 with the following
parameters
 Redirect URL (URL): The VidyoDesktop provides response using a HTTP redirect. The
application provides this Redirect URL and processes the information to retrieve the
response parameters.
 VidyoManager (vm) address

 VidyoPortal (portal) service address

 VidyoProxy (proxy) address

 UN (UN):Temporary Username

 PAK (PAK): Portal Access Key

13
2. VidyoPortal API Overview

 e.g.
http://127.0.0.1:63457/dummy?url=http://dev20.vidyo.com/lin
kendpoint.ajax?vm=PVCVG7NXUC5YER8FCXBC1ZD88NK6PQ7VYR2918XAX
[email protected]:17992;transport=TCP&un=XpMgcsg
dEl5z5vT8&pak=9YprUdCg8gPKpr5H&proxy=64.71.164.195:443&port
al=http://main.vidyo.com/services/&loctag=Default_Location
b. HTTP-Redirect from VidyoDesktop to Application
 EID

 VidyoDesktop version

4. For Custom Client and WS Application(unified client):

Note If you’re not developing a custom client using the VidyoClient Library please skip this section and
go to step 4. The following steps are required usage of VidyoClient library.

a. Client API: Send VIDYO_CLIENT_IN_EVENT_SIGN_IN (LogInAsGuest response

params )
b. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN
c. Check param.activeEid field to see if the EID is already set up
If the EID is not set up (equal NULL):
a. Client API: Send VIDYO_CLIENT_IN_EVENT_LICENSE
b. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LICENSE
c. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN Returns
activeEID (which should be active at this point-equal 1)
d. Client API: Send VIDYO_CLIENT_REQUEST_GET_EID Returns EID string
e. WS GuestAPI: LinkEndpointToGuest (guestID, EID)
 LinkEndpointToGuest (OK)

f. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LINKED

g. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGNED_IN
Process complete. Wait a few seconds before joining the conference.
h. SOAP-Request from Application to VidyoPortal
 GuestJoinConference(guestID, pin)

Tip: To retrieve EID from you browser please run you client go to
http://127.0.0.1:63457/?retrieve=eid
5. SOAP-Request from Application to VidyoPortal
a. LinkEndpointToGuest (guestID, EID)

14
2. VidyoPortal API Overview

6. SOAP-Response from VidyoPortal to Application

a. LinkEndpointToGuest (OK)
7. SOAP-Request from Application to VidyoPortal
a. GuestJoinConference(guestID, pin)

Overview of User APIs

This section describes the User APIs aimed at developing third party endpoints or applications targeted
for end users providing functionality like search, join meetings rooms, make direct calls, etc. as defined
in this section. Implicit in each request are authorization parameters (login and password) identifying
the requester if any API method allows anonymous requests (e.g. allowing guests to join a meeting
room), then the requester will be assumed to be Guest if the request does not contain credentials.
VidyoPortal User Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalUserService?wsdl
VidyoReplay Content Management Service URL:
http://VIDYOPORTAL/replay/services/VidyoReplayContentManagementService?wsdl
The following functionality is available under User APIs:

Member Account and Preference

 Get Member account details
 Update Member Account details

Member Speed Dial Settings

 Get Member’s Speed Dial list
 Update Member’s Speed Dial list

Search Operations
 List Members and status - all or search based on matching prefixes
If all is specified, the result set will be limited to a fixed maximum item and further queries are
required to fetch rest of the items.
 List Rooms and status - all or search based on matching prefixes

Meeting Room and Direct Call

 Member LogIn so that the other Members will be able to invite and place direct calls to this Member
 Member LogOut so that this member is not available anymore

15
2. VidyoPortal API Overview

 Place a Direct Call to other Member

 Join a Meeting Room
 Invite another Member to a Meeting Room

Room Settings and Control

 Generate a meeting room URI. Members and Guest users can follow this Uri link to join the meeting
room.
 Delete the meeting room URI
 Lock meeting room for restricting access to a meeting
 Unlock meeting room for allowing access to a meeting
 List participants in a given meeting
 Disconnect participant from a given meeting. Deleting a room automatically disconnects the
meeting room participants.
 Mute / Unmute audio for a given participant in a meeting
 Start / Stop Video for a given participant in a meeting
 Create or update PIN for a room

Record Control
 Start Recording
 Stop Recording
 Resume Recording
 Pause Recording
 Get Recording Profiles

Content Management
 Search Recorded File
 Update Recorded File
 Delete Recorded file

Webcasting
 Create Webcast URL
 Remove Webcast URL
 Get Webcast URL
 Remove Webcast Pin

16
2. VidyoPortal API Overview

 Get Recording Profiles

Using Search APIs

When using search APIs, follow these guidelines:
 Searches are not case sensitive.
 Hyphens and periods are delimiters that modify the query to only return exact matches for entire
strings.
 Underscores are always treated as part of a string.
 All other special characters are treated as delimiters between strings.
 All strings in the query need to have a match for a record to be returned.

User Login Process Overview

Definitions
The following parameters are used as part of the User Login process:
 Username (UN)
 Used in HTTP Authentication header for every WS API request. This is provided by the WS API
application.
 Password (PW)
 Used in HTTP Authentication header for every WS API request. This is provided by the WS API
application.
 Portal Access Key (PAK)
 PAK is provided as part of login response by VidyoPortal.

 EndpointID (EID)
 A unique identifier representing an Endpoint

 This is provided by the VidyoDesktop

 EntityID

♦ A unique identifier representing an Entity within the VidyoPortal

♦ This is provided as part of login response by VidyoPortal
♦ The EntityID is used follow web services API after login to represent any Entity in the
VidyoPortal
The following steps describe the sequence of events in the User Login process:
1. SOAP-Request from Application to VidyoPortal

17
2. VidyoPortal API Overview

logIn (UN, PW)

2. SOAP-Response from VidyoPortal to Application
logIn (PAK)
3. HTTP-Request from Application to VidyoDesktop on 127.0.0.1:63457 with the following
parameters
 Redirect URL (URL): The VidyoDesktop provides response using a HTTP redirect. The
application provides this Redirect URL and processes the information to retrieve the
response parameters.
 VidyoManager (vm) address
 VidyoPortal (portal) service address
 VidyoProxy (proxy) address
 UN (UN): Username
 PAK (PAK): Portal Access Key
e.g.
http://127.0.0.1:63457/dummy?url=http://dev20.vidyo.com/linken
dpoint.ajax?vm=PVCVG7NXUC5YER8FCXBC1ZD88NK6PQ7VYR2918XAXRQA600
[email protected]:17992;transport=TCP&un=chetan&pak=9YprU
dCg8gPKpr5H&proxy=64.71.164.195:443&portal=http://main.vidyo.c
om/services/&loctag=Default_Location
4. HTTP-Redirect from VidyoDesktop to Application
 EID
 VidyoDesktop version
Tip: To retrieve EID from you browser please run you client go to
http://127.0.0.1:63457/?retrieve=eid
5. SOAP-Request from Application to VidyoPortal
 linkEndpoint (UN, PW, EID)
6. SOAP-Response from VidyoPortal to Application
 linkEndpoint (OK)
7. The Entity structure includes EntityID
Tip: For guaranteed successful logged in process please check your endpoint status in web
browser http://127.0.0.1:63457/?retrieve=epstatus. This will help to safely conclude if the
endpoint change the status (online/busy/offline).

18
2. VidyoPortal API Overview

Getting the VidyoDesktop Version

Custom Application can retrieve the VidyoDesktop version and compare it with the VidyoDesktop
which resides at VidyoPortal appliance in order to make a decision if VidyoDesktop Upgrade requires.
VidyoPortal version information is included into the HTTP redirect response from VidyoDesktop to the
Custom Application (step 4 of the Sign in procedure).
For example
HTTP Request:
http://127.0.0.1:63457/dummy?url=http://dev20.vidyo.com/linkendpoint.a
jax?vm=PVCVG7NXUC5YER8FCXBC1ZD88NK6PQ7VYR2918XAXRQA600VM0001@dev20.vid
yo.com:17992;transport=TCP&un=chetan&pak=9YprUdCg8gPKpr5H&proxy=64.71.
164.195:443&portal=http://main.vidyo.com/services/&loctag=Default_Loca
tion
HTTP Response:
GET /ws/user/SetEid.php?id=C80AA912A444-0730383237383939-
D9DCFE4CB33867D5&version=TAG_VD_2_0_3_00218 HTTP/1.1

First-Time license Implementation User Login Process

Note If you’re not developing a custom client using the VidyoClient Library please skip this section.

The following login steps are required usage of VidyoClient library. These steps should be followed only
if you’re developing a custom client.

19
2. VidyoPortal API Overview

1. Client API: Send VIDYO_CLIENT_IN_EVENT_LOGIN (portal addr, username,

passw)
2. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LOGIN
3. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN.
4. Check param.activeEid field to see if the EID is already set up
If the EID is not set up:
a. Client API: Send VIDYO_CLIENT_IN_EVENT_LICENSE
b. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LICENSE
c. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN Returns EID (which should
be active at this point.)
5. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LINKED
6. Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGNED_IN Process complete. Wait a
few seconds before joining the conference.
Tip: check your endpoint status after login process complete.
7. Client API: Send VIDYO_CLIENT_REQUEST_GET_ENDPOINT_STATUS

20
 3. Web Services Super API
This chapter describes the Web Services Super API.
The super API provides super admin capabilities to manage and provision tenants within their portals.
With the Super API, Super admin can create new tenants, update and delete tenants, as well as get
information about their portal service components. The requirements from the user using this API are
to have super admin rights.
VidyoPortal Super Service URL:
http://VIDYOPORTAL/services/VidyoPortalSuperService?wsdl
The following methods are described in this document as part of the Super API package.

addClientVersion
Adds the endpoint upload as a content delivery network (CDN) URL and Tag.

Request Parameters

Name Type Description Required

ClientType String Specifies the type of client being requested: Yes

 Type is 'W' for Windows platform
(deprecated)
 Type is ‘W32’ for Windows 32-bit
 Type is ‘W64’ for Windows 64-bit
 Type is 'M' for Mac OS platform
 Type is ‘S’ for Linux 32-bit rpm installer
 Type is ‘T’ for Linux 64-bit rpm installer
 Type is ‘U’ for Ubuntu Linux 32-bit deb
installer
 Type is ‘X’ for Ubuntu Linux 64-bit deb
installer
 Type is ‘P’ for VidyoPanorama 600 running
Windows 32-bit

21
3. Web Services Super API

Name Type Description Required

 Type is ‘N’ for VidyoPanorama 600 running
Windows 64-bit
 Type is ‘E’ for VidyoPanorama 600 running
Linux 32-bit
 Type is ‘O’ for VidyoPanorama 600 running
Linux 64-bit
 Type is ‘Q’ for VidyoRoom running Windows
32-bit
 Type is ‘Y’ for VidyoRoom running Windows
64-bit
 Type is ‘F’ for VidyoRoom running Linux 32-
bit
 Type is ‘Z’ for VidyoRoom running Linux 64-
bit
 Type is ‘B’ for Softroom running Windows
64-bit
 Type is ‘C’ for Softroom running Windows
64-bit
 Type is ‘D’ Softroom running Mac OS 64-bit
 Type is ‘L’ for Linux (deprecated)

currentTag EndpointVersion Specifies the tag of the endpoint version using a Yes
Pattern string pattern. Only a-z or A-Z or 0-9 or ‘.’ and
‘_’ are allowed.

installerURL string Specifies the URL where the endpoint can be Yes
downloaded from. Currently http and https are
allowed as protocols.

setActive boolean Makes the new endpoint upload URL active. No

Response Parameter

Name Type Description Required

EndpointUploadID Integer The endpoint upload ID of the newly created Yes

endpoint upload URL

22
3. Web Services Super API

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault Invalid argument

ExternalModeFault The external mode is not enabled by the Super Admin

ListTenants
Provides the list of all tenants in the system with the following filters. All filters are optional, and if a
filter is not provided, the query will use the defaults, which are sorting all the tenants by the tenant
names in ascending order.
This method can use the following parameters:

Request Parameters

Name Type Description Required

tenantName String Specifies the tenant name No

tenantURL String Specifies the tenant URL No

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any of
or all of the variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
start=30 value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
limit=10 value.

23
3. Web Services Super API

Name Type Description Required

sortBy String This is the field by which the requestor is asking No

the results to be sorted by.
memberID
In the User API, entityID is used instead of
name
memberID.
Display name
Example: If the result has to be sorted in an
extension ascending order by the extension number of the
Entity, then the requestor provides the
sortBy=extension/name/displayName or
memeberID value.

dir String This is the field by which the requestor is asking No

the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of the
Entity, then the requestor provides the
dir=ASC value.

Response Parameters

Name Type Description Required

listOfTenants: SingleTenantDataType Array of Object includes:

tenantID Integer Specifies the tenant ID Yes

tenantName String Specifies the tenant name Yes

tenantURL String Specifies the tenant URL Yes

extensionPrefix String Tenant extension prefix Yes

dialinNumber Integer Tenant dial-in number Yes

vidyoReplayUrl String Tenant's VidyoReplay URL Yes

description String Description of the tenant Yes

vidyoMobileAllowed Boolean Indicates whether access for Yes

VidyoMobile ('0' - no/false, '1' -
yes/true)

24
3. Web Services Super API

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedFault API is not licensed

createTenant
Creates a new tenant based on the information provided below. If an optional parameter is not
provided, the default will be set during the initial configuration.
This method can use the following parameters:

Request Parameters

Name Type Description Required

tenantName String Name of the tenant Yes

tenantURL String Tenant URL Yes

extensionPrefix String Tenant extension prefix Yes

dialinNumber String Tenant extension prefix No

vidyoReplayUrl String Tenant's VidyoReplay URL No

Description String Description of the tenant No

numOfInstalls Integer Specifies the number of current Yes

Installs

numOSeats Integer Specifies the number of current Yes

Seats

numOfLines Integer Specifies the number of current Yes

Lines

numOfExecutives Integer Specifies the number of current Yes

Executives ('0' if using the Port
License system)

25
3. Web Services Super API

Name Type Description Required

numOfPanoramas Integer Specifies the number of current Yes

Panoramas ('0' if using the Port
License system)

enableGuestLogin Boolean Indicates whether guest login is No

enabled for the tenant (default:
TRUE)

allowedTenantList List of Integers List of all tenants that this No

tenant can call to (default:
none)

vidyoManager Integer VidyoManager Yes

vidyoProxyList List of Integers Available VidyoProxys No

allowedVidyoGateway List of Integers List of allowed Gateways to the No

List tenant

allowedVidyoReplay List of Integers List of allowed VidyoReplay No

RecorderList recorders to the tenant

allowedVidyoReplay List of Integers List of allowed VidyoReplays to No

List tenant

allowedLocationTag List of Integers List of allowed location tags Yes

List

vidyoMobileAllowed Boolean Indicates whether access for No

VidyoMobile is enabled or
disabled (default: Enabled)

ipcAllowOutbound Boolean Indicates whether IPC No

Outbound is allowed ('0' -
no/false, '1' - yes/true) (default:
'1')

ipcAllowInbound Boolean Indicates whether IPC Inbound No

is allowed ('0' - no/false, '1' -
yes/true) (default: '1')

adminUser Member Provides information for setting No

up an admin user for the tenant.
If this parameter is not
provided, a default admin user
account will be created.

26
3. Web Services Super API

Name Type Description Required

numOfPublicRooms Nonnegative Integer Maximum number of public No

rooms that can be created by a
user

externalEndpointSoftware String Sets the endpoint upload mode No

Fileserver (Enumerated) to External which will allow CDN
URLs to be used
‘VidyoPortal’ or
‘External’

tenantWebRTCURL String URL of Vidyo Neo for WebRTC No

Server

mobileLoginMode String Sets the appropriate mobile No

(Enumerated) access mode at the tenant level.

‘Disabled,’
Note When mobileLoginMode
‘VidyoMobile,’ or
is enabled, the
‘NeoMobile’ vidyoMobileAllowed API
is ignored.

Response Parameter

Name Type Description Required

OK String Acknowledgement that the tenant was created Yes

successfully

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ExistingTenantFault The specified Tenant name, extension prefix, VidyoReplay URL, and
tenant URL already exist

MissingArgumentFault Some required request parameters were not specified; return the list
of missing Parameter Names

27
3. Web Services Super API

deleteTenant
Requests the deleting of an existing tenant from the system. The default tenant cannot be deleted.
This method can use the following parameters:

Request Parameter

Name Type Description Required

tenantID Integer Specifies the tenant unique identifier Yes

Response Parameter

Name Type Description Required

OK String Acknowledgement that the tenant was deleted Yes

successfully

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

InvalidTenantFault The specified Tenant ID doesn't exist

NotLicensedFault API is not licensed

updateTenant
Updates an existing tenant by the tenant ID. Each optional parameter that is provided, aside from the
tenant ID, will overwrite the existing parameters.
 Although not required, all parameters that are provided will override the existing values
 If a parameter is not provided, it will be deleted from the tenant
 Parameters specified as Required are parameters that cannot be deleted but only updated
This method can use the following parameters:

28
3. Web Services Super API

Request Parameters

Name Type Description Required

tenantID Integer Specifies the tenant unique Yes

identifier

tenantName String Name of the tenant Yes

tenantURL String Tenant URL Yes

extensionPrefix String Tenant extension prefix Yes

dialinNumber String Tenant extension prefix No

vidyoReplayUrl String Tenant's VidyoReplay URL No

description String Description of the tenant No

numOfInstalls Integer Specifies the number of Yes

current Installs

numOfSeats Integer Specifies the number of Yes

current Seats

numOfLines Integer Specifies the number of Yes

current Lines

numOfExecutives Integer Specifies the number of Yes

current Executives ('0' if using
the Port License system)

numOfPanoramas Integer Specifies the number of Yes

current Panoramas ('0' if
using the Port License
system)

enableGuestLogin Boolean Indicates whether guest login No

is enabled for the tenant
(default: TRUE)

allowedTenantList List of List of all tenants that this No

Integers tenant can call to (default:
none)

vidyoManager Integer VidyoManager Yes

vidyoProxyList List of Available VidyoProxys No

Integers

29
3. Web Services Super API

Name Type Description Required

allowedVidyoGatewayList List of List of allowed Gateways to No

Integers the tenant

allowedVidyoReplayRecorderList List of List of allowed VidyoReplay No

Integers recorders to the tenant

allowedVidyoReplayList List of List of allowed VidyoReplays No

Integers to tenant

allowedLocationTagList List of List of allowed location tags Yes

Integers

vidyoMobileAllowed Boolean Indicates whether access for No

VidyoMobile is enabled or
disabled (default: Enabled)

ipcAllowOutbound Boolean Indicates whether IPC No

Outbound is allowed ('0' -
no/false, '1' - yes/true)
(default: '1')

ipcAllowInbound Boolean Indicates whether IPC No

Inbound is allowed ('0' -
no/false, '1' - yes/true)
(default: '1')

adminUser Member Provides information for

updating the admin user
information.
 If this parameter is not
provided, no update
should occur.
 If information of an
existing admin user is
being provided (based on
the 'Name' field), update
the additional fields.
 If information of a non-
existing user is provided,
no update should occur
nor creation of a new
admin user. In this case,
an exception should be
thrown.

30
3. Web Services Super API

Name Type Description Required

numOfPublicRooms NonNegative Maximum number of public No

Integer rooms that can be created by
a user

externalEndpointSoftwareFileserver String Sets the endpoint upload No

(Enumerated) mode to External which will
allow CDN URLs to be used
‘VidyoPortal’
or ‘External’

tenantWebRTCURL String URL of Vidyo Neo for No

WebRTC Server

mobileLoginMode String Sets the appropriate mobile No

(Enumerated) access mode at the tenant
level.
‘Disabled,’
‘VidyoMobile,’
Note When
or
mobileLoginMode is
‘NeoMobile’
enabled, the
vidyoMobileAllowed
API is ignored.

Response Parameter

Name Type Description Required

OK String Acknowledgement that the tenant was updated Yes

successfully

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ExistingTenantFault The specified Tenant name, extension prefix, VidyoReplay URL, and
tenant URL already exist

NotLicensedFault API is not licensed

31
3. Web Services Super API

Name Description

InvalidTenantFault The specified Tenant ID doesn't exist

getTenantDetails
Gets the tenant details based on the tenant ID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

tenantID Integer Specifies the tenant unique Yes

identifier

Response Parameters

Name Type Description Required

tenantID Integer Specifies the tenant unique Yes

identifier

tenantName String Name of the tenant Yes

tenantURL String Tenant URL Yes

extensionPrefix String Tenant extension prefix Yes

dialinNumber String Tenant extension prefix No

vidyoReplayUrl String Tenant's VidyoReplay URL No

description String Description of the tenant No

numOfInstalls Integer Specifies the number of Yes

current Installs

numOfSeats Integer Specifies the number of Yes

current Seats

numOfLines Integer Specifies the number of Yes

current Lines

32
3. Web Services Super API

Name Type Description Required

numOfExecutives Integer Specifies the number of Yes

current Executives ('0' if using
the Port License system)

numOfPanoramas Integer Specifies the number of Yes

current Panoramas ('0' if using
the Port License system)

enableGuestLogin Boolean Indicates whether guest login No

is enabled for the tenant
(default: TRUE)

allowedTenantList List of Integers List of all tenants that this No

tenant can call to (default:
none)

vidyoManager Integer VidyoManager Yes

vidyoProxyList List of Integers Available VidyoProxys No

allowedVidyoGatewayList List of Integers List of allowed Gateways to No

the tenant

allowedVidyoReplayRecorderList List of Integers List of allowed VidyoReplay No

recorders to the tenant

allowedVidyoReplayList List of Integers List of allowed VidyoReplays No

to tenant

allowedLocationTagList List of Integers List of allowed location tags Yes

vidyoMobileAllowed Boolean Indicates whether access for No

VidyoMobile is enabled or
disabled (default: Enabled)

ipcAllowOutbound Boolean Indicates whether IPC No

Outbound is allowed ('0' -
no/false, '1' - yes/true) (default:
'1')

ipcAllowInbound Boolean Indicates whether IPC Inbound No

is allowed ('0' - no/false, '1' -
yes/true) (default: '1')

numOfPublicRooms Nonnegative Maximum number of public No

Integer rooms that can be created by a
user

33
3. Web Services Super API

Name Type Description Required

externalEndpointSoftware String Sets the endpoint upload No

Fileserver (Enumerated) mode to External which will
allow CDN URLs to be used
‘VidyoPortal’
or ‘External’

tenantWebRTCURL String URL of Vidyo Neo for WebRTC No

Server

mobileLoginMode String Sets the appropriate mobile No

(Enumerated) access mode at the tenant
level.
‘Disabled,’
‘VidyoMobile,’ Note When mobileLoginMode
or ‘NeoMobile’ is enabled, the
vidyoMobileAllowed API
is ignored.

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

InvalidTenantFault The specified Tenant name, extension prefix, VidyoReplay

URL, and tenant URL already exist

NotLicensedFault API is not licensed

setMobileLoginMode
Sets the appropriate mobile access mode for all tenants.
This method can use the following parameters:

Request Parameter

Name Type Description Required

34
3. Web Services Super API

mobileLoginMode MobileLoginMode Specifies whether mobile access is Yes

disabled, or whether VidyoMobile or
Vidyo Neo Mobile access is enabled

Response Parameter

Name Type Description Required

setMobileLogin OK Response for updating the mobile Yes

ModeResponse mode

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedFault API is not licensed

GetLicenseData
Provides the license key and value. If a tenant is not specified, the license parameters should be
provided for all tenants as a total number.
This method can use the following parameters:

Request Parameter

Name Type Description Required

tenantID EntityID Specified the tenant unique identifier Yes

Response Parameter

Name Type Description Required

LicenseFeature LicenseFeatureData Array of Object includes Name, Yes

maxValue, currentValue

35
3. Web Services Super API

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

InvalidTenantFault The specified Tenant ID doesn't exist

NotLicensedFault API is not licensed

GetServiceComponentsData
Provides the list of available system components. If the type is not specified, all available components
will be provided. If the type is specified, only the list associated with this type will be provided.
This method can use the following parameters:

Request Parameter

Name Type Description Required

ComponentType serviceComponentType Array of Object include : Yes

VidyoManager
VidyoGateway, VidyoProxy,
VidyoRecorder
VidyoReplay

Response Parameter

Name Type Description Required

component ComponentData Array of Object includes componentType, Yes

identifier, displayName

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

36
3. Web Services Super API

saveDB
Because users are now required to provide a password, this API has been deprecated starting with
VidyoPortal version 3.4.1. As an alternative, use backupDB.

backupDB
Backs up the database to a file. Optionally, thumbnail photos may be backed up. Backing up thumbnail
photos will increase the size of the archive. Additionally, if photos are being synced from LDAP, backing
up any thumbnail photos may not be necessary.
This method can use the following parameters:

Request Parameters

Name Type Description Required

password String Password with which to encrypt the backup file. Yes
In the future, the same password will be
required to decrypt the file.

includeThumbNail Boolean Indicates whether or not to backup the No

Thumbnail photos

Response Parameter

Name Type Description Required

databaseBackup String Contains a URL where the backup can be Yes

downloaded and timestamp that indicates when
the backup took place

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

37
3. Web Services Super API

listDB
Obtains a list of database backups, which returns a list of “DatabaseBackup” objects.
This method can use the following parameters:

Request Parameter

Name Type Description Required

None

Response Parameter

Name Type Description Required

databaseBackup String Contains a URL where the backup can be downloaded Yes
and timestamp that indicates when the backup took
place

Faults

Name Description

GeneralFault An unspecified error occurred

deleteDB
Deletes the database backup file from the disk.
This method can use the following parameters:

Request Parameter

Name Type Description Required

databaseName String Unique name of the database backup file Yes

Response Parameter

Name Type Description Required

38
3. Web Services Super API

OK String Acknowledgement that the database was deleted Yes

successfully

Faults

Name Description

GeneralFault An unspecified error occurred

ListNetworkComponents
Provides available portal components and their status (connected /disconnected), as well as more
detailed information as specified below.
 If no filter is being provided, all components will be provided back as part of the response with the
respective component information.
 If one or more filters are specified, the response will be based on the provided filters.
This method can use the following parameters:

Request Parameters

Name Type Description Required

componentName String Component name No

componentType SystemComponentType VidyoRouter, VidyoProxy, No

VidyoManager, VidyoReplay,
VidyoGateway

Status ComponentStatus UP; DOWN; DISABLED; NEW No

Response Parameter

Name Type Description Required

networkComponent SingleComponentDataType Array of Object includes Yes

componentType, identifier,
displayName,
componentType, ipAddress,
runningVersion, version,
alarm, swVer

39
3. Web Services Super API

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedFault API is not licensed

getIpcAccessControl
Provides the level of access that the user has to view and modify allowed IPC domains.
This method can use the following parameters:

Request Parameter

Name Type Description Required

None

Response Parameter

Name Type Description Required

IpcAccessControl String Array of Objects includes IpcAccessControlLevel Yes

object, accessMode object, routerID

Fault

Name Description

GeneralFault An unspecified error occurred

getIpcDomainList
Provides a list of all allowed or blocked IPC domains that are stored in the database.
This method can use the following parameters:

40
3. Web Services Super API

Request Parameter

Name Type Description Required

None

Response Parameter

Name Type Description Required

ipcDomainList String List of all the IPC domains that are allowed or Yes
blocked from access on the portal

Faults

Name Description

GeneralFault An unspecified error occurred

IncorrectIpcAccessLevelFault Generated when the user doesn't have access to change IPC
domain access

setIpcAccessControl
Defines the IPC control access (Allow / Block) for Tenant and System levels.
This method can use the following parameters:

41
3. Web Services Super API

Request Parameter

Name Type Description Required

ipcAccessControl IpcAccessControl Array of Objects includes

IpcAccessControlLevel object,
accessMode object, routerID

Response Parameter

Name Type Description Required

OK String Acknowledgement that the control access was set Yes

successfully

Faults

Name Description

GeneralFault An unspecified error occurred

MissingArgumentFault Some required request parameters were not specified / level is

set to System but accessMode is not provided

InvalidArgumentFault The arguments that were passed into services were wrong

setIpcDomains
Adds and /or removes the list of allowed IPC domains. The user can add and remove IPC domains at the
same time.
 If the same domain exists in both the add and remove lists, the domain will not be added and will
return in both notRemovedIpcDomainList and notAddedIpcDomainList lists.
 If an existing domain is requested to be added, it will show in the notAddedIpcDomainList list of
domains.
 If a non-existing domain is requested to be removed, it will show in the notRemovedIpcDomainList
list of domains.
This method can use the following parameters:

42
3. Web Services Super API

Request Parameters

Name Type Description Required

addIpcDomainList String A list of IPC domains to be added to the No

portal

removeIpcDomainList String A list of IPC domains to be removed from No

the portal

Response Parameters

Name Type Description Required

OK String Acknowledgement that the control Yes

access was set successfully

notAddedIpcDomainList String Specifies the list of domains that were No

not added

notRemovedIpcDomainList String Specifies the list of domains that were No

not removed

Fault

Name Description

GeneralFault An unspecified error occurred

getRouterPoolList
Retrieves the pool of routers.
This method can use the following parameters:

Request Parameter

Name Type Description Required

None

43
3. Web Services Super API

Response Parameter

Name Type Description Required

routerPoolsList RouterPool List of objects containing router information Yes

of routerID and routerName

Fault

Name Description

GeneralFault An unspecified error occurred

getLocationTags
Provides the location tags available on the portal.
This method can use the following parameters:

Request Parameter

Name Type Description Required

None

Response Parameter

Name Type Description Required

locationTagsList LocationTag List of objects containing router locationTagID Yes

and locationTagName

Faults

Name Description

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

44
3. Web Services Super API

setLoginAndWelcomeBanner
Sets the login and welcome banner parameters on the VidyoPortal tenants and enables/disables the
feature altogether.
This method can use the following parameters:

Request Parameters

Name Type Description Required

showLoginBanner Boolean Indicates if the login banner option is Yes

enabled/disabled on the VidyoPortal

showWelcomeBanner Boolean Indicates if the welcome banner option is Yes

enabled/disabled on the VidyoPortal

loginBannerText String Welcome text that appears after the client logs in. No
Character limit is 4000.

If nothing is provided, no update will be made to

the information on the tenant/portal.

welcomeBannerText String Welcome screen title text (example: Welcome to No

VidyoConferencing.). Character limit is 4000.

If nothing is provided, no update will be made to

the information on the tenant/portal.

Response Parameters

Name Type Description

showLoginBanner Boolean Provides the newly set state for this option

showWelcomeBanner Boolean Provides the newly set state for this option

loginBannerText String Provides the login banner text

welcomeBannerText String Provides the welcome banner title text

Fault

Name Description

45
3. Web Services Super API

BannerTextFault Specifies that the content provided overrides the character limit.

Text: "The text that you have provided exceeds the 4000 character limit"

SetChatStateSuper
Sets whether the chat is available on the VidyoPortal and sets the default values for private/public chat
on the newly created tenants. Once made unavailable, tenant admins will not be able to enable chat on
the VidyoPortal, and Vidyo clients joining conferences on this VidyoPortal will not be able to engage in
chat conversations.
This method can use the following parameters:

Request Parameter

Name Type Description Required

chatState ChatState An object that specifies whether the chat feature is Yes
enabled (True) or disabled (False) on the newly
created tenants.

(Please see below for the object definition.)

Response Parameter

Name Type Description

Ok String Acknowledges that the operation was made successfully

Fault

Name Description

GeneralFault An unspecified error occurred

46
3. Web Services Super API

ChatState is an object that specifies whether the chat feature is enabled (True) or disabled (False) on
the newly created tenants:

Name Type Description

chatAvailability Boolean Indicates whether chat is available (True) or unavailable (False) on

the VidyoPortal.

Chat is available by default.

privateChatState Boolean Indicates whether public chat is enabled (True) or disabled (False)
on the newly created tenants by default.

If chatAvailability is set to unavailable (False), this parameter is

disabled (False) by default.

Private chat is available by default.

publicChatState Boolean Indicates whether public chat is enabled (True) or disabled (False)
on the newly created tenants by default.

If chatAvailability is set to unavailable (False), this parameter is

disabled (False) by default.

Public chat is available by default.

getChatStateSuper
Gets the configured value for chat availability on the VidyoPortal, as well as the default values for
private and public chat for newly created tenants.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameter

47
3. Web Services Super API

Name Type Description

chatState ChatState An object that specifies whether chat feature is enabled (True) or
disabled (False) on the newly created tenants.

(Please see above for the object definition.)

Fault

Name Description

GeneralFault An unspecified error occurred

48
 4. Web Services Admin API
This chapter describes the Web Services Admin API.
VidyoPortal Admin Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalAdminService?wsdl

Note Super Admins can also access Admin Web Services.

addClientVersion
Adds the endpoint upload as a CDN URL and Tag.

Request Parameters

Name Type Description Required

ClientType String Specifies the type of client being requested: Yes

 Type 'W' is for Windows platform
(deprecated)
 Type ‘W32’ is for Windows 32-bit
 Type ‘W64’ is for Windows 64-bit
 Type 'M' is for Mac OS platform
 Type ‘S’ is for Linux 32-bit rpm installer
 Type ‘T’ is for Linux 64-bit rpm installer
 Type ‘U’ is for Ubuntu Linux 32-bit deb
installer
 Type ‘X’ is for Ubuntu Linux 64-bit deb
installer
 Type ‘P’ is for VidyoPanorama 600 running
Windows 32-bit
 Type ‘N’ is for VidyoPanorama 600 running
Windows 64-bit
 Type ‘E’ is for VidyoPanorama 600 running
Linux 32-bit

49
4. Web Services Admin API

Name Type Description Required

 Type ‘O’ is for VidyoPanorama 600 running
Linux 64-bit

 Type ‘Q’ is for VidyoRoom running

Windows 32-bit
 Type ‘Y’ is for VidyoRoom running
Windows 64-bit
 Type ‘F’ is for VidyoRoom running Linux
32-bit
 Type ‘Z’ is for VidyoRoom running Linux
64-bit
 Type ‘B’ is for Softroom running Windows
64-bit
 Type ‘C’ is for Softroom running Windows
64-bit
 Type ‘D’ is Softroom running Mac OS 64-
bit
 Type ‘L’ is for Linux (deprecated)

currentTag EndpointVersion Specifies the tag of the endpoint version using Yes
Pattern a string pattern. Only a-z or A-Z or 0-9 or ‘.’
and ‘_’ are allowed.

installerURL string Specifies the URL where the endpoint can be Yes
downloaded from. Currently http and https are
allowed as protocols.

setActive boolean Makes the new endpoint upload URL active. No

Response Parameter

Name Type Description Required

EndpointUploadID Integer The endpoint upload ID of the newly created Yes

endpoint upload URL

50
4. Web Services Admin API

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault Invalid argument

ExternalModeFault The external mode is not enabled by the Super Admin

getEndpointBehavior
Retrieves the endpoint behavior at the tenant level.
This method can use the following parameters:

Request Parameter

Name Type Description Required

endpointBehaviorkey String The mapping of the endpoint behavior. Yes

Response Parameter

Name Type Description

EndpointBehavior Endpoint Contains the parameters for all endpoint behavior

BehaviorType configurations. These parameters may include the
following:
 welcomePage (integer)
 beautyScreen (integer)
 loginModule (integer)
 publicChat (integer)
 leftPanel (integer)
 inCallSearch (integer)
 inviteParticipants (integer)
 contentSharing (integer)
 shareDialogOnJoin (integer)

51
4. Web Services Admin API

Name Type Description

 displayLabels (integer)
 remoteContentAccess (integer)
 cameraMuteControl (integer)
 muteCameraOnEntry (integer)
 audioMuteControl (integer)
 muteAudioOnEntry (integer)
 deviceSettings (integer)
 pinnedParticipant (integer)
 recordConference (integer)
 exitOnUserHangup (jnteger)
 automaticallyUpdate (integer)
 lockUserName (integer)
 enableAutoAnswer (integer)
 participantNotification (integer)
 fullScreenVideo (integer)

Optional Parameters
 windowSizeHeight (integer)
 windowSizeWidth (integer)
 windowPositionTop (integer)
 windowPositionBottom (integer)
 windowPositionLeft (integer)
 windowPositionRight (integer)
 recordingRole (string)
 preIframeUrl (string)
 preIframeSize (integer)
 topIframeUrl (string)
 topIframeSize (integer)

52
4. Web Services Admin API

Name Type Description

 leftIframeUrl (string)
 leftIframeSize (integer)
 rightIframeUrl (string)
 rightIframeSize (integer)
 bottomIframeUrl (string)
 bottomIframeSize (integer)
 postIframeUrl (string)
 postIframeSize (integer)
 endpointBehaviorKey (string)

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NoEndpointBehaviorExistsFault The endpoint behavior does not exist for the tenant

GeneralFault An unspecified error occurred

EndpointBehaviorDisabledFault The endpoint behavior has been disabled for the

tenant

createEndpointBehavior
Adds new endpoint behavior at the tenant level.
This method can use the following parameters:

Request Parameters

Name Type Description

EndpointBehavior Endpoint Contains the parameters for all endpoint behavior

BehaviorType configurations. These parameters may include the
following:

53
4. Web Services Admin API

Name Type Description

 welcomePage (integer)
 beautyScreen (integer)
 loginModule (integer)
 publicChat (integer)
 leftPanel (integer)
 inCallSearch (integer)
 inviteParticipants (integer)
 contentSharing (integer)
 shareDialogOnJoin (integer)
 displayLabels (integer)
 remoteContentAccess (integer)
 cameraMuteControl (integer)
 muteCameraOnEntry (integer)
 audioMuteControl (integer)
 muteAudioOnEntry (integer)
 deviceSettings (integer)
 pinnedParticipant (integer)
 recordConference (integer)
 exitOnUserHangup (jnteger)
 automaticallyUpdate (integer)
 lockUserName (integer)
 enableAutoAnswer (integer)
 participantNotification (integer)
 fullScreenVideo (integer)

Optional Parameters
 windowSizeHeight (integer)
 windowSizeWidth (integer)

54
4. Web Services Admin API

Name Type Description

 windowPositionTop (integer)
 windowPositionBottom (integer)
 windowPositionLeft (integer)
 windowPositionRight (integer)
 recordingRole (string)
 preIframeUrl (string)
 preIframeSize (integer)
 topIframeUrl (string)
 topIframeSize (integer)
 leftIframeUrl (string)
 leftIframeSize (integer)
 rightIframeUrl (string)
 rightIframeSize (integer)
 bottomIframeUrl (string)
 bottomIframeSize (integer)
 postIframeUrl (string)
 postIframeSize (integer)
 endpointBehaviorKey (string)

Response Parameters

Name Type Description Required

endpointBehaviorkey String The mapping of the endpoint behavior. No

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NoEndpointBehaviorExistsFault The endpoint behavior does not exist for the tenant

55
4. Web Services Admin API

Name Description

GeneralFault An unspecified error occurred

EndpointBehaviorDisabledFault The endpoint behavior has been disabled for the

tenant

updateEndpointBehavior
Updates the endpoint behavior at the tenant level.
This method can use the following parameters:

Request Parameters

Name Type Description

EndpointBehavior Endpoint Contains the parameters for all endpoint behavior

BehaviorType configurations. These parameters may include the
following:
 welcomePage (integer)
 beautyScreen (integer)
 loginModule (integer)
 publicChat (integer)
 leftPanel (integer)
 inCallSearch (integer)
 inviteParticipants (integer)
 contentSharing (integer)
 shareDialogOnJoin (integer)
 displayLabels (integer)
 remoteContentAccess (integer)
 cameraMuteControl (integer)
 muteCameraOnEntry (integer)
 audioMuteControl (integer)
 muteAudioOnEntry (integer)

56
4. Web Services Admin API

Name Type Description

 deviceSettings (integer)
 pinnedParticipant (integer)
 recordConference (integer)
 exitOnUserHangup (jnteger)
 automaticallyUpdate (integer)
 lockUserName (integer)
 enableAutoAnswer (integer)
 participantNotification (integer)
 fullScreenVideo (integer)

Optional Parameters
 windowSizeHeight (integer)
 windowSizeWidth (integer)
 windowPositionTop (integer)
 windowPositionBottom (integer)
 windowPositionLeft (integer)
 windowPositionRight (integer)
 recordingRole (string)
 preIframeUrl (string)
 preIframeSize (integer)
 topIframeUrl (string)
 topIframeSize (integer)
 leftIframeUrl (string)
 leftIframeSize (integer)
 rightIframeUrl (string)
 rightIframeSize (integer)
 bottomIframeUrl (string)
 bottomIframeSize (integer)

57
4. Web Services Admin API

Name Type Description

 postIframeUrl (string)
 postIframeSize (integer)
 endpointBehaviorKey (string)

58
4. Web Services Admin API

Response Parameters

Name Type Description

Ok String Acknowledges that the operation was made

successfully

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NoEndpointBehaviorExistsFault The endpoint behavior does not exist for the tenant

GeneralFault An unspecified error occurred

EndpointBehaviorDisabledFault The endpoint behavior has been disabled for the

tenant

deleteEndpointBehavior
Deletes the endpoint behavior at the tenant level.
This method can use the following parameters:

Request Parameters

Name Type Description Required

endpointBehaviorkey String The mapping of the endpoint behavior. No

Response Parameters

Name Type Description

Ok String Acknowledges that the operation was made

successfully

59
4. Web Services Admin API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NoEndpointBehaviorExistsFault The endpoint behavior does not exist for the tenant

GeneralFault An unspecified error occurred

EndpointBehaviorDisabledFault The endpoint behavior has been disabled for the

tenant

searchMembers
Optimizes searches for members.
This method can use the following parameters:

Request Parameters

Name Type Description Required

start integer Starting row number to return No

limit integer Maximum number of results to return No

sortBy string Field to sort by No

sortDir sortDir Sort ascending ("ASC") or descending ("DESC") No

MemberFilter MemberFilter A MemberFilter object containing: No

 memberName (string)
 roomExtension (string)
 RoleName
 groupName (string)
 status (string)

60
4. Web Services Admin API

Response Parameters

Name Type Description Required

start integer Starting row number returned Yes

limit integer Maximum number of results returned Yes

sortBy string Field sorted by Yes

MemberFilter MemberFilter A MemberFilter object containing: Yes

 memberName (string)
 roomExtension (string)
 RoleName
 groupName (string)
 status (string)

total total The total number of possble results Yes

Member Member The list of Member objects containing: No

 memberID (EntityID)
 name (string)
 password (string)
 displayName (string)
 extension (string)
 Language
 RoleName
 groupName (string)
 proxyName (string)
 emailAddress (string)
 created (string)
 description (string)
 allowCallDirect (boolean)
 allowPersonalMeeting (boolean)
 locationTag (string)
 creationTime (dateTime)

61
4. Web Services Admin API

Name Type Description Required

 modificationTime (dateTime)

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

GetMembers
Retrieves VidyoPortal members that meet the criteria specified in a filter (optional).
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any of or
all of the variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the start=30
value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the limit=10
value.

62
4. Web Services Admin API

Name Type Description Required

sortBy String: This is the field by which the requestor is asking No

the results to be sorted by.
memberID
name
Note In the User API, entityID is used instead of
Display memberID.
name
extension Example: If the result has to be sorted in an
ascending order by the extension number of the
Entity, then the requestor provides the
sortBy=extension/name/displayName or
memeberID value.

dir String This is the field by which the requestor is asking No

the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of the
Entity, then the requestor provides the dir=ASC
value.

query String: This is the search string that uses all the above No
filter criteria.
Example: If the requestor is looking for all
Member
members that start with the letters “pau,” then
name
query=pau would return the desired results.

Response Parameters

Name Type Description Required

total Integer Total number of registered members Yes

member member Member properties including name, display name, No

extension, email and others

GetMember
Retrieves the details of a single VidyoPortal member.

63
4. Web Services Admin API

This method can use the following parameters:

Request Parameter

Name Type Description Required

memberID EntityID The filter type is used to trim down (filter) the search results Yes

Response Parameter

Name Type Description Required

member Member Member properties including name, display name, extension, Yes
email, and others

64
4. Web Services Admin API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException Use not allowed due to lack of license

GeneralFault An unspecified error occurred

MemberNotFoundException Member not found

AddMember
Adds a VidyoPortal member.
This method can use the following parameters:

Request Parameter

Name Type Description Required

memberID Member Member details Yes

returnObjectInResponse String Sends a request to retrieve the object that No

has been created

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

MemberAlreadyExistsException Member already exists

65
4. Web Services Admin API

UpdateMember
Updates the details of a VidyoPortal member.

Note The UserName parameter can’t be changed using this method. In order to modify the user name,
a new user should be created and all parameters copied.

All other member parameters can be modified using the UpdateMember method.
This method can use the following parameters:

Request Parameters

Name Type Description Required

memberID EntityID Unique member identifier Yes

member Member New member’s properties Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

MemberNotFoundException Member not found

DeleteMember
Deletes the details of a VidyoPortal member.
This method can use the following parameters:

66
4. Web Services Admin API

Request Parameter

Name Type Description Required

memberID EntityID Unique member identifier Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

MemberNotFoundException Member not found

GetRooms
Retrieves rooms that meet optional search criteria.
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any
of or all of the variables below.

67
4. Web Services Admin API

Name Type Description Required

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
start=30 value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
limit=10 value.

sortBy String: This is the field by which the requestor is No

asking the results to be sorted by.
memberID
name
Note In the User API, entityID is used instead
displayName of memberID.
extension
Example: If the result has to be sorted in an
ascending order by the extension number of
the Entity, then the requestor provides the
sortBy= extension/name/displayName or
memeberID value

dir String: This is the field by which the requestor is No

asking the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of
the Entity, then the requestor provides the
dir=ASC value.

query String: This is the search string that uses all the above No
filter criteria.
name
displayName
Example: If the requestor is looking for all
extension members that start with the letters “pau,” then
query=pau would return the desired results

68
4. Web Services Admin API

Response Parameters

Name Type Description Required

total Integer Total number of rooms Yes

room Room Room description including room name, room owner and No
other properties

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GetRoom
Retrieves a room's details.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID Unique room identifier Yes

Response Parameter

Name Type Description Required

room room Room description Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

69
4. Web Services Admin API

Name Description

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RoomNotFoundException Room not found

GetRoomProfile
Requests to get a profile for a room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID Unique room identifier Yes

Response Parameter

Name Type Description Required

roomProfile RoomProfile Specifies the room profile Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SetRoomProfile
Requests to set a profile for a room.

70
4. Web Services Admin API

This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID Unique room identifier Yes

roomProfileName String Specifies the auto mute configuration selection Yes

profiles. The new profiles are:
 'VideoOnly' - will locally auto mute audio only
 'AudioOnly' - will locally auto mute video only
 'NoAudioAndVideo' - will auto mute both audio
and video

Response Parameter

Name Type Description Required

OK String Specify that the configuration has been setup Yes

successfully

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RemoveRoomProfile
Requests to remove a profile from a specified room ID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

71
4. Web Services Admin API

roomID EntityID Unique room identifier Yes

Response Parameter

Name Type Description Required

OK String Specify that the configuration has been setup Yes

successfully

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GetRoomProfiles
Requests to get a profile for rooms.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID Unique room identifier Yes

Response Parameters

Name Type Description Required

total Integer Total number of profiles that are Yes

available

roomProfile RoomProfile Specifies the room profile Yes

72
4. Web Services Admin API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

AddRoom
Adds a room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

room Room Room description including room name, room Yes

owner and other properties

returnObjectInResponse String Sends a request to retrieve the object that has No

been created

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RoomAlreadyExistsException Room already exists

73
4. Web Services Admin API

74
4. Web Services Admin API

UpdateRoom
Updates the details of a VidyoPortal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is the ID of addressing room object in the VidyoPortal Yes

room Room Room description including room name, room owner, and Yes
other properties

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RoomNotFoundException Room not found

RoomAlreadyExistsException Room already exists

75
4. Web Services Admin API

DeleteRoom
Removes a VidyoPortal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is the ID of addressing room object in the VidyoPortal Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RoomNotFoundException Room not found

RoomAlreadyExistsException Room already exists

enableRoom
Enables or disables the use of private or public rooms on the VidyoPortal.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID The unique room identifier Yes

76
4. Web Services Admin API

Name Type Description Required

Enabled Boolean Specifies whether the room will be enabled (True) or Yes
disabled (False)

Response Parameter

Name Type Description

OK String Acknowledges that the operation was made successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

RoomNotFoundFault Room not found

RoomIsEnabled
Retrieves the enabled or disabled status of the private or personal room on the VidyoPortal.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID The unique room identifier Yes

Response Parameter

Name Type Description

Enabled Boolean Provides the status of the room as enabled (True) or disabled (False)

77
4. Web Services Admin API

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

RoomNotFoundFault Room not found

enableScheduledRoom
Enables or disables a Scheduled room in the VidyoPortal.
This method can use the following parameters:

Request Parameters

Name Type Description Required

extension String The unique room identifier Yes

pin String The room’s randomly generated PIN. If the room was Optional
created with a PIN, this field is mandatory.

enabled Boolean Specifies whether the room will be enabled (True) or Yes
disabled (False)

Response Parameter

Name Type Description

OK String Acknowledges that the operation was made successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

78
4. Web Services Admin API

Name Description

RoomNotFoundFault Room not found

ScheduledRoomIsEnabled
Retrieves the enabled or disabled status of the Scheduled room on the VidyoPortal.
This method can use the following parameters:

Request Parameters

Name Type Description Required

extension String The room extension on the VidyoPortal Yes

pin String The room’s randomly generated PIN. If the room was Optional
created with a PIN, this field is mandatory.

Response Parameter

Name Type Description

enabled Boolean Provides the status of the room as enabled (True) or disabled (False)

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

RoomNotFoundFault Room not found

79
4. Web Services Admin API

GetGroups
Retrieves VidyoPortal groups that meet optional search criteria.
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any
of or all of the variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
start=30 value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
limit=10 value.

sortBy String This is the field by which the requestor is asking No

the results to be sorted by.
memberID
name
Note In the User API, entityID is used instead
Display name of memberID.
extension
Example: If the result has to be sorted in an
ascending order by the extension number of
the Entity, then the requestor provides the
sortBy=extension/name/displayName or
memeberID value.

80
4. Web Services Admin API

Name Type Description Required

dir String: This is the field by which the requestor is asking No

the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of
the Entity, then the requestor provides the
dir=ASC value.

query String This is the search string that uses all the above No
filter criteria.
Extension
displayName
Example: If the requestor is looking for all
name members that start with the letters “pau,” then
query=pau would return the desired results

81
4. Web Services Admin API

Response Parameters

Name Type Description Required

total Integer Total number of Groups Yes

group Group Group Description on the VidyoPortal including group No

name, max number of members, and other properties

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GetGroup
Retrieves the details of a VidyoPortal group.
This method can use the following parameters:

Request Parameter

Name Type Description Required

groupID EntityID This is an ID for addressing Group object in the VidyoPortal Yes

Response Parameter

Name Type Description Required

group Group Group Description on the VidyoPortal including group name, Yes
max number of members, and other properties

82
4. Web Services Admin API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

AddGroup
Adds a VidyoPortal group.
This method can use the following parameters:

Request Parameter

Name Type Description Required

group Group Group Description on the VidyoPortal including group Yes

name, max number of members, and other properties

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GroupAlreadyExists Group already exists

Exception

83
4. Web Services Admin API

UpdateGroup
Updates a VidyoPortal group.
This method can use the following parameters:

Request Parameters

Name Type Description Required

groupID EntityID This is an ID for addressing Group object in the Yes

VidyoPortal

group Group Group Description on the VidyoPortal including Yes

groupID, name, roomMaxUsers, userMaxBandWidthIn,
userMaxBandWidthOut, description, allowRecording

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GroupNotFoundException Group not found

DeleteGroup
Deletes a VidyoPortal group.
This method can use the following parameters:

84
4. Web Services Admin API

Request Parameter

Name Type Description Required

groupID EntityID This is an ID for addressing Group object in the Yes

VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GroupNotFoundException Group not found

GetParticipants
Lists the participants in a VidyoPortal member's personal room. The entityID must be set to the
VidyoPortal member's entityID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

conference EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

Response Parameters

Name Type Description Required

85
4. Web Services Admin API

Total Integer Total number of registered members Yes

Entity EntityID This object is returned as a result of search for member, No

public room, or legacy device

inviteToConference
Invites a VidyoPortal member to join a room. This request can be issued only by a VidyoPortal member
who can control the room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

entityID EntityID This is an ID for addressing a Member object in Yes

VidyoPortal

invite String This field could be used for dialing string to a legacy No
device or making a VidyoVoice call

callFromIdentifier String The optional “callFromIdentifier” used to override No

the from extension number, should only be used for
customization with legacy. This should only be used
in the case of customization of the caller details.

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments wete passed into services were wrong

86
4. Web Services Admin API

SeatLicenseExpiredFault Seat license expired and needs to be renewed

LeaveConference
Removes a participant (endpoint) from a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

MuteAudio
Mutes the audio for a given participant (endpoint) in the conference.
This method can use the following parameters:

87
4. Web Services Admin API

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

UnmuteAudio
Unmutes the audio for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

88
4. Web Services Admin API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

StartVideo
Starts the video for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

89
4. Web Services Admin API

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

StopVideo
Stops the video for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

CreateRoomURL
Creates an URL for a room or VidyoPortal member's personal room.
This method can use the following parameters:

90
4. Web Services Admin API

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

91
4. Web Services Admin API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RemoveRoomURL
Deletes an URL for a room or VidyoPortal member's personal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

92
4. Web Services Admin API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

CreateRoomPIN
Creates a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

pin String Room pin No

93
4. Web Services Admin API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RemoveRoomPIN
Removes a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

94
4. Web Services Admin API

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

GetLicenseData
Retrieves the VidyoPortal’s license data.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameters

Name Type Description Required

Name String Feature names Ports, Seats, and Installs Yes

MaxValue String Maximum number of Ports, Seats, and Installs that are Yes
licensed

CurrentValue String Used number of the Ports, Seats, and Installs No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

95
4. Web Services Admin API

inviteToConference
Invites a VidyoPortal member to join a room. This request can be issued only by a VidyoPortal member
who can control the room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

entityID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

invite String This field could be used for dialing string to a No

LegacyDevice or making a VidyoVoice call

callFromIdentifi String The optional “callFromIdentifier” used to override

er the from extension number, should only be used for
customization with legacy. Thi s should only be used
in the case of customization of the caller details.

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to bre renewed

96
4. Web Services Admin API

createModeratorPIN
Creates a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

PIN String Specifies the Moderator PIN - used for creating and Yes
updating an existing PIN

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

InvalidModeratorPINFormatFault The format of the Moderator PIN is not valid - either not right
amount of digits, or invalid characters (PIN should be a 3-10
digit number)

ControlMeetingFault The user is not allowed to control the conference (only for
User API)

removeModeratorPIN
Creates a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:

97
4. Web Services Admin API

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

PIN String Specifies the Moderator PIN - used for creating and Yes
updating an existing PIN

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ControlMeetingFault The user is not allowed to control the conference (only for User API)

GetPortalVersion
Gets the portal version.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

98
4. Web Services Admin API

portalVersion String Portal version Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

GetLocationTags
Gets the available Location Tags.
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any of
or all of the variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
start=30 value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
limit=10 value.

sortBy String: This is the field by which the requestor is asking No

the results to be sorted by.

99
4. Web Services Admin API

Name Type Description Required

memberID
Note In the User API, entityID is used instead of
name
memberID.
displayNa
me
Example: If the result has to be sorted in an
extension ascending order by the extension number of the
Entity, then the requestor provides the
sortBy=extension/displayName/name or
memberID value.

dir String: This is the field by which the requestor is asking No

the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of the
Entity, then the requestor provides the dir=ASC
value.

query String: This is the search string that uses all the above No
filter criteria.
Extension
Name
Example: If the requestor is looking for all
Display members that start with the letters “pau,” then
Name query=pau would return the desired results

Response Parameters
Response containing available Location Tags.

Name Type Description Required

total Integer Total number of entities Yes

location Location Location tag name No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

100
4. Web Services Admin API

InvalidArgumentFault The arguments that were passed into services were wrong

ScheduledRoomEnabled
Checks whether the Scheduled Rooms feature is enabled on the tenant level.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always empty) Use only the HTTP Authentication header N/A

Response Parameter

Name Type Description

scheduledRoomEnabled Boolean Indicates whether the Scheduled Room feature has been
disabled on the tenant

101
4. Web Services Admin API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

disableScheduledRoom
Disables the Scheduled Room feature on the tenant per the tenant URL.
This method can use the following parameters:

Request Parameter

Name Type Description Required

disableScheduledRoom Boolean Set the Scheduled Room Yes

feature on the tenant:
'1' | True (disable)
'0' | False (enable)

Response Parameter

Name Type Description

OK String Acknowledgement that the Scheduled Room

feature has been disabled on the tenant

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

102
4. Web Services Admin API

cancelOutboundCall
Enables the moderator to cancel an outgoing user invite request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Specifies the conference ID that the Yes

moderator is logged in to

entityID EntityID Indicates that the user that has been Yes
invited. User cannot invite an entity
that is of type Legacy

Response Parameter

Name Type Description

Ok String Indicates that the cancelation has been successful

Faults

Name Description

InvalidArgumentFault Invalid Argument Fault or in case that the conferenceID or entityID

doesn't exist

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

SetChatStateAdmin
Sets whether the private and/or public chat options should be enabled or disabled on the tenant. Once
disabled, Vidyo clients joining conferences on this VidyoPortal will not be able to engage in a chat
conversation.

103
4. Web Services Admin API

This method can use the following parameters:

Request Parameters

Name Type Description Required

setPrivateChatState Boolean Indicates whether the private chat is enabled No

(True) or disabled (False) on the tenant.

Private chat is enabled by default.

setPublicChatState Boolean Indicates whether the public chat is enabled No

(True) or disabled (False) on the tenant.

Public chat is enabled by default.

Response Parameter

Name Type Description

OK String Acknowledges that the operation was made successfully

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

ChatNotAvailableInSuperFault Chat was set to "Unavailable" by the Super Admin and therefore
the chat states cannot be updated

startLectureMode
Starts Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints
will go into Presenter mode.

104
4. Web Services Admin API

This method can use the following parameters:

Request Parameter

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

105
4. Web Services Admin API

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

stopLectureMode
Stops Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints
will exit Presenter mode.
This method can use the following parameters:

Request Parameter

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

106
4. Web Services Admin API

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

GetLectureModeParticipants
Requests to list the participants in a meeting as identified by EntityId (which is similar to
GetParticipants but supports Presenter mode instead). To list the participants in a personal room
belonging to a Member, the EntityID must be set to the Member.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

filter.<nnnn> The filter type is used to trim down (filter) the No

search results. The value <nnnn> could be any of
or all of the variables below.

Response Parameters

Name Type Description

total Integer Number of participants

recorderID Integer Recorder ID of the recorder active in the conference

recorderName String Recorder name

paused Boolean Recording status

webcast Boolean Is webcast enabled for the conference

lectureMode Boolean Is Lecture Mode on for this conference

LectureMode LectureMode Object of the participants list

Participant Participant

Faults

Name Description

107
4. Web Services Admin API

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

LectureModeParticipant is an object with the following parameters:

Name Type Description

entityID EntityID Entity ID

participantID EntityID Entity ID

EntityType EntityType EntityType object. There are three types of entities in VidyoPortal:
Member, Room, and Legacy

displayName String Display name

extension String Extension

audio Boolean Indicates whether the audio is muted

video Boolean Indicates whether the video is muted

appshare Boolean Indicates whether there is a content share

handRaised Boolean Indicates whether a hand is raised

presenter Boolean Indicates whether the participant is presenting

DismissRaisedHand
Signals the dismissal of a hand from the moderator to the endpoint that had previously raised a hand.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

participantID EntityID Participant ID of the participant who had raised Yes

hand that the moderator wishes to dismiss

108
4. Web Services Admin API

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

DismissAllRaisedHand
Dismisses all raised hands from the moderator.
This method can use the following parameters:

109
4. Web Services Admin API

Request Parameter

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

SetPresenter
Assigns a presenter to the conference during Presenter mode (a.k.a., Lecture mode).
This method can use the following parameters:

110
4. Web Services Admin API

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

participantID EntityID Participant ID of the participant who had raised Yes

hand that the moderator wishes to dismiss

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

RemovePresenter
Removes a presenter from the conference during Presenter mode (a.k.a., Lecture mode).
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

participantID EntityID Participant ID of the participant who had raised Yes

hand that the moderator wishes to dismiss

111
4. Web Services Admin API

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

SetTenantRoomAttributes
Sets the room attributes listed below and decides on the desired behavior for Presenter mode and
Waiting Room for all the rooms on that tenant. These settings cannot be overridden by normal users.
This method can use the following parameters:

Request Parameters

Name Type Description Required

setWaitingRoomState Integer Indicates whether Waiting Room is: No

 Disabled on the meetings in the tenant (0)
 Enabled and when the owner joins, the
conference will begin (1)
 Enabled and a presenter should be
assigned to the meeting (2)
The request parameter is optional, and no
change will take place if a value is not provided.

112
4. Web Services Admin API

Name Type Description Required

supportedClientsOnly Boolean Specifies whether endpoints that do not No

support Presenter and Waiting Room modes
cannot join the meeting (True) or are allowed in
(False).

The request parameter is optional, and no

change will take place if a value is not provided.

Response Parameter

Name Type Description

Ok String Acknowledges that the operation was made successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

createPublicRoom
Allows an admin to create a public room for a particular user by specifying the Display Name. Auto-
generates the Room Name and Extension, and enforces limitations on the number of public rooms that
a User, Tenant, and Portal can create.
This method can use the following parameters:

Request Parameters

Name Type Description Required

displayName string Display name of the public room Yes

ownerName string Owner name of the public room Yes

setInMyContacts boolean Specifies whether to add the public room to No

contact list

113
4. Web Services Admin API

Name Type Description Required

setLocked boolean Indicates whether the public room is locked No

setPIN string Indicates whether the public room is pinned No

description string Description of the public room No

Response Parameters

Name Type Description Required

roomID EntityID EntityID of the newly created public room Yes

extension string Extension of the public room. Yes

roomURL anyURI URL for the public room. Yes

inMyContacts boolean Indicates whether public room is in contact No

list

locked boolean Indicates whether public room is locked No

hasPIN boolean Indicates whether public room has a PIN No

Faults

Name Description

NotLicensedFault API is not licensed

NotAllowedToCreateFault Not authorized to create public room

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

PublicRoomCreationFault Failed to create a public room

createScheduledRoom
Creates an ad-hoc conference room. Allows for specifying between 1 and 400 unused days after which
the room will be garbage collected in the system. When specifying 0, the VidyoPortal currently auto-
selects 100 days by default. As part of the response, the user receives a unique room link or extension
and PIN to access this room.

114
4. Web Services Admin API

Note The maximum number of scheduled rooms per user is 65K. Therefore, careful planning of room
owner assignments is recommended.

This method can use the following parameters:

Request Parameters

Name Type Description Required

ownerName String The room owner user name Yes

recurring Integer Unused days after which the room will be garbage Optional
collected

setPIN Boolean The room will be generated with a PIN Optional

moderatorPIN String Specifies the Moderator PIN for the newly created Optional
room

Response Parameters

Name Type Description

extension String The room’s unique ID

pin String The room’s randomly generated PIN

inviteContent String Content of the invite text (will include the room URL, PIN, and
extension)

roomURL String The room’s URL

inviteSubject String The email invitation subject

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

InvalidModeratorPINFormat Invalid Moderator PIN Fault

Fault

115
4. Web Services Admin API

Name Description

ScheduledRoomCreationFault Scheduled Room Creation Fault

TransferParticipantRequest
Transfers a participant (identified by participantID) from their current conference to another
conference (identified by conferenceID) with an optional PIN (roomPIN). If the destination conference
is PIN-protected, the correct PIN must be provided.

Note This API only supports participants that are legacy endpoints connected via the VidyoGateway.

Request Parameters

Name Type Description Required

participantID EntityID The participant to be transferred Yes

conferenceID EntityID The destination conference Yes

roomPIN String The PIN for the destination conference No*

Response Parameter

Name Type Description Required

OK String String representation of successful Yes

operation

Faults

Name Description

InvalidArgumentFault  “Invalid ParticipantID” (when <= 0)

 “Invalid ConferenceID” (when <= 0)
 “ParticipantID is not a valid virtual endpoint”
 “Participant cannot be transferred to conference they are
already in.”
 “ParticipantID for <participantID> belongs to other tenant”

116
4. Web Services Admin API

Name Description
 “Invalid ConferenceID and/or PIN”
Applies the following cases:

 DB error looking up conference

 Conference does not exist

 Conference belongs to other tenant

 Personal or public room has a PIN but not provided or

does not match

Scheduled room validation errors for the following cases:

 PIN not provided but is required

 Ext/PIN validation fails via scheduled room API

 “Room is disabled.”
 “Room is locked.”
 “Room is full.”

GeneralFaultException VidyoPortal is unable to communicate with the VidyoGateway

NotLicensedException VidyoPortal is not licensed for Admin APIs

setLayout
Sets the display layout to Gallery View, Active Speaker, or Continuous Presence.

Note This API only supports participants that are legacy endpoints connected via the VidyoGateway.

Request Parameters

Name Type Description Required

participantID EntityID Obtained from getParticipants Yes

layout String Not validated by the VidyoPortal. Valid No

choices include:
 Gallery View

117
4. Web Services Admin API

 Active Speaker
 Continuous Presence

maxParticipants Integer Not validated by the VidyoPortal. Valid No

choices include integers from 1 through 8.

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault Invalid ParticipantId or ParticipantID is not a virtual endpoint

GeneralFault Unable to communicate with endpoint

118
 5. Web Services Guest API
This chapter describes the Web Services Guest API.
VidyoPortal Guest Service URL:
http://VIDYOPORTAL/services/VidyoPortalGuestService?wsdl

LogInAsGuest
Login request to the VidyoPortal for guest users. Guest is identified in the guestName parameter.
Http authentication header is not needed for this request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestName String Name of the guest Yes

roomKey String Unique Room identifier. Yes

WSAdminAPI::GetRoom/s request or
WSUserAPI::Search will provide you the room
RoomUrl.

The room Url has the roomkey. You should parse

this key. (room URL example
http://dev20.vidyo.com/flex.html?roomdirect.html
&key=t9EPujHlpYAR)

returnEndpoint Boolean Flag to return the endpoint behavior if configured No

Behavior

Response Parameters

Name Type Description Required

guestID String Guest Id Yes

isLocked Boolean true or false No

hasPin Boolean true or false No

119
5. Web Services Guest API

Name Type Description Required

vmaddress String VidyoManager address No

proxyaddress String VidyoProxy address No

loctag String Location Tag (to be used for cascading scenarios) No

un String Temporary guest username Yes

pak String The Portal Access Key Yes

portal String Portal address No

portalVersion String Portal Version No

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ResourceNotAvailableFault Resources are not available for the requested operation

RoomIsFullFault Room is full

LinkEndpointToGuest
Retrieves the VidyoPortal guest entity from the VidyoPortal. Http authentication header is not needed
for this request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

EID String Endpoint ID – User associated with the Vidyo Yes

endpoint identifier

vrIP String VidyoRouter Ip address No

120
5. Web Services Guest API

Name Type Description Required

clientType String Represent client type Type is 'W' for Windows No

platform. Type is 'M' for MacOS platform. Type is 'V'
for VidyoRoom HD200 (Windows platform). Type is
'R' for VidyoRoom HD100/HD50 (Windows platform).
Type is 'L' for Linux platform. Type is 'S' for SL5
platform. Type is 'U' for Ubuntu platform. Type is 'T'
for SL5 64bit platform. Type is 'X' for Ubuntu 64bit
platform. Type is 'I' for iOS Type is 'A' for Android

121
5. Web Services Guest API

Response Parameter

Name Type Description Required

Entity EntityID If the user’s authentication is successful, the Member Yes

entity is returned

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

AccessRestrictedFault Resources are not available for the requested operation

createTestcallRoom
Creates a test call room, which gets forwarded to the WebRTC test call server.
This method can use the following parameters:

Request Parameters

Name Type Description Required

CreateTestcallRo Create Creates a test call room Yes

omRequest Testcall
Room
Request

Response Parameter

Name Type Description Required

extension String Extension number of the room Yes

roomURL URI URL to access the room Yes

roomKey String Unique room access key Yes

122
5. Web Services Guest API

Faults

Name Description

GeneralFault An unspecified error occurred

TestcallRoomCreationFault An unspecified error occurred while creating the test call room

GuestJoinConference
A VidyoPortal member’s request to join a meeting room. Request by a guest to join a meeting room
identified by hash string.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

pin String PIN is an optional string in case the room has a PIN No

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ResourceNotAvailableFault Resources are not available for the requested operation

WrongPinFault PIN provided to joinConference is wrong

ConferenceLockedFault Conference provided by EntityID is unable to be joining, due to the

fact that it is locked

123
5. Web Services Guest API

RoomIsFullFault Resources are not available - Room is full

AllLinesInUseFault Resources are not available - All Lines in use

joinIPCConference
A VidyoPortal member’s request to join a meeting room on a different portal using IPC (Inter-Portal
Communication).
This method can use the following parameters:

Request Parameters

Name Type Description Required

local-part String This is an address of room (username for private room, Yes
room name for public room or extension)

domain String FQDN or IP address of remote VidyoPortal Yes

pin String (optional) required if remote room is pinned No

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedFault API is not licensed

WrongPinFault PIN provided to joinIPCConference is wrong

ConferenceLockedFault Conference provided by EntityID is unable to be joined due to the fact

that it is locked

SeatLicenseExpiredFault Seat license has expired and needs to be renewed

124
5. Web Services Guest API

getClientVersion
Returns the version of the active client endpoint uploaded for a Tenant, which may be a CDN URL or
VidyoPortal URL. There can be multiple versions uploaded but only one version can be active for a given
client type. If there is no active client, the response parameters come back empty.
This method can use the following parameters:

Request Parameter

Name Type Description Required

ClientType String Specifies the type of client being requested: Yes

 Type is 'W' for Windows platform
 Type is 'M' for Mac OS platform
 Type is 'V' for VidyoRoom HD-200 (Windows
platform)
 Type is 'R' for VidyoRoom HD-100/HD-50
(Windows platform)
 Type is 'L' for Linux platform
 Type is 'S' for SL5 platform
 Type is 'U' for Ubuntu platform
 Type is 'T' for SL5 64-bit platform
 Type is 'X' for Ubuntu 64-bit platform
 Type is 'P' for VidyoPanorama 600
 Type is 'N' for VidyoPanorama 600 running
Windows 64-bit
 Type is 'O' for VidyoPanorama 600 running Linux
 Type is 'Q' for VidyoRoom running Windows 32-
bit
 Type is 'Y' for VidyoRoom running Windows 64-bit
 Type is 'Z' for VidyoRoom running Linux

Response Parameters

Name Type Description Required

125
5. Web Services Guest API

CurrentTag String Specifies the tag of the endpoint version Yes

InstallerURL String Specifies the CDN or VidyoPortal URL where the Yes
endpoint can be downloaded from

Faults

Name Description

InvalidArgumentFault Invalid Argument Fault or in case that the conferenceID or

entityID doesn't exist

GeneralFault An unspecified error occurred

setEndpointDetails
Enables endpoints to report their capabilities to the VidyoPortal during the authentication process. The
endpoints must report their capabilities in order to be given permission for some of the system level
features such as Presenter Mode. Vidyo endpoints gain new capabilities as features are added to newer
versions.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestID Integer Guest ID Yes

EID String The endpoint ID Yes

EndpointFeature EndpointFeature The list of features supported by the Optional

endpoint and whether those are
enabled or not

applicationName String The Vidyo application name (for Optional

example, VidyoDesktop, VidyoMobile,
etc.)

applicationVersion String The application version (for example, Optional

VidyoDesktop, VidyoMobile, etc.)

applicationOs String The OS on which the Vidyo application Optional

is running (for example, Windows)

126
5. Web Services Guest API

deviceModel String The device model on which the Optional

application is running (for example,
iPhone 5S)

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

EndpointNotBoundFault Endpoint Not Bound Fault

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

WhatIsMyIPAddress
Requests the VidyoPortal to send the endpoint public IP address. This information is also reflected in
the CDR table.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

127
5. Web Services Guest API

Response Parameter

Name Type Description

endpointExternalIPAddress String Returns the EP's external IP address or Unknown if the IP

address in unknown

Fault

Name Description

GeneralFault An unspecified error occurred

RaiseHand
Signals the VidyoPortal about a raise hand request made during Presenter mode (a.k.a., Lecture mode)
from a participant.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestID integer Guest ID Yes

Username String Username Yes

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Fault

Name Description

GeneralFault An unspecified error occurred

128
5. Web Services Guest API

UnraiseHand
Signals the VidyoPortal about an unraise hand request made during Presenter mode (a.k.a., Lecture
mode) from a participant who had previously raised their hand.
This method can use the following parameters:

Request Parameters

Name Type Description Required

guestID Integer Guest ID Yes

Username String Username Yes

Response Parameter

Name Type Description

OK String Acknowledges that the request was received successfully

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

129
 6. Web Services User API
This chapter describes the Web Services User API.
VidyoPortal User Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalUserService?wsdl

logIn
Retrieves the Protocol Access Key (pak) from the VidyoPortal.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

returnEndpointBehavior Boolean Flag to return the endpoint behavior if No

configured

returnAuthToken Boolean Flag to return the authentication token No

returnPortalVersion Boolean Flag to return the corresponding VidyoPortal No

version

Response Parameters

Name Type Description Required

Pak String The Portal Access Key- If the user’s authentication is Yes
successful, the Portal Access Key is returned

vmaddress String VidyoManager address No

proxyaddress String VidyoProxy address No

Loctag String Location Tag (to be used for cascading scenarios) No

pak2 String Returns the PAK2 string when PAK2 is supported by No

the VidyoPortal

130
6. Web Services User API

Name Type Description Required

authToken String Authentication token that can be used in subsequent No

requests

portalVersion String The VidyoPortal version No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

linkEndpoint
Retrieves the VidyoPortal member entity from the VidyoPortal using a valid HTTP authentication
request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

EID String Endpoint ID - User identified in HTTP Yes

authentication header is associated with the
Vidyo endpoint identifier

vrIP String VidyoRouter IP Address No

clientType String Represents the following client types: No

 Type 'W' is for Windows platform
 Type 'M' is for MacOS platform
 Type 'V' is for VidyoRoom HD200
(Windows platform)
 Type 'R' is for VidyoRoom HD100/HD50
(Windows platform)

131
6. Web Services User API

Name Type Description Required

 Type 'L' is for Linux platform
 Type 'S' is for SL5 platform
 Type 'U' is for Ubuntu platform
 Type 'T' is for SL5 64bit platform
 Type 'X' is for Ubuntu 64bit platform
 Type 'I' is for iOS
 Type 'A' is for Android

applicationName String Vidyo application name (for example,

VidyoDesktop, VidyoMobile, etc.)

applicationVersion String Application version (for example,

VidyoDesktop, VidyoMobile, etc.)

applicationOS String OS on which the Vidyo application is running

(for example, Windows)

deviceModel String Device model on which the application is

running (for example, iPhone 5S)

pak2 Boolean PAK2 support

Response Parameter

Name Type Description Required

Entity EntityID If the user’s authentication is successful, the Member Yes

entity is returned

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

AccessRestrictedFault Access restriction to login through mobile device

132
6. Web Services User API

logOut
Sends a sign-out request to the VidyoPortal.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Use only the HTTP Authentication header Yes

Empty)

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

myEndPointStatus
Queries the status of a user identified in a valid HTTP authentication request.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header Yes

133
6. Web Services User API

Response Parameter

Name Type Description Required

MemberStatus String Describes the member status based on the operation Yes
state of the endpoint in use by the member:
 Status is Offline and hence can't be reached for a
conference.
 Status is Online and can be reached for a
conference or a direct call.
 Status is Busy in conference and can't be reached
for another conference or a direct call.
 Status is BusyInOwnRoom in conference in own
personal room and can't can be reached for
another conference.
 Status is Ringing endpoint associated with
member start to ring on receive direct call or invite
event from other part.
 Status is RingAccepted endpoint associated with
member accept the call from other part.
 Status is RingRejected endpoint associated with
member reject the call from other part.
 Status is RingNoAnswer endpoint associated with
member is not answered in some period of time.
 Status is Alerting endpoint associated with
member is alerting about income call.
 Status is AlertCancelled endpoint associated with
member is stop to be alerting about income call.

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault If an unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

134
6. Web Services User API

Name Description

SeatLicenseExpiredFault Seat license expired and needs to be renewed

search
Searches for VidyoPortal members, rooms, or legacy devices that match the criteria specified in the
filter.
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the Yes
search results. The value <nnnn> could be any
of or all of the variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
start=30 value.

limit Integer This is the number of results that are being No

requested.

Example: If the result has 50 elements, and the

requestor only wants 10 element from the 30th
position, then the requestor provides the
limit=10 value.

135
6. Web Services User API

Name Type Description Required

sortBy memberID This is the field by which the requestor is No

asking the results to be sorted by.
name
Display name
Note In the User API, entityID is used instead
extension of memberID.

Example: If the result has to be sorted in an

ascending order by the extension number of
the Entity, then the requestor provides the
sortBy=extension/name/displayName or
memeberID value.

Entity Type Member This is the filed which rquestor is asking the Yes
results to be sorted by.
Room
Member - in which case the private room is
Legacy
returned
Room - in which case all the public rooms
belong to owner of input roomID are returned
Legacy - in which case filtered by legacy

dir String This is the field by which the requestor is No

asking the results to be sorted in a specific
ASC
direction/order, ascending or descending.
DESC
Example: If the result has to be sorted in an
ascending order by the extension number of
the Entity, then the requestor provides the
dir=ASC value.

query String: This is the search string that uses all the above No
filter criteria.
Extension
displayName
Example: If the requestor is looking for all
Name members that start with the letters “pau,” then
query=pau would return the desired results.

Response Parameter

Name Type Description Required

total Integer Total number of entities Yes

136
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to renewed

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

searchMyContacts
Returns a list of favorite VidyoPortal members, rooms, and legacy devices for a member of the
VidyoPortal identified in a valid HTTP authentication request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the search Yes
results. The value <nnnn> could be any of or all of the
variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the start=30 value.

limit Integer This is the number of results that are being requested. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the limit=10 value.

137
6. Web Services User API

Name Type Description Required

sortBy String: This is the field by which the requestor is asking the No
results to be sorted by.
memberID
name
Note In the User API, entityID is used instead of
Display memberID.
name
extension Example: If the result has to be sorted in an ascending
order by the extension number of the Entity, then the
requestor provides the
sortBy=extension/name/displayName or memeberID
value.

dir String This is the field by which the requestor is asking the No
results to be sorted in a specific direction/order, ascending
ASC
or descending.
DESC
Example: If the result has to be sorted in an ascending
order by the extension number of the Entity, then the
requestor provides the dir=ASC value.

query String: This is the search string that uses all the above filter No
criteria.
name
Display
Example: If the requestor is looking for all members that
name
start with the letters “pau,” then query=pau would return
extension the desired results.

138
6. Web Services User API

Response Parameters

Name Type Description Required

total Integer Total number of entities Yes

Array of entities Entity Array of entities (o…n) No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

searchByEnityID
Searches for all entities (mainly rooms) by member's EntityID.
Based on filter criteria, the SearchByEntityID method returns the public or private roomID list that
belongs to the owner of input.

Note When making calls, all PINs are masked from users other than the room owner.

The search response can be filtered based on the Entity type of:
1. Member - in which case the private room is returned
2. Room - in which case all the public rooms belong to owner of input roomID are returned
3. Legacy - in which case filtered by legacy
This method can use the following parameters:

139
6. Web Services User API

Request Parameters

Name Type Description Required

Entity EntityID This is an ID for addressing the member object in the Yes
VidyoPortal.

filter.<nnnn> The filter type is used to trim down (filter) the search Yes
results. The value <nnnn> could be any of or all of the
variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the start=30 value.

limit Integer This is the number of results that are being requested. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the limit=10 value.

sortBy memberID This is the field by which the requestor is asking the results No
to be sorted by.
name
Display
Note In the User API, entityID is used instead of
name
memberID.
extension
Example: If the result has to be sorted in an ascending
order by the extension number of the Entity, then the
requestor provides the
sortBy=extension/name/displayName or memeberID
value.

dir String This is the field by which the requestor is asking the results No
to be sorted in a specific direction/order, ascending or
ASC
descending.
DESC
Example: If the result has to be sorted in an ascending
order by the extension number of the Entity, then the
requestor provides the dir=ASC value.

Entity Member This is the filed which rquestor is asking the results to be YES
Type sorted by.
Room
Member - in which case the private room is returned

140
6. Web Services User API

Name Type Description Required

Legacy Room - in which case all the public rooms belong to owner
of input roomID are returned
Legacy - in which case filtered by legacy

query String: This is the search string that uses all the above filter No
criteria.
name
Display
Example: If the requestor is looking for all members that
name
start with the letters “pau,” then query=pau would return
extension the desired results.

Response Parameters

Name Type Description Required

total Integer Total number of entities Yes

Array of entities Entity Array of entities (o…n) No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

searchMembers
Optimizes searches for members, returning the users whose name and email matches the query string
by default if neither “name” or “email” is specified in the queryField.
This method can use the following parameters:

141
6. Web Services User API

Request Parameters

Name Type Description Required

query string Query string searched. Minimum of two Yes

characters.

queryField string Field to search on: "name" (default) or "email". If No

neither is specified, then the default would be
both “name” and “email”.

memberType string Member type to search: "member" (default) or No

"legacy" or "member|legacy"

start int Starting row number to return (0-99, 0 is default) No

limit int Number of rows to return (0-100, 10 is default) No

sortBy string Field to sort against: "name" (default) No

sortDir sortDir Ascending or descending sort: "ASC" (default) or No

"DESC"

Response Parameters

Name Type Description Required

query string Query string searched Yes

queryField string Field searched on Yes

memberType string Member type searched Yes

start int Starting row number Yes

limit int Number of rows returned Yes

sortBy string Field sorted on Yes

sortDir sortDir Sort order returned Yes

total int Total number of results possible Yes

142
6. Web Services User API

Name Type Description Required

Member Member A list of Member objects containing: No

 entityID (EntityID)
 name (string)
 description (string)
 email (string)
 enabled (boolean)
 type (string)
 isInMyContacts (boolean)
 MemberStatus object

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

searchRooms
Optimizes searches for rooms, returning personal rooms whose display name matches the query string.
Searching on personal room is applicable only when roomType is “personal”.
This method can use the following parameters:

Request Parameters

Name Type Description Required

query string Query string searched. Minimum of two Yes

characters.

queryField string Field to search on: "roomNameOrExtension" No

(default) or "ownerName" or "ownerEntityID"

143
6. Web Services User API

Name Type Description Required

roomType string Room type to search: "public" (default) or No

"personal" or "legacy" or combination thereof
using pipe ("|"), e.g., "(public|legacy)"

start int Starting row number to return (0-99, 0 is default) No

limit int Number of rows to return (0-100, 10 is default) No

sortBy string Field to sort against: "roomName" (default) or No

"extension"

sortDir sortDir Ascending or descending sort: "ASC" (default) or No

"DESC"

Response Parameters

Name Type Description Required

query string Query string searched Yes

queryField string Field searched on Yes

roomType string Room type searched Yes

start int Starting row number to return (0-99, 0 is default) Yes

limit int Number of rows to return (0-100, 10 is default) Yes

sortBy string Field sorted on Yes

sortDir sortDir Ascending or descending sort: "ASC" (default) or Yes

"DESC"

total int Total number of results possible

144
6. Web Services User API

Name Type Description Required

Room Room A list of Room objects containing:

 entityID (EntityID)
 name (string)
 displayName (string)
 extension (string)
 description (string)
 ownerEntityID (EntityID)
 ownerName (string)
 type (string)
 pinned (boolean)
 locked (boolean)
 enabled (boolean)
 isInMyContacts (boolean)

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

addToMyContacts
Adds a VidyoPortal member, room, or legacy device to a VidyoPortal member's favorites.
This method can use the following parameters:

145
6. Web Services User API

Request Parameter

Name Type Description Required

entityID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

RemoveFromMyContacts
Removes an entity (member, room, or legacy devices) from the member's favorites.

146
6. Web Services User API

This method can use the following parameters:

Request Parameter

Name Type Description Required

entityID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

inviteToConference
Invites a VidyoPortal member to join a room. This request can be issued only by a VidyoPortal member
who can control the room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the Room object in the

VidyoPortal where the conference is started

and Yes

147
6. Web Services User API

Name Type Description Required

entityID EntityID This is an ID for addressing the Room object in the

VidyoPortal where the conference is started.

OR

conferenceID EntityID This is an ID for addressing the Room object in the

VidyoPortal where the conference is started

and Yes

invite URL String This field could be used for dialing String to a Legacy
Device or making a VidyoVoice call

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

148
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

createTestcallRoom
Creates a test call room, which gets forwarded to the WebRTC test call server.
This method can use the following parameters:

Request Parameters

Name Type Description Required

CreateTestcallR Create Creates a test call room Yes

oomRequest Testcall
Room
Request

Response Parameter

Name Type Description Required

extension String Extension number of the room Yes

roomURL URI URL to access the room Yes

roomKey String Unique room access key Yes

Faults

Name Description

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

149
6. Web Services User API

NotLicensedFault API is not licensed

TestcallRoomCreationFault An unspecified error occurred while creating the test call room

SeatLicenseExpiredFault Seat license expired and needs to be renewed

joinConference
A VidyoPortal member’s request to join a meeting room. To join a VidyoPortal member's personal
room, the entityID must the set to the VidyoPortal member's entityID.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

pin String PIN is an optional string in case the room has a PIN No

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

WrongPinFault Wrong pin

ConferenceLockedFault Conference locked

150
6. Web Services User API

directCall
Requests for a VidyoPortal member to place a direct call to another VidyoPortal member as identified
by EntityID.
This method can use the following parameters:

Request Parameters

Name Type Description Required

entityID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal

Invite String This field could be used for dialing string to a Legacy No
Device or making a VidyoVoice call

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

getParticipants
Lists the participants in a VidyoPortal member's personal room. The entityID must be set to the
VidyoPortal member's entityID.
This method can use the following parameters:

151
6. Web Services User API

Request Parameter

Name Type Description Required

conferenceID EntityID An ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameters

Name Type Description Required

Total Integer Total number of the participants Yes

Array of Entity Array of entities (o…n) No

entities

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

GetUserName
Requests a real username as was created by the admin and saved in the DB.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameter

Name Type Description Required

152
6. Web Services User API

realUserName String Username as was created and saved in DB Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

leaveConference
Removes a participant (endpoint) from a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameters

Name Type Description Required

Total Integer Total number of the participants Yes

Array of entities Entity Array of entities (o…n) No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

153
6. Web Services User API

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

muteAudio
Mutes the audio for a given participant (endpoint) in the conference.
This method can use the following parameters:

Request Parameter

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

unmuteAudio
Unmutes the audio for a given participant (endpoint) in a conference.

154
6. Web Services User API

This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

startVideo
Starts the video for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

155
6. Web Services User API

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

stopVideo
Stops the video for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

participantID EntityID This is an ID for addressing a Member object in the Yes

VidyoPortal where the conference is started

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

156
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

myAccount
Retrieves a VidyoPortal member entity.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameter

Name Type Description Required

Entity Entity This object is returned as a result of search for member Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to renewed

157
6. Web Services User API

createRoomURL
Creates an URL for a room or VidyoPortal member's personal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

158
6. Web Services User API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

createRoomPIN
Creates a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

PIN String PIN string Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

159
6. Web Services User API

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

getPINLengthRange
Provides the minimum and maximum number of digits required in a user-provided PIN.
This method can use the following parameters:

Request Parameter

Name Type Description Required

None

Response Parameters

Name Type Description Required

minimumPINLength Integer The minimum digits for PIN length Yes

maximumPINLength Integer The maximum digits for PIN length Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

removeRoomPIN
Removes a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:

160
6. Web Services User API

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

161
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

updatePassword
Updates a VidyoPortal member's password.
This method can use the following parameters:

Request Parameter

Name Type Description Required

password String New password string Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

162
6. Web Services User API

updateLanguage
Updates a VidyoPortal member's language settings.
This method can use the following parameters:

Request Parameter

Name Type Description Required

language String Language supported by VidyoPortal Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

DeleteRoom
Removes a VidyoPortal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is the ID of addressing room object in the VidyoPortal Yes

163
6. Web Services User API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

createRoom
Creates a Public Room that belongs to the member.

164
6. Web Services User API

This method can use the following parameters:

Request Parameters

Name Type Description Required

name String Name of the room Yes

extension String Room extension Yes

Response Parameter

Name Type Description Required

Entity object Entity Object Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were

wrong

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

lockRoom
Locks a public or personal room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

165
6. Web Services User API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

unlockRoom
Unlocks a public or personal room.
This method can use the following parameters:

166
6. Web Services User API

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

createModeratorPIN
Creates a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

PIN String Specifies the Moderator PIN - used for creating and Yes
updating an existing PIN

167
6. Web Services User API

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occcurred

InvalidArgumentFault The arguments that were passed into services were wrong

InvalidModeratorPINFormatFault The format of the Moderator PIN is not valid - either not right
amount of digits, or invalid characters (PIN should be a 3-10
digit number)

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

removeModeratorPIN
Removes a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

PIN String Specifies the Moderator PIN - used for creating and Yes
updating an existing PIN

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

168
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ControlMeetingFault The user is not allowed to control the conference (only for User API)

GetRoomProfile
Gets a profile for a room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID Unique room identifier Yes

Response Parameter

Name Type Description Required

roomProfile RoomProfile Specifies the room profile Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SetRoomProfile
Sets a profile for a room.

169
6. Web Services User API

This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID Unique room identifier Yes

roomProfileName String Specifies the auto mute configuration selection Yes

profiles. The new profiles are:
 'VideoOnly' - will locally auto mute audio only
 'AudioOnly' - will locally auto mute video only
 'NoAudioAndVideo' - will auto mute both audio
and video.

Response Parameter

Name Type Description Required

OK String Indicates that the configuration has been setup Yes

successfully

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

RemoveRoomProfile
Removes a profile from a specified room ID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

170
6. Web Services User API

roomID EntityID Unique room identifier Yes

Response Parameter

Name Type Description Required

OK String Indicates that the configuration has been setup successfully Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

GetRoomProfiles
Gets a profile for rooms.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID Unique room identifier Yes

Response Parameters

Name Type Description Required

total Integer Total number of profiles that are available Yes

roomProfile RoomProfile Specifies the room profile Yes

171
6. Web Services User API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SetMemberMode
Gets the available Location Tags based on different criteria.

172
6. Web Services User API

This method can use the following parameters:

Request Parameters

Name Type Description Required

filter.<nnnn> The filter type is used to trim down (filter) the search Yes
results. The value <nnnn> could be any of or all of the
variables below.

start Integer This is the beginning index of the search result. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the start=30 value.

limit Integer This is the number of results that are being requested. No

Example: If the result has 50 elements, and the requestor

only wants 10 element from the 30th position, then the
requestor provides the limit=10 value.

sortBy String This is the field by which the requestor is asking the results No
to be sorted by.
member
name
Note In the User API, entityID is used instead of memberID
extension
Example: If the result has to be sorted in an ascending order
by the extension number of the Entity, then the requestor
provides the sortBy=extension/name/displayName or
memeberID value.

dir String This is the field by which the requestor is asking the results No
to be sorted in a specific direction/order, ascending or
ASC
descending.
DESC
Example: If the result has to be sorted in an ascending order
by the extension number of the Entity, then the requestor
provides the dir=ASC value.

query String: This is the search string that uses all the above filter criteria. No
name
Example: If the requestor is looking for all members that
display
start with the letters “pau,” then query=pau would return
Name
the desired results

173
6. Web Services User API

Name Type Description Required

extension

174
6. Web Services User API

Response Parameters

Name Type Description Required

total Integer Total number of entities Yes

locationTag String Location tag name Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

GetEntityByEntityID
Gets an Entity Object given the member's EntityID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

entityID EntityID Member's EntityID Yes

Response Parameters

Name Type Description Required

total Integer Total number of profiles that are available Yes

Entity Entity Entity Object Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

175
6. Web Services User API

Name Description

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

getEntityDetailsByEntityID
Gets an expanded list of entity details, including the new user data such as phone numbers, title,
department, location, and the base64 encoded binary of the user’s thumbnail photo.
This method can use the following parameters:

Request Parameter

Name Type Description Required

EntityID EntityID List of EntityIDs Yes

Response Parameters

Name Type Description Required

total int The total number of results Yes

EntityDetails EntityDetails List of EntityDetails objects: No

 entityID (EntityID)
 participantID (EntityID)
 EntityType
 ownerID (EntityID)
 displayName (string)
 extension (string)
 emailAddress (string)
 tenant (string)

176
6. Web Services User API

Name Type Description Required

 description (string)
 Language
 MemberStatus
 MemberMode
 canCallDirect (boolean)
 canJoinMeeting (boolean)
 canRecordMeeting (boolean)
 isInMyContacts (boolean)
 RoomStatus
 RoomMode
 canControl (boolean)
 audio (boolean)
 video (boolean)
 appshare (boolean)
 phone1 (string)
 phone2 (string)
 phone3 (string)
 department (string)
 title (string)
 instantMessagerID (string)
 location (string)
 thumbnailUpdateTime (dateTime)
 thumbnailPhoto (base64Binary)

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

177
6. Web Services User API

Name Description

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

GetEntityByRoomKey
Gets an entity by the roomKey provided in the room or guest URL.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomKey String Room key string (retrieved from room url) Yes

Response Parameter

Name Type Description Required

Entity Entity Entity Object Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

178
6. Web Services User API

setThumbnailPhoto
Allows users to upload their own thumbnail photo. The system supports .png, .jpg, and .jpeg file types.
Error messages are returned if the user attempts to upload an unsupported file type, the file is larger
than the file size limit set by the Super Admin, or the user is restricted from uploading thumbnail
photos by the Super Admin. The thumbnail photo must be provided as a base64 encoded binary.

Request Parameter

Name Type Description Required

thumbNailPhoto Base64Binary Base64 encoded .png, .jpg, or .jpeg Yes

image

Response Parameter

Name Type Description Required

OK String Indicates that the photo has been Yes

uploaded successfully

Faults

Name Description

NotLicensedException API is not licensed

NotAllowedThumbnailPhoto Image upload has been disabled by the Admin

Fault

FileTooLargeFault The uploaded file is larger than the maximum configured by the
Super

SeatLicenseExpiredFault Seat license expired and needs to be renewed

InvalidArgumentFault The provided argument was invalid. The file may be of an

unsupportted format or incorrectly encoded.

GeneralFault An unspecified error occurred

GetInviteContent
Gets an invite content for an email message.

179
6. Web Services User API

This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room Yes

object in the VidyoPortal

Response Parameters

Name Type Description Required

content String Invite content string Yes

subject String Email invitation subject line string No

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException Not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired

Note The response might include the room PINs; however, those are masked from users other than the
room owner or the tenant admin.

GetPortalVersion
Gets the portal version.
This method can use the following parameters:

Request Parameter

Name Type Description Required

180
6. Web Services User API

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

portalVersion String Portal version Yes

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

NotLicensedException API is not licensed

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be updated

GetConferenceID
Requests the Conference ID of the conference room the user is associated with.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

conferenceID EntityID Conference ID to which the user is logged in to. The Yes
null value returns if the user is not in a conference.

181
6. Web Services User API

Faults

Name Description

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

generateAuthToken
Authenticates registered users and communicates with the VidyoPortal using a new token-based
authentication mechanism from Vidyo endpoints. The token is generated based on the EndpointID and
validity time. If the validity time is zero, the token is valid until the user logs out or the token is not used
for 90 days.

Note The endpoint must be bound to the user (i.e., link endpoint is assumed to have been done) prior
to using this method.

Valid EID:TOKEN can be used for any operation in the User service except for the following:
 change password
 generateAuthToken
The token should be set in the Authorization header for any User service invocations. Its format is
EID:TOKEN, and should be base64 encoded.
This method can use the following parameters:

Request Parameters

Name Type Description Required

validityTime String The time in seconds for the token to remain valid Yes

endpointid EndpointID The endpoint unique identifier Yes

Response Parameter

Name Type Description Required

authToken String Returned Token Yes

182
6. Web Services User API

Faults

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

getActiveSessions
Gets a count of all active authentication tokens for a given user.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

count Integer Conference ID to which the user is logged in to. If the Yes
user is not in a conference, the null value returns.

Fault

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

logoutAllOtherSessions
Logs out all sessions tokens for a given user.
This method can use the following parameters:

Request Parameter

Name Type Description Required

183
6. Web Services User API

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

Ok String Specify that the action was performed successfully Yes

Fault

Name Description

None

getOnetimeAccessUrl
Fetches the portal access URL with a one-time token.

Note Token validity period is five minutes. If a user creates a token but uses it after five minutes, the
VidyoPortal will return unauthorized (401).

The user making this call will be logged in the Audit Logs. The Audit Log will store the admin ID, IP
address, and member ID of the member who made this call.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header

Response Parameter

Name Type Description Required

url anyURL Portal access URL Yes

184
6. Web Services User API

Faults

Name Description

InvalidArgumentFault Invalid Argument Fault in case the conference ID doesn't exist

NotLicensed API is not licensed

GeneralFault An unspecified error occurred

PortalPrefix
Returns the VidyoPortal prefix as it is set up on the Super Admin page.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always empty) Use only the HTTP Authentication N/A

header

Response Parameter

Name Type Description

portalPrefix Integer Returns the VidyoPortal prefix. Returns Null if no VidyoPortal

prefix is set up

Fault

Name Description

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

PrefixNotConfiguredFault Error returned when the portal prefix is not configured

185
6. Web Services User API

createScheduledRoom
Creates an ad-hoc conference room. Allows for specifying between 1 and 400 unused days after which
the room will be garbage collected in the system. When specifying 0, the VidyoPortal currently auto-
selects 100 days by default. As part of the response, the user receives a unique room link or extension to
access this room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

recurring Integer Unused days after which the room will be Optional
garbage collected

setPIN Boolean The room will be generated with a PIN Optional

Response Parameters

Name Type Description

extension String The room’s unique ID

pin String The room’s randomly generated PIN

inviteContent String Content of the invite text (will include the room URL, PIN, and
extension)

roomURL String The room’s URL

inviteSubject String The email invitation subject

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

SeatLicenseExpiredFault Seat license expired and needs to be renewed

ScheduledRoomCreationFault Scheduled Room Creation Fault

186
6. Web Services User API

createPublicRoom
Allows users to create a public room by specifying the Display Name. Auto-generates the Room Name
and Extension, and enforces limitations on the number of public rooms that a User, Tenant, and Portal
can create.
This method can use the following parameters:

Request Parameters

Name Type Description Required

displayName string Public room display name Yes

inMyContacts boolean Indicates whether to add to contact list No

locked boolean Indicates whether room is locked No

setPIN string PIN for the public room No

description string Description of the public room No

Response Parameters

Name Type Description Required

roomID EntityID EntityID of the newly created public room Yes

extension string Extension of the public room Yes

roomURL anyURI URL for the public room Yes

inMyContacts boolean Indicates whether the public room is in contact No

list

locked boolean Indicates whether the public room is locked No

hasPIN boolean Indicates whether the public room has a PIN No

Faults

Name Description

NotLicensedFault API is not licensed

NotAllowedToCreateFault Not authorized to create public room

187
6. Web Services User API

Name Description

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

PublicRoomCreationFault Failed to create a public room

updatePublicRoomDescription
Enables end users to update the one room property that they are allowed to change.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID EntityID of the public room Yes

description string Description of the public room Yes

Response Parameter

Name Type Description Required

OK OK If successful, returns OK Yes

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

RoomNotFoundFault Room was not found

GeneralFault Unspecified error occurred

PublicRoomDescUpdation Update failed

Fault

188
6. Web Services User API

joinConference
Supports an option to report a reference number while joining a conference. This is done in order to
support customization of the reporting mechanism and allow customers to build applications that
report this field to the CDRs.
This method can use the following parameters:

Request Parameter
Additions to the existing request parameters:

Name Type Description Required

referenceNumber String The custom referenceNumber that Optional

the endpoint is reporting while
requesting to join

disconnectConferenceAll
Disconnects all participants from a specified conference room, including the conference moderator and
the person controlling the room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID If set to TRUE, the Scheduled Room Yes

information generated will have a PIN
associated with it

moderatorPIN String Specifies the moderator PIN to grant Optional

access to the action requested

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

189
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault Invalid Argument Fault or in case the conference ID doesn't exist

GeneralFault An unspecified error occurred

ControlMeetingFault Not authorized to perform this action

muteAudioServerAll
Mutes all participants in the specified conference, including the conference moderator and the person
controlling the room. Unmuting the participants must be performed by the conference moderator.
Participants are unable to unmute themselves.
While in this mode, new participants joining the conference are also muted.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID If set to TRUE, the Scheduled Room information Yes

generated will have a PIN associated with it

muteState Boolean Specifies whether the state should be mute or Yes

unmute:
Mute: '1' | True
Unmute: '0' | False

moderatorPIN String Specifies the moderator PIN to grant access to the No

action requested

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

190
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault Invalid Argument Fault or in case the conference ID doesn't exist

GeneralFault An unspecified error occurred

muteAudioClientAll
Silences all participants in the specified conference, including the conference moderator and the person
controlling the room. Participants are able to unmute themselves from their client user interfaces.
There is no 'unmuteAudioClientAll' equivalent given that users can unmute themselves locally.
While in this mode, new participants joining the conference are also silenced.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID If set to TRUE, the Scheduled Room Yes

information generated will have a PIN
associated with it

moderatorPIN String Specifies the moderator PIN to grant access No

to the action requested

Response Parameter

Name Type Description

Ok String Specifies that the action was performed successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault Invalid Argument Fault or in case the conference ID doesn't exist

191
6. Web Services User API

GeneralFault An unspecified error occurred

muteVideoServerAll
Puts all participants in the specified conference, including the conference moderator and the person
controlling the room, into privacy mode. The participants are not able to unmute their video by
themselves.
While in this mode, new participants joining the conference are also muted when the room profile is set
to the 'video mute' or 'video and audio mute' modes.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID If set to TRUE, the Scheduled Room Yes

information generated will have a PIN
associated with it

muteState Boolean Specifies whether the state should be mute Yes

or unmute:
Mute: '1' | True
Unmute: '0' | False

moderatorPIN String Specifies the moderator PIN to grant access No

to the action requested

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault Invalid Argument Fault or in case the conference ID doesn't exist

192
6. Web Services User API

GeneralFault An unspecified error occurred

muteVideoClientAll
Puts all participants in the specified conference, including the conference moderator and the person
controlling the room, into privacy mode. The participants are able to unmute their video by themselves
from their client user interfaces. There is no 'unmuteVideoClientAll' equivalent given where users can
unmute themselves locally.
While in this mode, new participants joining the conference are also muted when the room profile is set
to 'video mute' or 'video and audio mute' modes.
This method can use the following parameters:

193
6. Web Services User API

Request Parameters

Name Type Description Required

conferenceID EntityID If set to TRUE, the Scheduled Room Yes

information generated will have a PIN
associated with it

moderatorPIN String Specifies the moderator PIN to grant No

access to the action requested

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault Invalid Argument Fault or in case the conference ID doesn't exist

GeneralFault An unspecified error occurred

SilenceSpeaker
Silences the speaker of a specific participant.

Request Parameters

Name Type Description Required

conferenceID EntityID The EntityID of the conference. Yes

moderatorPIN String The moderator PIN for the Room No

controller

participantID Integer The participant ID whose speaker to Yes

silence.

194
6. Web Services User API

silenceState SilenceState The silence state as an integer value, Yes

0 or 1.

Response Parameters

Name Type Description Required

conferenceID EntityID The EntityID of the conference. Yes

participantID Integer The participant ID whose speaker No

was updated.

silenceState SilenceState The silence state as an integer value, Yes

0 or 1.

ModeratorPIN String The moderator PIN for the Room No

controller

Faults

Name Description

NotLicensedFault API is not licensed

InvalidConferenceFault Invalid conference ID

InvalidParticipantFault Participant ID is invalid

SilenceSpeakerServerAll
Silences all participants’ speakers.

Request Parameters

Name Type Description Required

conferenceID EntityID The EntityID of the conference. Yes

participantID int The participant ID element in the request No

will be ignored.

silenceState SilenceState The silence state as integer value, 0 or 1. Yes

moderatorPIN String The moderator PIN for the Room No

controller

195
6. Web Services User API

Response Parameters

Name Type Description Required

conferenceID EntityID The EntityID of the conference. Yes

participantID Integer The participant ID element will be No

ignored for processing, but will be
shown as entered in request.

silenceState SilenceState The silence state as integer value, 0 or Yes

1.

moderatorPIN String The moderator PIN for the Room No

controller

Fault Parameters

Name Description

NotLicensedFault API is not licensed

InvalidConferenceFault Invalid conference ID

createModeratorURL
Creates a moderator URL for the HTML Web-based control meeting. The user making the request must
be the room owner.
The generated moderator URL links to the room's HTML Web-based control meeting page and may be
opened from any platform (desktop, mobile, etc.).
Accessing the URL:
 Requires a moderator PIN when opened from the moderator URL.
 Does not require a moderator PIN when opened from within a Vidyo client linking to this page and
the room owner is already logged in to the system.
If the moderator URL is invalid, accessing the Web page results in an access error.
This method can use the following parameters:

Request Parameter

Name Type Description Required

196
6. Web Services User API

roomID EntityID This is an ID for addressing the room Yes

object in the VidyoPortal

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

Faults

Name Description

GeneralFault An unspecified error occurred

rooIDFault The specified room ID is invalid

removeModeratorURL
Removes a specific moderator URL for the HTML Web-based control meeting for a given room by the
room owner only.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room Yes

object in the VidyoPortal

Response Parameter

Name Type Description

Ok String Indicates that the action was performed successfully

Faults

Name Description

197
6. Web Services User API

GeneralFault An unspecified error occurred

rooIDFault The specified room ID is invalid

getModeratorURL
Gets the moderator URL for the HTML Web-based control meeting for a given room by the room owner
only.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room Yes

object in the VidyoPortal

Response Parameters

Name Type Description

moderatorURL String The control meeting moderator URL

hasModeratorPIN Boolean Indicates whether there is a PIN or not

Faults

Name Description

GeneralFault An unspecified error occurred

rooIDFault The specified room ID is invalid

getModeratorURLWithToken
Gets the moderator URL for the HTML Web-based control meeting for a given room with a one-time
token. The web page will request a moderator PIN if the user is not the owner of the room, an operator,
or the administrator. The user must be on the same tenant as the room.
This method can use the following parameters:

198
6. Web Services User API

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing Yes

the room object in the
VidyoPortal

Response Parameter

Name Type Description

moderatorURL String The control meeting moderator URL

Faults

Name Description

GeneralFault An unspecified error occurred

roomIDFault The specified room ID is invalid

cancelOutboundCall
Enables the moderator to cancel an outgoing user invite request.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Specifies the conference ID which Yes

the moderator is logged in to

entityID EntityID Indicates that the user that has Yes

been invited. User cannot invite an
entity that is of type Legacy

moderatorPIN String Specifies the moderator PIN Optional

199
6. Web Services User API

Response Parameter

Name Type Description

Ok String Indicates that the cancelation has been successful

200
6. Web Services User API

Faults

Name Description

InvalidArgumentFault Invalid Argument Fault or in case that the conferenceID or entityID

doesn't exist

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

SeatLicenseExpireFault Seat license expired

getPortalFeatures
Queries whether the following features are available on the VidyoPortal and, if available, whether the
feature is enabled or disabled on the Super Admin level.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

201
6. Web Services User API

Response Parameters

Name Type Description

PortalFeature PortalFeature The following object provides the list of available features that
the VidyoPortal is supporting: Scheduled Room, Guest login,
IPC inbound call, IPC outbound call, HTML control meeting,
etc.
Change to this version:
 Adding 'EndpointPrivateChat' parameter to indicate
whether private chat is enabled on Vidyo endpoints
 Adding 'EndpointPublicChat' parameter to indicate
whether public chat is enabled on Vidyo endpoints
 Adding ‘16TILES’ to indicate whether the 16 tiles layout is
enabled on VidyoDesktop
 Adding ‘HTMLChangePswd’ to indicate that this
VidyoPortal supports an HTML based page for password
changing
 Adding ‘RouterParticipantInformation’ to indicate that this
VidyoPortal supports participant information delivered by
the VidyoRouter
Each of these parameters can get the values of True or False.
For earlier VidyoPortals on which this feature is not available,
this value will not show up when querying this service.

LoginBanner Boolean Indicates whether the Login Banner feature is supported by

the VidyoPortal

WelcomeBanner Boolean Indicates whether the Welcome Banner feature is supported

by the VidyoPortal

CDR2_1 Boolean Indicates whether the CDR scheme on the VidyoPortal is from
version 2.1

ScheduledRoom Boolean Indicates whether the VidyoPortal supports Scheduled Rooms

Faults

Name Description

NotLicensedFault API is not licensed

202
6. Web Services User API

GeneralFault An unspecified error occurred

getUserAccountType
This method can use the following parameters:

Response Parameter
Additions to the existing response parameter:

Name Type Description

userAccountType String The account type of the logged in user. The following are the
possible user account types that the portal can return:
Should add as Response parameters in the Table
 Admin
 Operator
 Normal
 VidyoRoom
 Executive
 VidyoPanorama

getLoginAndWelcomeBanner
Indicates to the endpoint whether a login, click-through banner is required when the user first logs in to
the portal and provides the login and welcome info which is set up on the tenant to be displayed on the
endpoint.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always empty) Use only the HTTP Authentication header N/A

203
6. Web Services User API

Response Parameters

Name Type Description Required

loginBannerText String Welcome text that appears after the client No

logs in

welcomeBannerContent Complex WelcomeBannerContent for a text-based No

Type message to be used on the endpoints upon
successful login with the last 5 login
attempts (successful and unsuccessful) for
that particular user:
welcomeBannerText: Welcome screen title
text (example: Welcome to
VidyoConferencing.)
For each login attempt:
result: login result (example: SUCCESS,
FAILURE: ACCOUNT LOCKED)
source address: IP address (example:
172.16.7.206)
time: time of the login attempt (format is
based on the location of the server)
welcomeBannerPasswordExpiryDate: the
date of the password expiration (example:
12/27/2013 13:35:50 PM)
Parameter will not show up in the response
when password expiration is disabled.
*In case one of the features is disabled, its
information will not be returned in the
response.

startLectureMode
Starts Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints
will go into Presenter mode.
This method can use the following parameters:

Request Parameters

Name Type Description Required

204
6. Web Services User API

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

moderatorPIN String Moderator PIN No

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

stopLectureMode
Stops Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints
will exit Presenter mode.

205
6. Web Services User API

This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

moderatorPIN String Moderator PIN No

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

GetLectureModeParticipants
Requests to list the participants in a meeting as identified by EntityId (which is similar to
GetParticipants but supports Presenter mode instead). To list the participants in a personal room
belonging to a Member, the EntityID must be set to the Member.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

206
6. Web Services User API

Name Type Description Required

Filter <nnnn> The filter type is used to trim down (filter) the
search results. The value <nnnn> could be any of
or all of the variables below.

moderatorPIN String Moderator PIN No

Response Parameters

Name Type Description

total Integer Number of participants

recorderID Integer Recorder ID of the recorder active in the conference

recorderName String Recorder name

paused Boolean Recording status

webcast Boolean Is webcast enabled for the conference

lectureMode Boolean Is Lecture Mode on for this conference

Lecture mode LectureModeParticipant List of the participants

participants

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

LectureModeParticipant is an object with the following parameters:

Name Type Description

entityID EntityID Entity ID

participantID EntityID Participant ID

207
6. Web Services User API

Name Type Description

displayName String Display name

extension String Extension

audio Boolean Indicates whether the audio is muted

video Boolean Indicates whether the video is muted

appshare Boolean Indicates whether there is a content share

handRaised Boolean Indicates whether a hand is raised

presenter Boolean Indicates whether the participant is presenting

RaiseHand
Signals the VidyoPortal about a raise hand request made during Presenter mode (a.k.a., Lecture mode)
from a participant.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Use only the HTTP Authentication header N/A

Empty)

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

208
6. Web Services User API

UnraiseHand
Signals the VidyoPortal about an unraise hand request made during Presenter mode (a.k.a., Lecture
mode) from a participant who had previously raised their hand.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

DismissRaisedHand
Signals the dismissal of a hand from the moderator to the endpoint that had previously raised a hand.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

209
6. Web Services User API

Name Type Description Required

participantID EntityID Participant ID of the participant who had raised Yes

hand that the moderator wishes to dismiss

moderatorPIN String Moderator PIN No

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

DismissAllRaisedHand
Dismisses all raised hands from the moderator.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

moderatorPIN String Moderator PIN No

210
6. Web Services User API

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

SetPresenter
Assigns a presenter to the conference during Presenter mode (a.k.a., Lecture mode).
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

participantID EntityID Participant ID of the participant who will be the Yes

presenter.

moderatorPIN String Moderator PIN No

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

211
6. Web Services User API

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

RemovePresenter
Removes a given participantID (endpoint) as the presenter when a conference is in Presenter mode.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID Conference ID of the conference where the Yes

presentation is being held

participantID EntityID Participant ID of the participant who had raised Yes

hand that the moderator wishes to dismiss

moderatorPIN String Moderator PIN No

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

Faults

Name Description

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

212
6. Web Services User API

Name Description

GeneralFault An unspecified error occurred

ControlMeetingFault The user is not allowed to control the conference (only for User
API)

SetEndpointDetails
Enables endpoints to report their capabilities to the VidyoPortal during the authentication process. The
endpoints must report their capabilities in order to be given permission for some of the system level
features such as Presenter Mode. Vidyo endpoints gain new capabilities as features are added to newer
versions.
This method can use the following parameters:

Request Parameters

Name Type Description Required

EID String Endpoint ID Yes

EndpointFeature Endpoint List of features supported by the endpoint and Optional

Feature indicates whether those are enabled or not

applicationName String Vidyo application name (for example, Optional

VidyoDesktop, VidyoMobile, etc.)

applicationVersion String Application version (for example, VidyoDesktop, Optional

VidyoMobile, etc.)

applicationOs String OS on which the Vidyo application is running (for Optional

example, Windows)

deviceModel String Device model on which the application is running Optional

(for example, iPhone 5S)

Response Parameter

Name Type Description

OK String Acknowledges that the request has been received successfully

213
6. Web Services User API

Faults

Name Description

EndpointNotBoundFault Endpoint Not Bound Fault

NotLicensedFault API is not licensed

InvalidArgumentFault The arguments that were passed into services were wrong

GeneralFault An unspecified error occurred

WhatIsMyIPAddress
Requests the VidyoPortal to send the endpoint’s public IP address. This information is also reflected in
the CDR table.
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

Response Parameter

Name Type Description

endpointExternalIPAddress String Returns the EP's external IP address or “Unknown” if the IP

address in unknown

Faults

Name Description

GeneralFault An unspecified error occurred

NotLicensedFault API is not licensed

214
 7. Web Services License API
This chapter describes the Web Services License API.
VidyoPortal License Service URL:
http://VIDYOPORTAL/services/VidyoPortalLicenseService?wsdl

getClientVersion
Returns the version of the active client endpoint uploaded for a Tenant, which may be a CDN URL or
VidyoPortal URL. There can be multiple versions uploaded but only one version can be active for a given
client type. If there is no active client, the response parameters come back empty.
This method can use the following parameters:

Request Parameters

Name Type Description Required

ClientType String Specifies the type of client being requested: Yes

 Type 'W' is for Windows platform
 Type 'M' is for Mac OS platform
 Type 'V' is for VidyoRoom HD-200 (Windows
platform)
 Type 'R' is for VidyoRoom HD-100/HD-50
(Windows platform)
 Type 'L' is for Linux platform
 Type 'S' is for SL5 platform
 Type 'U' is for Ubuntu platform
 Type 'T' is for SL5 64-bit platform
 Type 'X' is for Ubuntu 64-bit platform
 Type 'P' is for VidyoPanorama 600
 Type 'N' is for VidyoPanorama 600 running
Windows 64-bit
 Type 'O' is for VidyoPanorama 600 running Linux

215
7. Web Services License API

Name Type Description Required

 Type 'Q' is for VidyoRoom running Windows 32-
bit
 Type 'Y' is for VidyoRoom running Windows 64-bit
 Type 'Z' is for VidyoRoom running Linux

Response Parameters

Name Type Description Required

CurrentTag String Specifies the tag of the endpoint version Yes

InstallerURL String Specifies the CDN or VidyoPortal URL where the Yes
endpoint can be downloaded from

216
7. Web Services License API

Faults

Name Description

InvalidArgumentFault Invalid Argument Fault or in case that the conferenceID or entityID

doesn't exist

GeneralFault An unspecified error occurred

217
 8. User Status Notification
User Status Notification is a blocking server, and a valid and responsive SOAP server must be
configured. The VidyoPortal can send User Status Notifications to external entities using the SOAP
interface. Every time the status of a User on the VidyoPortal changes (for example from Offline to
Online) the VidyoPortal sends a notification message using the pre-configured SOAP interface. It is an
application’s responsibility to determine how the user status information received via the SOAP
interface will be processed. One of the possible use cases for this mechanism is providing the User
Status information to Presence servers.

User Status Notification Service Overview

The User Notification web service should be exposed via the SOAP interface.
It is described in the UserStatusNotificationService.wsdl file.
The WSDL file defines the operation called notifyUserStatus() which receives the User Status
Notification structure as a parameter.

Request Parameters

Name Type Description Required

UserName String The user name of a user logged into the VidyoPortal. Yes

Tenant String The name of the tenant the user is logged into. If a Yes
VidyoPortal has only one tenant, this string is always
Default.

218
8. User Status Notification

Name Type Description Required

UserStatus Array of Describes the member status based on the operation Yes
Strings state of the endpoint in use by the member:
 Status is Offline: Can't be reached for a conference.
 Status is Online: Can be reached for a conference or
a direct call.
 Status is Busy: In a conference and can't be reached
for another conference or a direct call.
 Status is BusyInOwnRoom: In a conference in own
personal room and can't be reached for another
conference.
 Status is Ringing: The endpoint associated with the
member has started to ring upon receiving either a
direct call or an invite event from another
participant.
 Status is RingAccepted: The endpoint associated
with the member accepted the call from another
participant.
 Status is RingRejected: The endpoint associated
with the member rejected the call from another
participant.
 Status is RingNoAnswer: The endpoint associated
with the member has not answered within the
allotted period of time.
 Status is Alerting: The endpoint associated with the
member is being alerted about the incoming call.
 Status is AlertCancelled: The endpoint associated
with the member is no longer being alerted about
the incoming call.

The VidyoPortal can be configured to send User Status Notifications in the format described above to a
SOAP Server.

Note The User Status Notification is a blocking server and could be a point of failure; therefore, once it
is configured, you must ensure that the service is available at all times.

219
8. User Status Notification

Configuring User Status Notification

To configure User Status Notification:
1. Log in to the Super Admin portal using your Super Admin account.
For more information, refer to “Logging in to the Super Admin Portal” in the VidyoConferencing
Administrator Guide.
2. Navigate to Settings > Maintenance > Status Notify.
3. Select the Enable checkbox.
4. Provide the URL of the SOAP server.
For example: http://[SOAP Server IP]/[notif_server.php], where
[notif_server.php] is the PHP SOAP server that will handle the SOAP request from the
VidyoPortal,
[SOAP Server IP] should be a web reachable address.
5. Enter the User Name and Password.
If the SOAP server is using authentication, then provide the User Name and Password.
6. Click Save.

220
 9. Status Notification Service
The Status Notification Service is an updated form of the User Status Notifications (described in
Chapter 8) with some significant differences as follows:
• Status Notifications are sent in REST/JSON format
• Status Notifications can be configured per-tenant
The VidyoPortal can send Status Notifications to external entities using this interface. Every time the
status of a user on the tenant changes (for example, logging in or joining and leaving a conference), the
VidyoPortal sends a notification message with the various parameters for each action. The application
is responsible for determining how the notification message is processed.

Status Notification Service Data

Here is an example of a Status Notification message:

{
"version" : 1 ,
"sequenceNum" : 1118325485454984,
"creationTimestamp" : 1118335848153124,
"queueTimestamp" : 1118335883785924,
"userStatusNotification" : {

"user": {
"userName" : "kram",
"displayName" : "Krishnan Ram",
"memberID" : "2727",
"userState" : "Busy",
"tenantName" : "Default",
"accessType" : "U",
"extension" : "129"
},

"room": {
"roomID" : 20,
"roomName" : "Krishnan_Room",
"roomDisplayName" : "Krishnan Room",
"roomType" : "S",
"roomOwner" : "kram",
"roomExtension" : "39393",
"roomKey" : "U89HedUqbG"
},

221
9. Status Notification Service

"conference": {
"uniqueCallID" : "1118335449862253",
"callState" : "IN PROGRESS",
"tenantName" : "Default",
"conferenceName" : "[email protected]",
"conferenceType" : "C",
"conferenceID" : "123213123",
"participantId" : 3243,
"routerID" : "5821N55FG1CY549R8F9JBZWJGEYJQ49H4NQWBMYA83Q6
800VR0001",
"callCompletionCode" : "0",
"direction" : "O",
"audioState" : 1,
"videoState" : 1
},

"endpoint": {
"endpointType" : "D",
"endpointPublicIPAddress" : "172.16.41.92",
"endpointGUID" : "A0CEC81E9A03-3898779616",
"endpointId" : "9616"
},

"endpointDetails" : {
"applicationName" : "VidyoConnect Desktop",
"applicationVersion" : "19.1.0.9085",
"applicationOs" : "Win 10",
"deviceModel" : "Dell Inc. - Precision 7530",
"referenceNumber" : ""
},

"gateway": {
"gwid" : null,
"gwprefix" : null
},

"contextAwareLinking" : {
"conferenceId" : "434675",
"externalId" : "1542355",
"externalIdType" : 1,
"connectionStatus" : 1
}

222
9. Status Notification Service

The Status Notification message format is described in the tables below.

Root Object

Key Value

version 1

sequenceNum Unique numeric sequence number of status notification message

creationTimestamp Java timestamp of creation of status notification message

queueTimestamp Java timestamp of when status notification message leaves queue

user Object

Key Value

userName Caller identifier (Login name of the caller)

For Legacy calls, this is the extension number used

displayName Display name of the caller or name of the legacy device

memberId Member (entityID of user)

userState Describes the member status based on the operation state of the endpoint
in use by the member:
 Status is Offline: Can't be reached for a conference.
 Status is Online: Can be reached for a conference or a direct call.
 Status is Busy: In a conference and can't can be reached for another
conference or a direct call.
 Status is BusyInOwnRoom: In a conference in own personal room and
can't can be reached for another conference.
 Status is Ringing: The endpoint associated with the member has
started to ring upon receiving either a direct call or an invite event from
another participant.

223
9. Status Notification Service

 Status is RingAccepted: The endpoint associated with the member

accepted the call from another participant.
 Status is RingRejected: The endpoint associated with the member
rejected the call from another participant.
 Status is RingNoAnswer: The endpoint associated with the member
has not answered within the allotted period of time.
 Status is Alerting: The endpoint associated with the member is being
alerted about the incoming call.
 Status is AlertCancelled: The endpoint associated with the member is
no longer being alerted about the incoming call.

tenantName Name of the tenant that user is associated with

accessType U - Registered User

G - Guest
L - Call to Legacy via VidyoGateway
R - Call recorded via VidyoReplay and Recorder (if applicable)

extension Extension of the user joining the conference

Room Object – Optional

Key Value

roomId Room ID

roomName Room name

roomDisplayName Room display name

roomType M - Private room belonging to a registered member on the VidyoPortal

P - Public room

S - Scheduled room

roomOwner The logged in username of the room owner

roomExtension Extension of room

roomKey Room key

224
9. Status Notification Service

225
9. Status Notification Service

conference Object – Optional

Key Value Notes

uniqueCallId A newly-created conference receives a new, unique N/A

call ID so the customer can track all conference
participants.

For example, a conference "green" starting at 10 AM

and ending at 11 AM has a different unique call ID
from a conference "green" starting at 3 PM and
ending at 4 PM.

callState Current state of the call: N/A

RINGING - The status of the side initiating the call

(P2P or conference)

RING ACCEPTED - This status indicates to the

initiating side that the callee has accepted the call. It
will switch to "in progress" once the conference
begins

RING REJECTED - This status indicates to the

initiating side that the alert was not accepted

RING NO ANSWER - This status indicates to the

initiating side that the call timed out

RING CANCELLED - This status indicates to the

initiating side that the call was aborted from the
initiating side

ALERTING - This status indicates to the callee side

that there is an incoming call (P2P or conference)

ALERT CANCELLED - This status indicates to the

callee side that the initiating side cancelled the call

IN PROGRESS - This status indicates to both sides

that the call is in progress

COMPLETED - This status indicates to both sides

that the call was completed

tenantName Name of the tenant N/A

conferenceName Name of the conference - roomName@tenantURL Same as CDR

conferenceType D - Direct Call (two party) Same as CDR

226
9. Status Notification Service

C - Conference Call

ID - Inter-portal Direct Call

IC - Inter-portal Conference Call

conferenceId Conference ID from conferences table Internal

conference ID

participantID Participant ID of the user joining a conference N/A

routerId VidyoRouter used for this call Same as CDR

callCompletionCode This field provides one of the following call Same as CDR
completion codes:

0 - The call completion reason is not available

1 - The user disconnected the call

2 - The call was disconnected by the admin,

operator, or room owner

3 - The call was disconnected due to a network

failure on the VidyoManager

direction I - Inbound Call Same as CDR

O - Outbound Call

audioState Moderator audio state of room (0 or 1) N/A

videoState Moderator video state of room (0 or 1) N/A

endpoint Object – Optional

Key Value Notes

endpointType R - VidyoRoom Same as CDR

D - VidyoDesktop

G - Guest

L - Call to Legacy via VidyoGateway

C - Call Recorded via VidyoReplay and

Recorder (if applicable)

227
9. Status Notification Service

endpointPublicIPAddress This field identifies the IP address of an Same as CDR

endpoint that has joined a conference (from
the perspective of the VidyoPortal).

endpointGUID Unique Endpoint ID Same as CDR

endpointID Endpoint ID of user N/A

endpointDetails Object – Optional

Key Value Notes

applicationName This field identifies VidyoConference usage from Same as CDR

different endpoint types. The information is
reported by endpoints when connecting to the
VidyoPortal

Usage is reported from the following endpoint

types:

 VidyoWeb
 VidyoMobile
 VidyoSlate
 Lync Plug-in
 Jabber Plug-in
 Bott client
 VidyoMonitoring App
 VidyoDesktop
 VidyoRoom
 VidyoGW
 VidyoReplay
 VDI

applicationVersion This field identifies the endpoint software version Same as CDR

applicationOs This field identifies the operating system on Same as CDR

which a Vidyo client is running. All VidyoClients
(and Client lib based apps) are required to provide
this information if requested. The following
operating systems are supported:

228
9. Status Notification Service

 Windows XP
 Windows7
 Windows8
 Mac OS
 Linux
 iOS
 Android
deviceModel This field identifies the endpoint device model Same as CDR

referenceNumber This is a numeric string identifier passed by the Same as CDR

endpoint to the VidyoPortal at conference join
time. This field is a placeholder for Client lib based
apps implementation

gateway Object – Optional

Key Value Notes

gwId Gateway ID used for this call. Same as CDR

gwPrefix Service prefix used. This applies only to calls that Same as CDR
involve a VidyoGateway or VidyoRecorder. For
other calls, it is set to NULL.

contextAwareLinking – Optional

Key Value Notes

conferenceId Video Visit Conference ID (Encounter From extData in CAL

CSN)

externalId ID for the user (EMP ID, Provider or WPR From extData in CAL
ID, Patient)

externalIdType type of user ID being passed in (1- From extData in CAL

EMP,Provider or 2-WPR,Patient)

connectionStatus Status to set for the external user (1- From extData in CAL
Connect, 2-Disconnect)

229
9. Status Notification Service

Configuring the Status Notification Service

To enable the Status Notification Service for your Tenant Admins:
1. Log in to the Super Admin portal using your Super Admin account.
For more information, refer to “Logging in to the Super Admin Portal” in the VidyoConferencing
Administrator Guide.
2. Navigate to Settings > Feature Settings > Status Notification Service.
3. Select the Allow Tenant Admin to configure Status Notification Service checkbox.

4. Click Save.

To enable the Status Notification Service for your Tenant:

1. Log in to the Tenant Admin portal using your Tenant Admin account.
For more information, refer to “Logging in to the Tenant Admin Portal” in the
VidyoConferencing Administrator Guide.
2. Navigate to Settings > Feature Settings > Status Notification Service.

230
9. Status Notification Service

3. Select the Enable Status Notification Service checkbox.

New fields display.

4. In the Server URL field, enter the URL of the notification server.
This should be a web reachable address. If your notification service is HTTPS-enabled,
remember to use the https:// prefix and also verify that your VidyoPortal has the appropriate
Certificate Authorities uploaded.
5. Enter the User Name and Password.
6. Click Connection test to send a test notification to the notification server.
7. If the connection test passes, click Save.

231
 10. Authentication Using Web Services
The VidyoPortal can delegate user authentication to the external entities using the SOAP interface.
Every time VidyoPortal receives a user name and password during a login procedure the VidyoPortal
sends a SOAP message with user credentials to an external web service using the pre-configured Web
Service interface. It is the web service’s responsibility to return the authentication response to the
VidyoPortal. Based on the response (passed authentication or failed authentication) the VidyoPortal
successfully completes or fails the login procedure.

Authentication Service Overview

The authentication web service is exposed via the SOAP interface. It’s defined in the
AuthenticationService.wsdl file.

Request Parameters

Name Type Description Required

username String User name Yes

password String password Yes

Response Parameter

Name Type Description Required

passed Boolean true or false Yes

Configuring the Authentication Server

1. Log in to the Admin portal using your Admin account.
For more information, refer to “Logging in as a Tenant Admin” in the VidyoConferencing
Administrator Guide.
2. Navigate to Settings > Authentication.
3. Select Web Service from the Authentication Type drop-down.
4. Provide the URL of the SOAP Server.

232
10. Authentication Using Web Services

For example: http://[SOAP Server IP]/[auth_server.php], where

[auth_server.php] is the PHP SOAP server that will handle the SOAP request from the
VidyoPortal,
[SOAP Server IP] should be a web reachable address.
5. Enter the User Name and Password.
If the SOAP server is using authentication, then provide the User Name and Password.
6. Click Save.

233
 11. VidyoReplay API
This chapter describes the VidyoReplay API functionality for the User and Admin API. The VidyoReplay
API enables playing and recording of the video stream during the conference. The content
management part enables accessing, deleting, renaming and changing the record contents.
VidyoReplay Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalUserService?wsdl
http://VIDYOPORTAL/services/v1_1/VidyoPortalAdminService?wsdl
VidyoReplay Content Management Service URL:
http://VIDYOPORTAL/replay/services/VidyoReplayContentManagementService?wsdl

GetRecordingProfiles
Provides the available recording profile. The recorder prefix defines the file format of the recording
(CIF, CD, HD).
This method can use the following parameters:

Request Parameter

Name Type Description Required

(Always Empty) Use only the HTTP Authentication header N/A

234
11. VidyoReplay API

Response Parameters

Name Type Description Required

total Integer Total number of profiles Yes

recorderPrefix String Prefix ID Yes

description String Prefix Description No

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault Seat license expired and needs to be renewed

startRecording
Starts the recording for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

recorderPrefix String A string representing the recording prefix Yes

webcast Boolean Start recording the webcast Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

235
11. VidyoReplay API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

ResourceNotAvailableFault Resource Not Available Fault

SeatLicenseFault For service use only

StopRecording
Stops the recording for a given participant (endpoint) in a conference.
This method can use the following parameters:

236
11. VidyoReplay API

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

recorderID String A string representing the recording prefix. The Yes

GetPArticipantsResponse() will provide recorderID
associated with this conference.

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not Licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

SeatLicenseFault For service use only

PauseRecording
Pauses the recording for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

237
11. VidyoReplay API

recorderID String A string representing the recording prefix Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

ResumeRecording
Resumes the recording for a given participant (endpoint) in a conference.
This method can use the following parameters:

Request Parameters

Name Type Description Required

conferenceID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal where the conference is started

recorderID String A string representing the recording prefix Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

238
11. VidyoReplay API

Faults

Name Description

NotLicensedFault API is not Licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

createWebcastURL
Creates a URL for a Webcast.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

239
11. VidyoReplay API

removeWebcastURL
Removes a URL for a Webcast.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in the Yes
VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

GetWebcastURL
Gets the Webcast URL and PIN indicator for a room.
This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object Yes

in the VidyoPortal

240
11. VidyoReplay API

Response Parameters

Name Type Description Required

webCastURL String Webcast URL Yes

hasWebCastPIN Boolean If room has a pin Yes

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were

wrong

SeatLicenseExpiredFault For service use only

createWebcastPin
Creates a PIN for a Webcast.
This method can use the following parameters:

Request Parameters

Name Type Description Required

roomID EntityID This is an ID for addressing the room object Yes

in the VidyoPortal

pin String Webcast Pin Yes

Response Parameter

Name Type Description Required

OK String String representation of successful Yes

operation

241
11. VidyoReplay API

Faults

Name Description

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were

wrong

SeatLicenseExpiredFault For service use only

removeWebcastPin
Removes a PIN for a Webcast.

242
11. VidyoReplay API

This method can use the following parameters:

Request Parameter

Name Type Description Required

roomID EntityID This is an ID for addressing the room object in Yes

the VidyoPortal

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

Faults

Name Description

NotLicensedFault API is not Licensed

GeneralFault An unspecified error occurred

InvalidArgumentFault The arguments that were passed into services were wrong

SeatLicenseExpiredFault For service use only

RecordsSearch
Provides records based on different criteria plus access levels. It can be used for output records paging
via offset and limit parameters in a conjunction with a previous
GetRecordsSearchCountRequest element. The userName is detected based on the user name
logged in and the current tenant. tenantName is optional and can be used only by a Super Admin
only. The default sorting criteria are by date descending. Output is limited to 200 records. The sortBy
valid values are date, (the default) title and room.
This method can use the following parameters:

Request Parameters

Name Type Description Required

tenantName String For Super Admin level No

243
11. VidyoReplay API

Name Type Description Required

usernameFilter String For Admin level No

roomFilter String Filter based on roomName No

sortBy sortBy The field by which the results should be Yes

sorted by. Valid values are “date,”
“title,” and “room”.

query String The search string that uses the above No

filter criteria.

recordScope recordScopeFilter new public private organizational Yes

dir sortDirection Sort direction: ASC, DESC Yes

limit Integer Max 200 No

start Integer Start search record from a specific No

recordnumber

webcast Boolean Search by webcast No

Response Parameters

Name Type Description Required

allVideosCount Integer Total available user records count No

including public and organizational
records from other users

searchCount Integer Available user records count after No

applying search filtering

myVideosCount Integer Total user records count for user own No

records

Note Admin has access for all available

user records under particular
tenant.

webcastCount Integer Total webcasts count for particular No

user

newCount Integer Total private records count for No

particular user

244
11. VidyoReplay API

Name Type Description Required

privateCount Integer Total organizational records count for No

particular user

organizationalCount Integer Total public records count for No

particular user

publicCount Integer Records array returned based on limit No

and offset criteria. Maximum output
limit is 200 records

Faults

Name Description

AccessViolationFault Access Violation Fault

GeneralFault An unspecified error occurred

RecordsById
Provides the recordfile by record IDs.

Note Only records to which that user has view access are shown.

This method can use the following parameters:

Request Parameter

Name Type Description Required

id Integer Record ID Yes

Response Parameter

Name Type Description Required

OK String String representation of successful operation Yes

245
11. VidyoReplay API

Faults

Name Description

GeneralFault An unspecified error occurred

updateRecord
Provides updates of records for the following fields:
 Title (if not provided)
 Comments (if not provided)
 Tags (if not provided)
 Record Scope (if not provided)
 PIN (if not provided)
1 – New
2 – Private
3 – Organizational
4 – Public
Empty String - PIN removed from the record based on record id. If the record value is not provided, the
same value will be retained.

Note Only records that the user has view access to are shown.

This method can use the following parameters:

Request Parameters

Name Type Description Required

id Integer ID number Yes

title String Title No

comments String Comments No

tags String Tags No

recordScope recordScopeUpdate Record Scope No

246
11. VidyoReplay API

Name Type Description Required

pin String Pin No

Faults

Name Description

AccessViolationFault Access Violation Fault

GeneralFault An unspecified error occurred

deleteRecord
Deletes a record based on the record ID.
This method can use the following parameters:

Request Parameter

Name Type Description Required

id Integer Id Yes

Faults

Name Description

AccessViolationFault Access Violation Fault

GeneralFault An unspecified error occurred

getVidyoReplayLibrary
Provides registered users with the link to the VidyoReplay library which hosts all the recordings on a
particular tenant on the VidyoPortal.
This method can use the following parameters:

Response Parameters

Name Type Description

247
11. VidyoReplay API

authToken String Authentication token that will be used when the user accesses
the VidyoReplay library

vidyoReplayLibraryUrl String Returns the URL of the VidyoReplay library

Faults

Name Description

VidyoReplayNotAvailableFault Returned when VidyoReplay is not set up on the specified

tenant

NotLicensedFault API is not licensed

GeneralFault An unspecified error occurred

248
 12. VidyoGateway API
This chapter describes the VidyoGateway API functionality available for the VidyoGateway.

Call Notification
Enables VidyoGateway to convey to the external application the details of an incoming call and to
receive a response with either a new dial string or an indication to reject the call (as an invalid dial string
or as room not accessible).
This method can use the following parameters:

VidyoGateway Request Parameters

Name Type Description Required

dialString String Dial string that was dialed (extension and PIN, if Yes
available)

sourceIP String IP address that the call is coming from Yes

clusterIP String IP address of the VidyoGateway cluster controller that Yes

is accepting the call

userAgent String Type of device used for making the call Optional

from String Name of the caller Optional

protocol String H.323 or SIP Yes

Response Parameter

Name Type Description Required

newDialString String Extension for the VidyoGateway to call No

Faults

Name Description

Error:404 Dial string is invalid. The VidyoGateway will play the “Retry Conference Error” IVR
prompt.

249
12. VidyoGateway API

Name Description

Error:425 Room not accessible (locked/full). The VidyoGateway will play the “Retry Room
Not Accessible” IVR prompt.

General Error When the external application returns a different response (not 200, 404, or 425),
the VidyoGateway IVR will play the “Retry Room Generic Error” IVR prompt.

Note For additional information about configuring the Call Notification API, please refer to the
VidyoGateway Administrator Guide.

250
 13. REST Web Services Authentication
API
This chapter describes the REST Web Services authentication API.

restAuthentication
Allows Super Admins and Admins to set up REST-based authentication.
 Content Type: Application/json
 Supported Method: GET, POST, and PUT
 Sample URL: http://yourfqdn/admin/service/restAuthentication

GET
Sample Request
http://example.com/admin/service/restAuthentication

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"restUrl":"https://webservice.example.com/authentication",
"assignedRoles":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
}
],
"restAuthConfigured":true
}
}

251
13. REST Web Services Authentication API

PUT
Sample Request
{
"restUrl":"https://webservice.example.com/authentication",
"assignedRoles":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
}
]
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"restUrl":"https://webservice.example.com/authentication",
"assignedRoles":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
}
],
"restAuthConfigured":true
}
}

Error Responses
 Status Code: 405 Method Not Allowed
 Status Code: 400 Bad Request

252
13. REST Web Services Authentication API

POST
Sample Request
{
"restUrl":"https://webservice.example.com/authentication",
"assignedRoles":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
}
]
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"restUrl":"https://webservice.example.com/authentication",
"assignedRoles":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
}
],
"restAuthConfigured":true
}
}

Error Responses
 Status Code: 405 Method Not Allowed
 Status Code: 400 Bad Request

253
13. REST Web Services Authentication API

Request Parameter

Name Type Description Required

restURL String URL of the REST service which will perform Yes
the authentication

assignedRoles List of Role A list of roles and user types that will be Yes
Objects affected by the REST authentication

roleID Integer Role ID Yes

roleName String Name of the role No

roleDescription String Describes the role No

restAuthConfigured Boolean Indicates whether the REST authentication is Yes

enabled

availableUserTypes
Retrieves the available user types and roles from VidyoPortal. This information is needed in order to
invoke the restAuthentication API.
 Content Type: Application/json
 Supported Method: GET
 Sample URL: http://yourfqdn/admin/service//availableUserTypes

GET
Sample Request
http://example.com/admin/service/availableUserTypes

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{

254
13. REST Web Services Authentication API

"roleID":2,
"roleName":"Operator",
"roleDescription":"Operator"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
},
{
"roleID":4,
"roleName":"VidyoRoom",
"roleDescription":"VidyoRoom"
},
{
"roleID":7,
"roleName":"Executive",
"roleDescription":"Executive"
},
{
"roleID":8,
"roleName":"VidyoPanorama",
"roleDescription":"VidyoPanorama"
}
]
}

Request Parameter

Name Type Description Required

data List of Role A list of user type and role objects Yes
Objects

roleID Integer Role ID Yes

roleName String Name of the role No

roleDescription String Describes the role No

localAuthentication
Enables local authentication.
 Content Type: Application/json
 Supported Method: POST
 Sample URL: http://yourfqdn/admin/service/localAuthentication

255
13. REST Web Services Authentication API

POST
Sample Request
http://example.com/admin/service/localAuthentication

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":null
}

samlMetadata
Allows Super Admins and Admins to set up SAML-based authentication.
 Content Type: Application/json
 Supported Method: GET, POST, and PUT
 Sample URL: http://yourfqdn/admin/service/samlMetadata

GET
Sample Request
http://example.com/admin/service/samlMetadata

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdmVyc2lvbj0iMS4.."
}
}

256
13. REST Web Services Authentication API

POST
Sample Request
{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdm.."
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94.."
}
}

Error Response
Status Code: 405 Method Not Allowed

PUT
Sample Request
{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94bWwgdm.."
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},

257
13. REST Web Services Authentication API

"data":{
"entityId":"vcportalgh2.vidyoqa.lo",
"securityProfile":"PKIX",
"sslSecurityProfile":"PKIX",
"signMetadata":false,
"base64EncodedMetadata":"PD94.."
}
}

Error Response
Status Code: 405 Method Not Allowed

Request Parameter

Name Type Description Required

entityId String Entity ID of the SAML configuration Yes

securityProfile String PKIX or METAIOP Yes

sslSecurityProfile String PKIX or METAIOP Yes

signMetadata Boolean Specifies a value of true or false Yes

base64EncodeMetadata String Base64 encode IDP Metadata XML Yes

samlAttributeMappings
Creates SAML attribute mappings for auto-provisioning.
 Content Type: Application/json
 Supported Method: GET, POST, and PUT
 Sample URL: http://yourfqdn/admin/service/samlAttributeMappings

GET
Sample Request
http://example.com/admin/service/samlAttributeMappings

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},

258
13. REST Web Services Authentication API

"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
},
{
"mappingID":20,
"tenantID":1,
"vidyoAttributeName":"DisplayName",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":21,
"tenantID":1,
"vidyoAttributeName":"EmailAddress",
"idpAttributeName":"",
"defaultAttributeValue":"yourcompany.com"
},
{
"mappingID":22,
"tenantID":1,
"vidyoAttributeName":"Extension",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":23,
"tenantID":1,
"vidyoAttributeName":"Group",
"idpAttributeName":"",
"defaultAttributeValue":"Default"
},
{
"mappingID":24,
"tenantID":1,
"vidyoAttributeName":"Description",
"idpAttributeName":"",
"defaultAttributeValue":"Idp Provisioned User"
},
{

259
13. REST Web Services Authentication API

"mappingID":25,
"tenantID":1,
"vidyoAttributeName":"Proxy",
"idpAttributeName":"",
"defaultAttributeValue":"No Proxy"
},
{
"mappingID":26,
"tenantID":1,
"vidyoAttributeName":"LocationTag",
"idpAttributeName":"",
"defaultAttributeValue":"Default"
},
{
"mappingID":27,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber1",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":28,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber2",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":29,
"tenantID":1,
"vidyoAttributeName":"PhoneNumber3",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":31,
"tenantID":1,
"vidyoAttributeName":"Department",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":32,
"tenantID":1,
"vidyoAttributeName":"Title",
"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":33,
"tenantID":1,
"vidyoAttributeName":"IM",

260
13. REST Web Services Authentication API

"idpAttributeName":"",
"defaultAttributeValue":""
},
{
"mappingID":34,
"tenantID":1,
"vidyoAttributeName":"Location",
"idpAttributeName":"",
"defaultAttributeValue":""
}
]
}
}

POST
Sample Request
{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",

261
13. REST Web Services Authentication API

"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
}

PUT
Sample Request
{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""
},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpmappinglist":[
{
"mappingID":18,
"tenantID":1,
"vidyoAttributeName":"UserName",
"idpAttributeName":"test",
"defaultAttributeValue":""

262
13. REST Web Services Authentication API

},
{
"mappingID":19,
"tenantID":1,
"vidyoAttributeName":"UserType",
"idpAttributeName":"",
"defaultAttributeValue":"Normal"
}
]
}
}

Request Parameter

Name Type Description Required

MappingID String ID Yes

vidyoAttributeName String The attribute name that Vidyo uses Yes

idpAttributeName String The IDP/IDAP attribute that will be mapped Yes

to the name of the Vidyo attribute

defaultAttributeValue Boolean Default value if nothing is mapped No

tenantID Integer Tenant ID Yes

samlAdditionalAttributeMappings
Creates additional SAML attribute mappings needed for auto-provisioning, such as user type, group,
etc.
 Content Type: Application/json
 Supported Method: GET, PUT, and DELETE
 Sample URL: http://yourfqdn/admin/service/samlAttributeMappings/

GET
URL Parameter
http://yourfqdn/admin/service/samlAttributeMappings/{mappingID}

Sample Request
http://example.com/admin/service/samlAdditionalAttributeMappings/19

263
13. REST Web Services Authentication API

Sample Response
{
"status":{
"code":"200",
"message":"OK"
},
"data":{
"idpvaluemappinglist":[
{
"valueID":2,
"mappingID":19,
"vidyoValueName":"Executive",
"idpValueName":""
},
{
"valueID":1,
"mappingID":19,
"vidyoValueName":"Normal",
"idpValueName":""
}
]
}
}

PUT
Sample Request
{
"idpvaluemappinglist":[
{
"valueID":2,
"mappingID":19,
"vidyoValueName":"Executive",
"idpValueName":""
},
{
"valueID":1,
"mappingID":19,
"vidyoValueName":"Normal",
"idpValueName":""
}
]
}

Sample Response
{
"status":{
"code":"200",

264
13. REST Web Services Authentication API

"message":"OK"
},
"data":{
"idpvaluemappinglist":[
{
"valueID":2,
"mappingID":19,
"vidyoValueName":"Executive",
"idpValueName":""
},
{
"valueID":1,
"mappingID":19,
"vidyoValueName":"Normal",
"idpValueName":""
}
]
}
}

DELETE
URL Parameter
http://yourfqdn/admin/service/samlAttributeMappings/{valueID}

Sample Request
http://example.com/admin/service/samlAdditionalAttributeMappings/2

Sample Response
{
"status":{
"code":"200",
"message":"Deleted Successfully"
},
"data":null
}

Request Parameter

Name Type Description Required

valueID String ID Yes

mappingID String Attribute mapping ID Yes

vidyoValueName String Name of the Vidyo attribute No

idpValueName Boolean Name of the IDP value Yes

265
13. REST Web Services Authentication API

EPIC Integration REST Services

REST-based service endpoint to validate the extData.
 Content Type: Application/json
 Supported Method: POST
 Request URL: https://example.com/api/epic/v1/room/map

POST
Sample Request
https://[yourtenantfqdn]/api/epic/v1/room/map.

{
"extDataType" : "1",

"extData" :
"sgdfhdsgfhgdshfds46564cashgdw72sdgfdshgjgfsdahfgksdfgjhdsfgsdhda
shd242764233qweweytrfew6eafrgruywerewrsfg=="

Request Parameter

Name Type Description Required

extDataType Integer External Integration Id Yes

extData String Encrypted and Base64 encoded data Yes

Sample Response

266