User API

The User API (com.vidyo.portal.user) provides functionality like search, join meetings rooms, make direct calls, and so on.

You use this API when developing third party endpoints or applications targeted for end users.

Implicit in each request are authorization parameters (login and password) identifying the requester. If any API method allows anonymous requests (for example, allowing guests to join a meeting room), then the requester will be assumed to be Guest if the request does not contain credentials.

URL

The VidyoPortal User Service URL is:

http://VIDYOPORTAL/services/v1_1/VidyoPortalUserService?wsdl

Functionality

This API includes the following functionality.

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 or place a direct call to this member
  • Member logout so that this member is no longer available
  • 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
  • Get recording profiles