NBR Web Services API 2.3.5 Guide

™ Cisco WebEx

Network-Based Recording Web Services API v2.3.5 Reference Guide

Document Version 1.0

Copyright WebEx Communications, Inc. reserves the right to make changes in the information contained in this publication without prior notice. The reader should in all cases consult WebEx Communications, Inc. to determine whether any such changes have been made. © 2008 WebEx Communications, Inc. All rights reserved. WebEx and MediaTone are registered trademarks or trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries. UNPUBLISHED - RIGHTS RESERVED UNDER THE COPYRIGHTS LAW OF THE UNITED STATES. USE OF A COPYRIGHT NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION OR DISCLOSURE. OTHER BRANDS AND PRODUCTS ARE TRADEMARKS OR REGISTERED TRADEMARKS OF THEIR RESPECTIVE HOLDERS. RESTRICTED RIGHTS LEGEND. USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT IS SUBJECT TO RESTRICTIONS AS SET FORTH IN SUBPARAGRAPH (C) (1) (ii) OF THE RIGHTS IN TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 252.227-7013, RIGHTS IN TECHNICAL DATA AND COMPUTER SOFTWARE (OCTOBER 1988).

Version: May 11, 2009 3:27 pm

WebEx Communications, Inc. 3979 Freedom Circle Santa Clara, CA 95054

Copyright WebEx Communications, Inc. reserves the right to make changes in the information contained in this publication without prior notice. The reader should in all cases consult WebEx Communications, Inc. to determine whether any such changes have been made. © 2008 WebEx Communications, Inc. All rights reserved. WebEx and MediaTone are registered trademarks or trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries. UNPUBLISHED - RIGHTS RESERVED UNDER THE COPYRIGHTS LAW OF THE UNITED STATES. USE OF A COPYRIGHT NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION OR DISCLOSURE. OTHER BRANDS AND PRODUCTS ARE TRADEMARKS OR REGISTERED TRADEMARKS OF THEIR RESPECTIVE HOLDERS. RESTRICTED RIGHTS LEGEND. USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT IS SUBJECT TO RESTRICTIONS AS SET FORTH IN SUBPARAGRAPH (C) (1) (ii) OF THE RIGHTS IN TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 252.227-7013, RIGHTS IN TECHNICAL DATA AND COMPUTER SOFTWARE (OCTOBER 1988).

Version: May 11, 2009 3:27 pm

WebEx Communications, Inc. 3979 Freedom Circle Santa Clara, CA 95054

Contents Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 NBR Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 SOAP API Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 API Responses: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Security Context Stanza: . . . 3 Status Stanza: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Results Stanza: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Roles and Permissions Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Chapter 2 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 DeleteMeetingXml DeleteMeetingXml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 deleteMeetingXmlRequest deleteMeetingXmlRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 deleteMeetingXmlResponse deleteMeetingXmlResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 DownloadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 downloadFileRequest downloadFileRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 downloadFileResponse downloadFileResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 NBRFileOpenService NBRFileOpenService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 How it works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 GetMeeti GetMeetingTic ngTicket ket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 User Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Cisco WebEx Network-Based Recording API

iii

getMeetingTicketRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 getMeetingTicketResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 GetMeetingXml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 getMeetingXmlRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 getMeetingXmlResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 GetNBRConfIdList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 getNBRConfIdListRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 getNBRConfIdListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 GetNBRRecordIdList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 getNBRRecordIdListRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 getNBRRecordIdListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Chapter 3 WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 WSDL Listings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 NBR File Open Web Service WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 NBR XML Web Service WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

iv


List of Figures Figure 2-1  getMeetingXmlResponse (part 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Figure 2-2 • getMeetingXmlResponse (part 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Figure 2-3 • getMeetingXmlResponse (part 3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Figure 2-4 • getNBRRecordIdList Schema Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39


v

vi


List of Tables Table 1-1 • Response Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Table 1-2 • Service Operation Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Table 2-1 • NBR APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Table 2-2 • deleteMeetingXmlRequest Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Table 2-3 • deleteMeetingXmlResponse Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Table 2-4 • downloadFileRequest Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Table 2-5 • downloadFileResponse Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Table 2-6 • getMeetingTicketRequest Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Table 2-7 • getMeetingTicketResponse Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Table 2-8 • getMeetingXmlRequest Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Table 2-9 • getMeetingXmlResponse Return Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Table 2-10 • getMeetingXmlResponse Return Values with Attributes . . . . . . . . . . . . . . . . . . 30 Table 2-11 • getNBRConfIdListRequest Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Table 2-12 • getNBRConfIdListResponse Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Table 2-13 • getNBRRecordIdListRequest Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Table 2-14 • getNBRRecordIdListResponse Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40


vii

viii


About This Reference Guide The Cisco WebEx Network-Based Recording (NBR) Web Services API Reference Guide provides the primary reference materials to enable users to access and use NBR to enhance their web meeting capabilities.

Audience for this Guide This document is intended for product designers, developers, partners and system integrators.

What this Guide Contains The WebEx Network-Based Recording Reference Guide includes the following chapters: ■

■

■

Chapter 1, Overview, provides a brief overview of the document and NBR. Chapter 2, API Functions , provides details of the API functions exposed by NBR. Chapter 3, WSDL, provides a complete WSDL listing.

What’s New in Version 2.3.5 ■

■

Support to allow users to download recordings has been added. See “GetNBRRecordIdList” on page 39 for details. The ability to download multiple recordings at one time has been added. See “NBRFileOpenService” on page 13 for more details.

Providing feedback WebEx Communications greatly appreciates any feedback that you provide about our products and documentation.


ix

Providing feedback about this documentation If you have comments about WebEx documentation, please send an email message to [email protected]. In your email message, please specify the section to which your comment applies. If you would like to receive a response to your comments, please include your name and contact information in your message.

x


1 Overview Network-Based Recording (NBR) allows users to conduct web based meetings and record the results for future review. This provides an effective way to distribute information to the users who were unable to attend the event as it happened. NBR allows users to record all aspects of a meeting to include: presentation, audio, video, application sharing, Q&A, etc. Users are also able to edit the recordings and post the finished product on the internet or intranet so that multiple users are able to access the information at their convenience.

NBR Overview Network-Based Recording (NBR) is the newest recording option available to Cisco WebEx customers on release WBS25 or higher. NBR enables you to capture all session content (chat, Q&A, polling, etc.), including WebEx integrated audio, VOIP audio, or third-party audio conference for later playback and future reference. Recorded data is stored on the high availability, dedicated physical storage servers within the WebEx secure data center facilities. Each facility is staffed 24 hours a day, seven days a week. To gain access to any facility, one must be on the approved-access list managed by the WebEx security team. Access is further controlled by biometric security devices. All recording data is backed up daily. Backed up data is stored both locally and remotely for 90 days.


1

SOAP API Requests A SOAP message is an XML document. It consists of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. The envelope is the top element of the XML document and is represented by an envelope element. The envelope can contain namespace declarations as well as additional attributes such as encoding style. The target service address differs depending on the location of the NBR Web Service and follows the following format: http://[data center specific domain]/nbr/services/nbrXMLService Note Contact the API Developer Services team ([email protected]) to get the

exact URL for your site.

API Responses: The response from an API call is always text / XML. Depending on the call, the response may have only the status and security context, or it may include data. The root element for the response XML is wbxapi. For example: f383bb3bb65836202f0fff707b3d4ccc - status information … more information based on the request …

2


Security Context Stanza: The securityContext encapsulates the Client's security credential (acquired at login) and uniquely identifies the API session. This credential expires at logout or after two hours of inactivity in order to prevent replay attacks and must be used in the subsequent API call. An example of a securityContext stanza is: f383bb3bb65836202f0fff707b3d4ccc

The cred element contains the unique credential for the current API session. Although this credential will be unchanged until its expiration or logout of the client, good practice is to use the response credential itself rather than a locally stored copy. This makes it possible to support multiple active credentials for a user with active workspaces associated with different organizations.

Status Stanza: Status is returned in a response stanza, for example: FAILURE User session has expired wbxc.expired_credential

A successful call will contain only a SUCCESS result, unless the response is to a GET command. In the case of a GET command, the elements count and totalCount are included. Table 1-1 shows the elements used in the response stanza.

Table 1-1  Response Elements Element

Description

result

Mandatory. SUCCESS or FAILURE.

reason

Only present on FAILURE.

exceptionID

Additional Failure information.

count

Returned with the GET command. The number of results returned per the users specifications. I.E. a page size of 20 would return count = 20 if the page was full of found items.

totalCount

Returned with the GET command. The total number of results satisfying the GET command. totalCount is returned only if it differs from count.


3

Results Stanza: Many successful API responses return results other than just the stat us. In these cases the requested data is an immediate child of the return element. In the following example, a site ID is returned in response to a request: f383bb3bb65836202f0fff707b3d4ccc SUCCESS 13342

The following example shows multiple returned meeting domain names. f383bb3bb65836202f0fff707b3d4ccc SUCCESS 3 1234 1235 1236

4


Roles and Permissions There are three WebEx service roles. After your service request is authenticated by the WebEx server, your WebEx user name is mapped to one of the following three roles: ■

■

■

Site Admin: A site administrator is usually an IT department employee who will administer the sites, set up the site, create user accounts, and assign user privileges. Site Admin—View Only: A site administrator with view-only privileges can generate reports and view information of the site, but cannot create, delete, or modify user accounts. Hosts: Hosts can schedule and start meetings. Hosts are usually the presenters as well.

There are four classifications of privileges for what each role can do for each XML API operation, as follows: ■

■

Site Privilege: A user’s ability to access information about all users and meetings on that site. Self Privilege: A user’s ability to view, delete, modify, or create his or her own data, but not the data of others.

■

Public Privilege: A user’s ability to have others access the data.

■

No Privilege: No such privileges.

Table 1-2 provides the details of the privileges for each role. A user must have Site Admin and Site privileges to access the NBR web services. Table 1-2 • Service Operation Privileges Service

Operation

Site Admin

Site Admin View Only

Host

NBR Service

deleteMeetingXML

Site

No

No

downloadFile

Site

No

No

getMeetingTicket

Site

No

No

getMeetingXML

Site

No

No


5

6


2 API Functions The NBR APIs allow users to access information that is unavailable through the Cisco WebEx XML API Reference Guide . Users are able to retrieve all the metadata that is associated ass ociated with a recording (Chat, Q&A, Polling, Participant information, etc.) using the NBR APIs. In addition, the APIs provide the user with an easy way to download the saved files. Neither of these abilities are currently feasible using the XML APIs. This chapter provides the developer with an in-depth look at the functions available for use.

APIs Before accessing the NBR APIs, users need to have access to certain parameters, including recordId and siteId. In order to retrieve this information, the user needs to access the lstRecording function. For more information on this function see the Cisco WebEx XML API Reference Guide . Developers access NBR by incorporating the following API calls into their code. The functions shown in Table 2-1 are the exposed NBR functions. Table 2-1 • NBR APIs Name

Page

deleteMeetingXmlRequest

on page 9

deleteMeetingXmlResponse

on page 10

downloadFileRequest

on page 12

downloadFileResponse

on page 13

getMeetingTicketRequest

on page 16

getMeetingTicketResponse

on page 17


7

Table 2-1 • NBR APIs (Continued) Name

Page

getMeetingXmlRequest

on page 26

getMeetingXmlResponse

on page 27

getNBRConfIdListRequest

on page 36

getNBRConfIdListResponse

on page 37

getNBRRecordIdListRequest

on page 39

getNBRRecordIdListResponse on page 40

8


DeleteMeetingXml Sends a request to the NBR servers to delete a previously saved recording. WebEx does not delete recordings unless specifically asked to by the user or 30 days after the user cancels their WebEx subscription service.

deleteMeetingXmlRequest Table 2-2 • deleteMeetingXmlRequest deleteMeetingXmlRequest Par Parameters ameters Name

Type

Description

confId

Long Long..

Uniq Unique ue iden identi tifi fier er for for eac each hW Web ebEx Ex sessi session on..

siteId

Long Long..

Uniq Unique ue iide dent ntif ifie ierr for for each each Web WebEx Ex sit site. e.

ticket

Stri String ng..

The The tick ticket et for for the the u use ser’ r’s s curre current nt sess sessio ion. n.

Http Request: http://< http:// >: >/nbr/services/nbrXmlService?method=deleteMeet ingXml&siteId=400009412&confId=4648067&ticket=IK4gi74h1BfKLY+ j6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eXjJW54B8EbQSnYbR/OmQjwpB7Hdm8 GKvIPZbQmouAugskje76jmM4=

Soap Request: POST /nbr/services/nbrXmlService HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.1 Host: 172.16.197.134:2001 Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 659

XML listing: > >


9

400009412 4648067 OMuVaMerKdMZBwaOL3IsoCyCCaT/KnflDC3AiV6dzqFkyRmyKMUjm9M AnyGpsk4zQSnYbR/OmQjwpB7Hdm8GKvFH90m0PJtFvCAl4EHu/bc=

deleteMeetingXmlResponse Table 2-3 • deleteMeetingXmlResponse Parameters Name

Type

Description

deleteMeetingXmlReturn

String.

Returns the status of the deleteMeetingXmlReturn function. Will return either “Success” or one of the following error messages: ■

The siteID is invalid.

■

The confId is invalid.

■

The ticket is invalid.

XML listing: Success

10


DownloadFile These functions are used to retrieve a saved file from the NBR servers. Recorded files can be streamed from the servers or downloaded from the server using these calls. An example of the code required to download a file follows: // create a new service call Service service = new Service(); Call call = (Call) service.createCall(); // set target end point address and operation name. Please refer to the WSDL for detailed information. The target end point address can be different for each user depending on the location of the NBR storage San Jose: http://nsj1wss.webex.com/nbr/services/nbrFileOpenService Denver:

http://ndv1wss.webex.com/nbr/services/nbrFileOpenService

London:

http://nln1wss.webex.com/nbr/services/nbrFileOpenService

call.setTargetEndpointAddress(new URL(config.getNbrServiceUrl())); call.setOperationName(new QName(serviceName, operationName)); // set the required parameters for RPC call. detailed information

Please refer WSDL for

call.addParameter("siteId", Constants.XSD_LONG, ParameterMode.IN); call.addParameter("serviceName", Constants.XSD_STRING, ParameterMode.IN); call.addParameter("userName", Constants.XSD_STRING, ParameterMode.IN); call.addParameter("password", Constants.XSD_STRING, ParameterMode.IN); call.addParameter("recordId", Constants.XSD_LONG, ParameterMode.IN); // create the data handler to handle the binary file attachment. Please refer WSDL for detailed information QName qnameAttachment = new QName(serviceName, "DataHandler"); call.registerTypeMapping(DataHandler.class, qnameAttachment, JAFDataHandlerSerializerFactory.class, JAFDataHandlerDeserializerFactory.class); call.setReturnType(qnameAttachment); // Invoke the web service RPC call and pass all parameters. The return object will contain the NBR recording (ARF file) Object ret = call.invoke(new Object[] { new Long(config.getSiteId()),

new String(nbrvo.getServiceName()),

new String(config.getAdminUserName()),


11

new String(config.getAdminPassword()), new Long(nbrvo.getRecordingId()) }); // Instantiate data handler DataHandler[] rdh = (DataHandler[]) ret; // Check the error message if (rdh.length != 2) { nbrvo.setResult(NbrErrMsg.ERR_RECORDING_DAMAGED); return; } // If there is no error, then save the NBR recording content to a File object File fpFile = new File(rdh[0].getName()); String filesize = ""; String filename = ""; FileInputStream fi = null; InputStreamReader is = null; BufferedReader reader = null; try { fi = new FileInputStream(fpFile); is = new InputStreamReader(fi, "UTF-8"); reader = new BufferedReader(is); filename = reader.readLine(); filesize = reader.readLine(); }

downloadFileRequest Table 2-4 • downloadFileRequest Parameters

12

Name

Type

Description

password

String.

WebEx user password.

recordId

Long.

The ID of the recording to be downloaded.

serviceName

String.

The type of meeting: MC, TC, EC,SC, or SaC.

siteId

Long.

Unique identifier for each WebEx site.

userName

String.

The user name of the person requesting the download.


downloadFileResponse This function is used to retrieve the file as it is downloaded. The response SOAP includes 2 files, the first one is the TXT file that includes the ARF file's name and size, the second on is the NBR recording ARF file content. Table 2-5 • downloadFileResponse Parameters Name

Type

Description

downloadFileReturn

SOAP with attachment.

Returns the requested file.

NBRFileOpenService The NBRFileOpenService utilizes the downloadFile function and permits users to download all of their recordings at once. This allows customers to write a program that accesses the service and automatically downloads all of their recordings instead of having to access each recording separately. Users must know the siteID and the site administrator’s userName and password before trying to download the recordings. How it works

When the user or their program goes to save the recordings, the following code is executed:


13

14



15

GetMeetingTicket In order to access the capabilities of NBR, a user must first sign in and retrieve a ticket from the service. This ticket identifies the user and allows them access to the NBR service.

User Authentication The getMeetingTicket functions are used to retrieve the ticket that allows the user to access the NBR servers. The user initially uses the getMeetingTicketRequest function to ask for this ticket. This requires the user to send their username and password to the servers. The getMeetingTicketResponse function is then used to accept the returned ticket. The user then uses this ticket throughout the session for authentication purposes.

getMeetingTicketRequest Table 2-6 • getMeetingTicketRequest Parameters Name

Type

Description

password

String.


service

String.

The type of meeting: MC, TC, EC,SC, or SaC.

siteId

Long.


username

String.

The user name of the user.

Http Request: http://:/nbr/services/nbrXmlService?method=getMeeting Ticket&siteId=400009412&username=hostid&password=hostpassword&servic e=MC

Soap Request: POST /nbr/services/nbrXmlService HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.1 Host: 172.16.197.134:2001 Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 613

XML listing: 16


400009412 hostid hostpassword MC

getMeetingTicketResponse Table 2-7 • getMeetingTicketResponse Parameters Name

Type

getMeetingTicketReturn String.

Description Returns the requested ticket. An unsuccessful response returns one of the following error messages: ■

The siteID is invalid.

■

The user is invalid or inactive.

■

The user is not site admin.

■

The password is not correct.

■

The service value should be matched MC/TC/EC/SaC/SC/MW.

XML listing:


17

IK4gi74h1BfKLYnj6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eX jJW54B8EbQSnYbR/OmQjwpB7Hdm8GKvIPZbQmouAugskje76jmM4=

18


GetMeetingXml The getMeetingXML functions are used to access and retrieve the XML content for a recording. The returned XML holds all of the information that was saved for the meeting. The schema for the XML follows:


19

20



21

22



23

24



25

getMeetingXmlRequest Table 2-8 • getMeetingXmlRequest Parameters Name

Type

Description

confId

Long.

Unique identifier for each WebEx session.

siteId

Long.


ticket

String.

The ticket for the user’s current session.

Http Request http://:/nbr/services/nbrXmlService?method=getMeeting Xml&siteId=400009412&confId=998923752&ticket=IK4gi74h1BfKLY+ j6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eXjJW54B8EbQSnYbR/OmQjwpB7Hdm8 GKvIPZbQmouAugskje76jmM4=

Soap Request: POST /nbr/services HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.1 Host: localhost Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 563

26


XML listing: 400009412 998923752 IK4gi74h1BfKLYnj6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eX jJW54B8EbQSnYbR/OmQjwpB7Hdm8GKvIPZbQmouAugskje76jmM4=

getMeetingXmlResponse

Figure 2-1 • getMeetingXmlResponse (part 1)


27


28



Table 2-9 provides a list of return parameters and their value. Table 2-10 provides a list of return parameters that have associated attributes with them. Information from both tables are found in the response from the getMeetingXMLResponse function. Table 2-9 • getMeetingXmlResponse Return Values Name

Type

Description

CorporateEmailID

String.

The email of a participant.

DateTimeUTC

String.

The stated start time of a meeting in UTC format.

EndTimeUTC

String.

The meeting end time in UTC format.

JoinDateTimeUTC

String.

When a participant joined the meeting in UTC format.

LeaveDateTimeUTC

String.

When a participant left the meeting in UTC format.


29

Table 2-9 • getMeetingXmlResponse Return Values (Continued) Name

Type

Description

MeetingName

String.

The name of the meeting.

ModeratorEmail

String.

The email of the moderator for the meeting.

ModeratorLogin

String.

The login information of the moderator for the meeting.

ModeratorName

String.

The name of the moderator.

StartTimeUTC

String.

The actual start time of the meeting in UTC format.

TargetName

String.

The designated recipient of a particular message.

Table 2-10 • getMeetingXmlResponse Return Values with Attributes

30

Name/Attribute

Type

Description

Choice/check_count

String.

How many users selected this answer for a question.

Choice/is_correct

Boolean.

Tells if an answer to a question is correct.

Choice/vote_users

String.

The individual user IDs of those users who chose an answer.

Content/question_count

Integer.

The number of questions being asked.

Content/user_count

String.

How many users should submit an answer for a poll.

Content/voted_user_count

String.

How many users submitted an answer for a poll.

Item/itemID

String.

The ID of an item.

Item/vote_users

String.

The individual user IDs of those users who chose an answer.

LoginName/UUID

String.

The login name of a user.

MeetingDetail/ID

Integer.

The ID of a meeting.

MeetingSession/type

String.

The type of meeting session.

Message/ind

String.

The message index number.

Message/messageID

String.

The ID of the message.

Message/priority

String.

The message priority.

Message/type

String.

The message type.

ParticipantList/list

Integer.

List of participants.

Question/choice_count

Integer.

The number of possible answers for a question.

Question/no_check_count

String.

How many users have yet to submit an answer to a poll.

Question/type

String.

The type of question being asked.


XML listing: karl qin karl-1016 2321961344 2322540282 [email protected] Your name 1160980889 1161559826 karl qin 1160980889 1161559826 [email protected]


31

karl qin 1161208868 All Participants fghdgfsgfdsfgsdfg das fasdf as karl qin 1161213738 All Attendees Your content here karl qin 1161223922 Host & Presenter Your content here 1161338143 1161349586

32


Question goes here sadf asd Question goes here fdasf sdf asddf asdf das f asdfasdf asddf sda f Question goes here asdf


33

asd dfasdfas dfasdf asdf Your name 1161105322 sdfsdfasdfasfsdfasdfsdf karl qin Email address 1161105322 Your content here Your name 1161105322 3453534534 karl qin Email address 1161105322 Your content here

34


The following error messages are returned if the call was unsuccessful. ■

The siteId is invalid.

■

The confId is invalid.

■

The ticket is invalid.


35

GetNBRConfIdList Returns the confIDs for all recorded meetings on the site for each of the following services: MC, TC, EC, SC, SaC. The general purpose XML API lstRecording function (see the Cisco WebEx XML API Reference Guide ) returns additional recording information and allows filtering by date range and host.

getNBRConfIdListRequest Table 2-11 • getNBRConfIdListRequest Parameters Name

Type

Description

siteId

Long.


ticket

String.

The ticket for the user’s current session.

Http Request http://:/nbr/services/nbrXmlService?method=getMeeting Xml&siteId=400009412&confId=998923752&ticket=IK4gi74h1BfKLY+ j6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eXjJW54B8EbQSnYbR/OmQjwpB7Hdm8 GKvIPZbQmouAugskje76jmM4=

Soap Request T6GJfsFPttOvVCFCzAEsOWZDUqmnScawEfc5aghK5MJTgtJyYrEMZTT3 4L9E2L+SZ4ZUVTNv2FlEk9/khkrFSvIPZbQmouAugskje76jmM4= 400011074

36


getNBRConfIdListResponse Table 2-12 • getNBRConfIdListResponse Parameters Name

Type

getNBRConfIdListReturn XML Document.

Description Returns the confID list for the WebEx service: MC, TC, EC, SaC, SC.

XML listing: 258287597 258287598 1036379567 258270170 258209834 258153118 258270145 258128714 258270149 258270148


37

258270139 258153179 258153220 258150587 258269590

38


GetNBRRecordIdList This service lists record IDs for a customer’s site. The RecordIdList contains three types of record IDs: ■

service upload recording record ID

■

miscellaneous upload recording record ID

■

NBR recording record ID

Figure 2-4 • getNBRRecordIdList Schema Diagram

getNBRRecordIdListRequest Table 2-13 • getNBRRecordIdListRequest Parameters Name

Type

Description

password

String.


siteId

Long.


userName

String.

The user name of the user.

Soap Request POST /nbr/services HTTP/1.0 Content-Type: text/xml; charset=utf-8 Accept: application/soap+xml, application/dime, multipart/related, text/* User-Agent: Axis/1.2.1 Host: 10.224.57.91:2001 Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 717

XML Listing


39

king pass 400011074

getNBRRecordIdListResponse When the user retrieves the RecordIdList, the RecordId parameter has two possible values: ■

■

NBR - Denotes that the recording being retrieved was created by the NBR system. Upload - Denotes that the recording being retrieved was uploaded to the servers by a user and not created by the NBR system. Table 2-14 • getNBRRecordIdListResponse Parameters

Name

Type

Description

RecordId

{NBR, Upload}

Denotes the recording was uploaded by a user or created by NBR.

SOAP Response HTTP/1.1 200 OK Date: Wed, 10 Dec 2008 08:01:26 GMT Content-Type: text/xml; charset=utf-8 Connection: Close

XML Listing

40


971775672 971775657 971775642 971775582 971775567 971775562 971775557 971775532 971775487


41

42


3 WSDL WSDL Listings NBR File Open Web Service WSDL


43

44


NBR XML Web Service WSDL


45

46



47

48



49

NBR Web Services API 2.3.5 Guide

Recommend Documents