Partners Blog Contacts

This article 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

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


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)

N/A

Use only the HTTP Authentication header

N/A


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
GeneralFault An unspecified error occurred

InvalidArgumentFault

The arguments that were passed into services were wrong

NotLicensedFault

API is not licensed

SeatLicenseExpiredFault

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

Yes

recorderPrefix

String

Prefix ID

Yes

webcast

Boolean

Start recording the webcast

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

ResourceNotAvailableFault

Resource Not Available Fault

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


StopRecording

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

Yes

recorderID

String

A string representing the recording prefix. The GetPArticipantsResponse() will provide recorderID associated with this conference.

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed

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

Yes

recorderID

String

A string representing the recording prefix

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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

Yes

recorderID

String

A string representing the recording prefix

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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 VidyoPortal

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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 VidyoPortal

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


GetWebcastURL

Gets the Webcast URL and PIN indicator for a 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 VidyoPortal

Yes


Response Parameters

Name Type Description Required

webCastURL

String

Webcast URL

Yes

hasWebCastPIN

Boolean

If room has a pin

Yes


Faults

Name Description
GeneralFault An unspecified error occurred

InvalidArgumentFault

The arguments that were passed into services were wrong

NotLicensedFault

API is not licensed

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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 in the VidyoPortal

Yes

pin

String

Webcast Pin

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


removeWebcastPin

Removes a PIN 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 VidyoPortal

Yes


Response Parameter

Name Type Description Required

OK

String

Acknowledges that the operation was made 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

SeatLicenseExpiredFault

Seat license has expired and needs to be renewed


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

usernameFilter

String

For Admin level

No

roomFilter

String

Filter based on roomName

No

sortBy

sortBy

The field by which the results should be sorted by. Valid values are “date,” “title,” and “room”.

Yes

query

String

The search string that uses the above filter criteria.

No

recordScope

recordScopeFilter

New public organization

Yes

dir

sortDirection

Sort direction: ASC, DESC

Yes

limit

Integer

Max 200

No

start

Integer

Start search record from a specific
recordnumber

No

webcast

Boolean

Search by webcast

No


Response Parameters

Name Type Description Required

allVideosCount

Integer

Total available user records count including public and organizational records from other users

No

searchCount

Integer

Available user records count after applying search filtering

No

myVideosCount

Integer

Total user records count for user own records

Note: Admin has access for all available user records under particular tenant.

No

webcastCount

Integer

Total webcasts count for particular user

No

newCount

Integer

Total private records count for particular user

No

privateCount

Integer

Total organizational records count for particular user

No

organizationalCount

Integer

Total public records count for particular user

No

publicCount

Integer

Records array returned based on limit and offset criteria. Maximum output limit is 200 records

No


Faults

Name Description
GeneralFault An unspecified error occurred

AccessViolationFault

Access Violation Fault


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

Acknowledges that the operation was made successfully

Yes


Fault

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.

 

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

pin

String

Pin

No


Faults

Name Description
GeneralFault An unspecified error occurred

AccessViolationFault

Access Violation Fault


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
GeneralFault An unspecified error occurred

AccessViolationFault

Access Violation Fault


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

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
GeneralFault An unspecified error occurred

NotLicensedFault

API is not licensed

VidyoReplayNotAvailableFault

Returned when VidyoReplay is not set up on the specified tenant

 

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

0 Comments

Follow
Please sign in to leave a comment.