Playback Conference

The Playback Conference service allows applications to retrieve a playback URL of any conference that has been recorded and published by the host.

4.9.1 Service URL

http://<hostname>:<portnumber>/imtapp/OracleRTCService?operation=playback&xmlin=<xml-document >

4.9.2 Input Parameters

The parameter "xmlin" is the XML document that contains all the input parameters for the service. This document should be based on the following XML schema:

http://<hostname>:<port number>/imtapp/app/playbackReq.xsd

Table 4–24, " Playback Conference Input Parameters" describes each of the elements in the XML schema.

Table 4–22 Report Attendee List Return Parameters

XML Schema Element Required? Data Type Description

responseCode Yes Integer Return code is always 0 on successful execution.

name Yes String Name of this attendee.

emailAddress Yes String Attendee’s email (if available).

timeEntered Yes Long Time at which this attendee entered the conference in

Universal Time Code (UTC) format.

timeExited Yes Long Time at which this attendee left the conference in Universal

Time Code (UTC) format.

guest Yes Boolean Whether this attendee is a registered user (No) or a guest

user (Yes).

Table 4–23 List Upcoming Conferences Conference Errors

XML Schema Element Required? Data Type Description

responseCode Yes Integer Return code is always 0 on successful execution

message Yes String A short description of the error

Note: The XSD for the error message is same for all the Oracle RTC Integration Services functions. A listing of all the response codes along with a short description is available in Section 4.10, "Errors"

Playback Conference

4.9.3 Return Parameters

The format of the return document depends on the returnType parameter.

If the returnType parameter is XML, then on successful execution, the response is an XML document whose schema is defined by playbackResp.xsd.

http://<hostname:port#>/imtapp/app/jplaybackResp.xsd

If the returnType is text, then the join conference URL is returned with redirect

directive. This is useful when the Playback Conference service is called from a browser window. In this case, the browser window is automatically redirected to a location, which automatically launches the Oracle Web Conferencing playback console.

4.9.4 Error Handling

The format of the error document depends on the returnType parameter. If the returnType is text, then the appropriate error message is returned as a text/HTML page.

If the returnType is XML, if there is any error (response code is non-zero), the response to the call is an XML document based on errorMsg.xsd.

http://<hostname>:<port number>/imtapp/app/errorMsg.xsd

Table 4–24 Playback Conference Input Parameters XML Schema

Element Required? Data Type

Valid

Values Description

meetingid Yes Integer ID of the

conference to be joined

A unique ID generated by Oracle RTC during conference creation.

returnType No String XML, text The format of the return value: XML

document or URL redirect. Default is XML.

Table 4–25 Playback Conference Return Parameters

XML Schema Element Required? Data Type Description

responseCode Yes Integer Return code is always 0 on successful execution

mtgId Yes String ID of the scheduled conference

playbackURL Yes Any URL URL to be used for playing back the conference

Table 4–26 Playback Conference Errors

XML Schema Element Required? Data Type Description

responseCode Yes Integer Return code is always 0 on successful execution

message Yes String A short description of the error

Note: The XSD for the error message is same for all the Oracle RTC Integration Services functions. A listing of all the response codes along with a short description is available in Section 4.10, "Errors"

Errors

Beta Draft Integration Interfaces 4-17

4.10 Errors

Table 4–27, " Meanings of Error Numbers" lists the meanings of all the error numbers that can be returned in the XML error message.

Table 4–27 Meanings of Error Numbers

Error Number Meaning

101 Bookmark link not set.

100 Bookmark name not set.

9 System error

8 XML parser error.

7 Session ID is invalid.

6 User GUID is invalid.

5 User ID is invalid.

4 Site ID is invalid.

3 Conference ID is invalid.

2 Conference ID is null.

1 User is not logged in.

0 No error.

367 Invalid conference password

366 Too early to join this conference

365 This conference is in progress, so it cannot be deleted.

364 Access denied to this conference. You are not the site ID owner. 361 Please specify conference type in your request.

427 One or more attendees don't have any of the following: GUID, USERID, cn 426 Invalid USERID specified for attendee(s)

425 Invalid GUID specified for attendee(s) 424 Invalid USERID specified for the 423 Invalid GUID specified for the host

422 Please specify either GUID or user ID for the host.

421 Host MUST be specified.

358 Conference could not be created due to a system error.

357 End date/time incorrect

356 Start date/time incorrect

355 Please provide conference end time (dtend)

354 Conference cannot be updated now.

353 Conference time zone is null.

352 Conference end time is null.

351 Conference start time is null.

350 Conference title is null.

Errors

10 One or more of the mandatory params (operation, xmlin) not found. Table 4–27 (Cont.) Meanings of Error Numbers

Beta Draft Sample Implementations 5-1

5