Partners Blog Contacts

Web Services Guest API

Follow

This article describes the Web Services Guest API.

VidyoPortal Guest Service URL:

http://VIDYOPORTAL/services/VidyoPortalGuestService?wsdl

The following methods are described in this article as part of the Guest API package.


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.

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)

Yes

returnEndpoint
Behavior

Boolean

Flag to return the endpoint behavior if configured

No


Response Parameters

Name Type Description Required

guestID

String

Guest Id

Yes

isLocked

Boolean

True or False

No

hasPin

Boolean

True or False

No

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 VidyoPortal where the conference is started

Yes

EID

String

Endpoint ID – User associated with the Vidyo endpoint identifier

Yes

vrIP

String

VidyoRouter IP address

No

clientType

String

Represent client type Type is 'W' for Windows 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

No


Response Parameters

Name Type Description Required

Entity

EntityID

If the user’s authentication is successful, the Member entity is returned

Yes


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


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 VidyoPortal where the conference is started

Yes

pin

String

PIN is an optional string in case the room has a PIN

No


Response Parameters

Name Type Description Required

OK

String

Acknowledges that the request has been received successfully

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

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, room name for public room or extension)

Yes

domain

String

FQDN or IP address of remote VidyoPortal

Yes

pin

String

(optional) required if remote room is pinned

No


Response Parameters

Name Type Description Required

OK

String

Acknowledges that the request has been received successfully

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 joinConference is wrong

ConferenceLockedFault

Conference provided by EntityID is unable to be joining, due to the fact that it is locked

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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:

  • 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

Yes


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 endpoint can be downloaded from

Yes

 

Faults

Name Description
GeneralFault An unspecified error occurred

InvalidArgumentFault

Invalid Argument Fault or in case that the conferenceID or entityID doesn't exist

 

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 endpoint and whether those are enabled or not

Optional

applicationName

String

The Vidyo application name (for example, VidyoDesktop, VidyoMobile, etc.)

Optional

applicationOs

String

The OS on which the Vidyo application is running (for example, Windows)

Optional

deviceModel

String

The device model on which the application is running (for example, iPhone 5S)

Optional


Response Parameters

Name Type Description Required

OK

String

Acknowledges that the request has been received successfully

Yes


Faults

Name Description
GeneralFault An unspecified error occurred
InvalidArgumentFault The arguments that were passed into services were wrong
EndpointNotBoundFault Endpoint Not Bound Fault


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 Parameters

Name Type Description Required

(Always Empty)

N/A

Use only the HTTP Authentication header

N/A


Response Parameters

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


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 Parameters

Name Type Description

OK

String

Acknowledges that the request has been received successfully


Faults

Name Description
GeneralFault An unspecified error occurred


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 Parameters

Name Type Description

OK

String

Acknowledges that the request has been received successfully


Faults

Name Description
GeneralFault An unspecified error occurred
InvalidArgumentFault The arguments that were passed into services were wrong

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.