Vidyo Web Services API Administrator Guide
1. Overview
- About the Web Services Platform
- The System in Brief
- VidyoPortal: Central Management and User Access
- VidyoRouter: Multipoint Bridging
- Vidyo Endpoints
- Vidyo Solution Benefits Summary vs. H.264 AVC
- Acronyms Used in This Guide
2. Customizable Architecture
3. VidyoPortal API Overview
- Data Model
- Overview of Super APIs
- Member Tenants Management
- Other Methods
- Overview of Admin APIs
- Member Account Management
- Meeting Room Management
- Group Management
- Record Control
- Content Management
- Webcasting
- Using Search APIs
- Overview of Guest APIs
- Guest User Login Process Overview
- Overview of User APIs
- Member Account and Preference
- Member Speed Dial Settings
- Search Operations
- Meeting Room and Direct Call
- Room Settings and Control
- Record Control
- Content Management
- Webcasting
- Using Search APIs
- User Login Process Overview
- Getting the VidyoDesktop Version
- First-Time license Implementation User Login Process
4. Web Services Super API
- addClientVersion
- ListTenants
- createTenant
- deleteTenant
- updateTenant
- getTenantDetails
- setMobileLoginMode
- GetLicenseData
- GetServiceComponentsData
- saveDB
- backupDB
- listDB
- deleteDB
- ListNetworkComponents
- getIpcAccessControl
- getIpcDomainList
- setIpcAccessControl
- setIpcDomains
- getRouterPoolList
- getLocationTags
- setLoginAndWelcomeBanner
- SetChatStateSuper
- getChatStateSuper
5. Web Services Admin API
- addClientVersion
- getEndpointBehavior
- createEndpointBehavior
- updateEndpointBehavior
- deleteEndpointBehavior
- searchMembers
- GetMembers
- GetMember
- AddMember
- UpdateMember
- DeleteMember
- GetRooms
- GetRoom
- GetRoomProfile
- SetRoomProfile
- RemoveRoomProfile
- GetRoomProfiles
- AddRoom
- UpdateRoom
- DeleteRoom
- enableRoom
- RoomIsEnabled
- enableScheduledRoom
- ScheduledRoomIsEnabled
- GetGroups
- GetGroup
- AddGroup
- UpdateGroup
- DeleteGroup
- GetParticipants
- inviteToConference
- LeaveConference
- MuteAudio
- UnmuteAudio
- StartVideo
- StopVideo
- CreateRoomURL
- RemoveRoomURL
- CreateRoomPIN
- RemoveRoomPIN
- GetLicenseData
- inviteToConference
- createModeratorPIN
- removeModeratorPIN
- GetPortalVersion
- GetLocationTags
- ScheduledRoomEnabled
- disableScheduledRoom
- cancelOutboundCall
- SetChatStateAdmin
- startLectureMode
- stopLectureMode
- GetLectureModeParticipants
- DismissRaisedHand
- DismissAllRaisedHand
- SetPresenter
- RemovePresenter
- SetTenantRoomAttributes
- createPublicRoom
- createScheduledRoom
- TransferParticipantRequest
- setLayout
6. Web Services Guest API
- LogInAsGuest
- LinkEndpointToGuest
- createTestcallRoom
- GuestJoinConference
- joinIPCConference
- getClientVersion
- setEndpointDetails
- WhatIsMyIPAddress
- RaiseHand
- UnraiseHand
7. Web Services User API
- logIn
- linkEndpoint
- logOut
- myEndPointStatus
- search
- searchMyContacts
- searchByEnityID
- searchMembers
- searchRooms
- addToMyContacts
- RemoveFromMyContacts
- inviteToConference
- createTestcallRoom
- joinConference
- directCall
- getParticipants
- GetUserName
- leaveConference
- muteAudio
- unmuteAudio
- startVideo
- stopVideo
- myAccount
- createRoomURL
- createRoomPIN
- getPINLengthRange
- removeRoomPIN
- updatePassword
- updateLanguage
- DeleteRoom
- createRoom
- lockRoom
- unlockRoom
- createModeratorPIN
- removeModeratorPIN
- GetRoomProfile
- SetRoomProfile
- RemoveRoomProfile
- GetRoomProfiles
- SetMemberMode
- GetEntityByEntityID
- getEntityDetailsByEntityID
- GetEntityByRoomKey
- setThumbnailPhoto
- GetInviteContent
- GetPortalVersion
- GetConferenceID
- generateAuthToken
- getActiveSessions
- logoutAllOtherSessions
- getOnetimeAccessUrl
- PortalPrefix
- createScheduledRoom
- createPublicRoom
- updatePublicRoomDescription
- joinConference
- disconnectConferenceAll
- muteAudioServerAll
- muteAudioClientAll
- muteVideoServerAll
- muteVideoClientAll
- SilenceSpeaker
- SilenceSpeakerServerAll
- createModeratorURL
- removeModeratorURL
- getModeratorURL
- getModeratorURLWithToken
- cancelOutboundCall
- getPortalFeatures
- getUserAccountType
- getLoginAndWelcomeBanner
- startLectureMode
- stopLectureMode
- GetLectureModeParticipants
- RaiseHand
- UnraiseHand
- DismissRaisedHand
- DismissAllRaisedHand
- SetPresenter
- RemovePresenter
- SetEndpointDetails
- WhatIsMyIPAddress
8. Web Services License API
9. User Status Notification
10. Status Notification Service
- Status Notification Service Data
- Root Object
- user Object
- Room Object – Optional
- conference Object – Optional
- endpoint Object – Optional
- endpointDetails Object – Optional
- gateway Object – Optional
- contextAwareLinking – Optional
- Configuring the Status Notification Service
11. Authentication Using Web Services
- Authentication Services Overview
- Request Parameters
- Response Parameter
- Configuring the Authentication Server
12. VidyoReplay API
- GetRecordingProfiles
- startRecording
- StopRecording
- PauseRecording
- ResumeRecording
- createWebcastURL
- removeWebcastURL
- getWebcastURL
- createWebcastPin
- removeWebcastPin
- RecordsSearch
- RecordsById
- updateRecord
- deleteRecord
- getVidyoReplayLibrary
13. VidyoGateway API
14. REST Web Services API
- restAuthentication
- availableUserTypes
- localAuthentication
- samlMetadata
- samlAttributeMappings
- samlAdditionalAttributeMappings
- EPIC Integration REST Services
- REST Super Admin APIs
- Get All Log Categories
- Modify Log Level for the Logger Category
- Reset Log Level to Default
- Endpoint Behavior Mode
- Create Endpoint Behavior Mode API
- Update Endpoint Behavior Mode API
- Get Endpoint Behavior Mode API
- Delete Endpoint Behavior Mode API
- CDR Obfuscation Profiles
- Create System CDR Obfuscation Profile
- Get All System CDR Obfuscation Profiles
- Force Update All CDR Obfuscation Profiles with Specified Obfuscation Level
- Update System CDR Obfuscation Profiles
- Get System CDR Obfuscation Profile
- Create Tenant CDR Obfuscation Profile
- Get All Tenant CDR Obfuscation Profiles
- Update Tenant CDR Obfuscation Profile
- Get Tenant CDR Obfuscation Profile
- Delete Tenant CDR Obfuscation Profile
- Get CDR Fields that Can Be Obfuscated
- Minimum Endpoint Version – System Level Configuration
- Create System Default Rejected Application
- Get All System Default Rejected Applications
- Force Update System Default Rejected Applications to All Tenants
- Get System Default Rejected Application
- Update System Default Rejected Application
- Delete System Default Rejected Application
- Create System Default Rejected Endpoint Types
- Get All System Default Rejected Endpoint Types
- Force Update System Default Rejected Endpoint Type to All Tenants
- Get System Default Rejected Endpoint Type
- Update System Default Rejected Endpoint Type
- Delete System Default Rejected Endpoint Type
- Minimum Endpoint Version – Tenant Level Configuration
- Create Tenant Level Rejected Application
- Get All Tenant Rejected Applications
- Get Tenant Level Rejected Application
- Update Tenant Level Rejected Application
- Delete Tenant Level Rejected Application
- Create Tenant Level Rejected Endpoint Type
- Get All Tenant Level Rejected Endpoint Types
- Get Tenant Level Rejected Endpoint Type
- Update Tenant Level Rejected Endpoint Type
- Delete Tenant Level Rejected Endpoint Type
15. Custom Parameters
- API to Get Custom Parameters
- System Level: Set JWT Authentication Secret
- System Level: Generate JWT Authentication Secret
- Tenant Level: Set JWT Authentication Secret
- Tenant Level: Generate JWT Authentication Secret
- Tenant Level: Get JWT Authentication Secret
- Refresh Token
- Add Server Token API
- Get Server Tokens API
- Delete Server Token API
- VidyoPortal Event Service Configuration
- Setting Event Service System Configurations
- Setting Messaging System Configurations (REST API)
16. REST CORS
- System-level: Add CORS
- System-level: Get CORS
- System-level: Update CORS
- System-level: Delete CORS
- Tenant-level: Add CORS
- Tenant-level: Get CORS
- Tenant-level: Update CORS
- Tenant-level: Delete CORS
Copyright
© 2024 An Enghouse Vidyo Company all rights reserved. Enghouse 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/company/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 Enghouse Vidyo throughout the world. Vidyo family of marks are trademarks of Vidyo, Inc. in the United States and throughout the world.
