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 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 page 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 first Recording 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 the table are the exposed NBR functions.

NBR APIs:

Name	Page
deleteMeetingXML	Sends a request to the NBR servers to delete a previously saved recording.
deleteNBRStorageFile	This service is used to delete a file in storage.
downloadFile	These functions are used to retrieve a saved file from the NBR servers.
downloadNBRStorageFile	Returns the file for a NBR recording, Meeting XML, or Report XML.
downloadWAVFile	This service is used to retrieve WAV files of meetings.
getMeetingTicket	This ticket identifies the user and allows them to access the NBR service.
getNBRConfIdList	Returns the confIDs for all recorded meetings on the site for each of the following services:
	MC, TC, EC, SC, SaC.
getNBRRecordIdList	This service lists record IDs for a customer's site.
getNBRStorageFile	This service is used to fetch an XML document object of an NBR recording ID.
getSCXML	The service is used to get a report on Support Center.
getStorageAccessTicket	The getStorageAccessTicket function is used to retrieve a ticket that allows access to the
	NBR storage server.

DeleteMeetingXML

Return to NBR APIs

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

deleteMeetingXmlRequest

deleteMeetingXmlRequest Parameters

Name	Type	Description
confID	Long.	Unique identifier for each Webex session.
siteID	Long.	Unique identifier for each Webex site.
ticket	Long.	The ticket for the user's current session.

Http Request:

http://<hostvip>:<port>/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:

   <?xml version="1.0" encoding="UTF-8"?>
    <soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:deleteMeetingXml soapenv:encodingStyle=
       "http://schemas.xmlsoap.org/soap/encoding/"
       xmlns:ns1="nbrXmlService">
       <siteId xsi:type="xsd:long">400009412</siteId>
       <confId xsi:type="xsd:long">4648067</confId>
       <ticket xsi:type="xsd:string">
         OMuVaMerKdMZBwaOL3IsoCyCCaT/KnflDC3AiV6dzqFkyRmyKMUjm9M?
         AnyGpsk4zQSnYbR/OmQjwpB7Hdm8GKvFH90m0PJtFvCAl4EHu/bc=
       </ticket>
      </ns1:deleteMeetingXml>
    </soapenv:Body>
    </soapenv:Envelope>

deleteMeetingXmlResponse

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:
		ul> The siteID is invalid. The confId is invalid. The ticket is invalid.

XML listing:

<?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope?
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ?
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"?
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
      <ns1:deleteMeetingXmlResponse soapenv:encodingStyle=?
      "http://schemas.xmlsoap.org/soap/encoding/"?
      xmlns:ns1="nbrXmlService">
      <ns1:deleteMeetingXmlReturn xsi:type="xsd:string">
      Success
      </ns1:deleteMeetingXmlReturn>
      </ns1:deleteMeetingXmlResponse>
    </soapenv:Body>
  </soapenv:Envelope>

deleteNBRStorageFile

Return to NBR APIs

This service is used to delete a file in storage.

deleteNBRStorageFileRequest

deleteNBRStorageFileRequest Parameters

Name	Type	Description
confID	Long.	Unique identifier for each Webex conference.
recordID	Long.	Unique identifier for each recording.
siteID	Long.	Unique identifier for each Webex site.
ticket	Long.	Ticket used to validate authentication and authorization.

Soap Request:

POST /nbr/services/NBRStorageService 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:7001
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: ""
Content-Length: 651

XML Listing:

  <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:deleteNBRStorageFile
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
    <siteId xsi:type="xsd:long">400011074</siteId>
    <confId xsi:type="xsd:long">971775567</confId>
    <recordId xsi:type="xsd:long">971775487</recordId>
        <ticket xsi:type="xsd:string">
          64cea870fcb8b7e82f4cfea0a011b2b9
        </ticket>
      </ns1:deleteNBRStorageFile>
    </soapenv:Body>
  </soapenv:Envelope>

deleteNBRStorageFileResponse:

deleteNBRStorageFileResponse Parameters

Name	Type	Description
deleteNBRStorageFile	Message.	Indicates if the deletion was a success or failure.

Soap Response:

HTTP/1.1 200 OK
Date: Wed, 28 Apr 2010 10:42:27 GMT
Content-Type: text/xml; charset=utf-8
Connection: Close

XML Listing:

  <?xml version="1.0" encoding="utf-8"?>:
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">:
    <soapenv:Body>:
      <ns1:deleteNBRStorageFileResponse
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">:
        <deleteNBRStorageFileReturn xsi:type="xsd:string">:
          Success
        </deleteNBRStorageFileReturn>:
      </ns1:deleteNBRStorageFileResponse>:
    </soapenv:Body>:
  </soapenv:Envelope>:

DownloadFile

Return to NBR APIs

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. Please refer WSDL for

detailed information

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()),

  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

downloadFileRequest Parameters

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 two files, the first one is the TXT file that includes the ARF file's name and size, the second one is the NBR recording ARF file content.

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:

   <?xml version="1.0" encoding="UTF8"?>
  
  <wsdl:definitions
    targetNamespace="http://localhost:7001/nbr/services/NBRFileOpenService"
    xmlns:impl="http://localhost:7001/nbr/services/NBRFileOpenService"
    xmlns:intf="http://localhost:7001/nbr/services/NBRFileOpenService"
    xmlns:apachesoap="http://xml.apache.org/xmlsoap"
    xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:tns1="NBRFileOpenService"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns="http://schemas.xmlsoap.org/wsdl/">
  <wsdl:types>
    <schema xmlns="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://localhost:7001/nbr/services/NBRFileOpenService">
      <import namespace="NBRFileOpenService"/>
      <import
        namespace="http://schemas.xmlsoap.org/soap/encoding/"/>
      <complexType name="ArrayOf_tns1_DataHandler">
        <complexContent>
          <restriction base="soapenc:Array">
            <attribute ref="soapenc:arrayType"
  wsdl:arrayType="tns1:DataHandler[]"/>
          </restriction>
        </complexContent>
      </complexType>
    Þ/schema>
  </wsdl:types>
    <wsdl:message name="downloadFileResponse">
    <wsdl:part name="downloadFileReturn"
      type="impl:ArrayOf_tns1_DataHandler"/>
    </wsdl:message>
    <wsdl:message name="downloadFileRequest">
      <wsdl:part name="siteId" type="xsd:long"/>
      <wsdl:part name="serviceName" type="xsd:string"/>
      <wsdl:part name="userName" type="xsd:string"/>
      <wsdl:part name="password" type="xsd:string"/>
      <wsdl:part name="recordId" type="xsd:long"/>
    </wsdl:message>
    <wsdl:portType name="NBRFileOpenService">
      <wsdl:operation name="downloadFile" parameterOrder="siteId
        serviceName userName password recordId">
          <wsdl:input name="downloadFileRequest"
            message="impl:downloadFileRequest"/>
          <wsdl:output name="downloadFileResponse"
            message="impl:downloadFileResponse"/>
      </wsdl:operation>
     </wsdl:portType>
    <wsdl:binding name="NBRFileOpenServiceSoapBinding"
      type="impl:NBRFileOpenService">
    <wsdlsoap:binding style="rpc"
     transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="downloadFile">
      <wsdlsoap:operation soapAction=""/>
      <wsdl:input name="downloadFileRequest">
        <wsdlsoap:body use="encoded"
          encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
         namespace="http://wbxservice.nbr.webservice.webex.com"/>
      </wsdl:input>
      <wsdl:output name="downloadFileResponse">
        <wsdlsoap:body use="encoded"
  encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  namespace="http://localhost:7001/nbr/services/NBRFileOpenService"/>
        </wsdl:output>
      </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="NBRFileOpenServiceService">
      <wsdl:port name="NBRFileOpenService"
        binding="impl:NBRFileOpenServiceSoapBinding">
        <wsdlsoap:address
  location="http://localhost:7001/nbr/services/NBRFileOpenService"/>
     </wsdl:port>
    </wsdl:service>
  </wsdl:definitions>

DownloadNBRStorageFile

Return to NBR APIs

Returns the file for a NBR recording, Meeting XML, or Report XML.

downloadNBRStorageFileRequest

downloadNBRStorageFileRequest Parameters

Name	Type	Description
recordID	Long.	Unique identifier for each Webex recording.
siteID	Long.	Unique identifier for each Webex site.
ticket	String.	Ticket used to validate authentication and authorization.

Soap Request:

POST /nbr/services/NBRStorageService 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:7001
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: ""
Content-Length: 605

XML Listing:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <ns1:downloadNBRStorageFile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="NBRStorageService">
      <siteId xsi:type="xsd:long">400011074</siteId>
      <recordId xsi:type="xsd:long">971775487</recordId>
      <ticket
xsi:type="xsd:string">64cea870fcb8b7e82f4cfea0a011b2b9</ticket>
   </ns1:downloadNBRStorageFile>
  </soapenv:Body>
</soapenv:Envelope>

downloadNBRStorageFileResponse

downloadNBRStorageFileResponse Parameters

Name	Type	Description
downloadNBR	DataHandler[]	Unique identifier for each Webex recording.
StorageFile

Soap with attachment response. The following error messages are returned if an exception is thrown:

The ticket is invalid.
The recording you are looking for does not exist or is no longer available.
Download pool is busy, Please try again later.

Note: Two files will be listed, in which one is a text file that includes ARF/XML file name and file size and a flag which indicates the file is an encrypted ARF/XML or plain text ARF/XML.

Soap Response:

HTTP/1.1 200 OK
 Date: Wed, 28 Apr 2010 10:36:46 GMT
 Content-Type: multipart/related; type="text/xml";
 start="<92AE6C82DBBD12B997D03C502A058511>
   "; boundary="----=_Part_0_23877553.1272451006846"
   Connection: Close
   ------=_Part_0_23877553.1272451006846
   Content-Type: text/xml; charset=UTF-8
   Content-Transfer-Encoding: binary
   Content-Id: <92AE6C82DBBD12B997D03C502A058511>
 <?xml version="1.0" encoding="utf-8"?>
 <soapenv:Envelope
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
     <ns1:downloadNBRStorageFileResponse
 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
 xmlns:ns1="NBRStorageService">
       <downloadNBRStorageFileReturn
 soapenc:arrayType="ns1:DataHandler[2]" xsi:type="soapenc:Array"
 xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
         <downloadNBRStorageFileReturn
 href="cid:B0A8EBE4A6E3C12D01C9AA96201968E5"
 xsi:type="ns1:DataHandler"/>
           <downloadNBRStorageFileReturn
 href="cid:6E5E9F315D7E46BF51A3729E71BD10D3"
 xsi:type="ns1:DataHandler"/>
         </downloadNBRStorageFileReturn>
       </ns1:downloadNBRStorageFileResponse>
     </soapenv:Body>
   </soapenv:Envelope>
 ------=_Part_0_23877553.1272451006846
 Content-Type: application/octet-stream
 Content-Transfer-Encoding: binary
 Content-Id: <B0A8EBE4A6E3C12D01C9AA96201968E5>
   a.arf
   188607
   ------=_Part_0_23877553.1272451006846
   Content-Type: application/octet-stream
   Content-Transfer-Encoding: binary
   Content-Id: <6E5E9F315D7E46BF51A3729E71BD10D3>
 .............

DownloadWAVFile

Return to NBR APIs

This service is used to retrieve WAV files of meetings.

downloadWAVFileRequest

downloadWAVFileRequest Parameters

Name	Type	Description
confID	Long.	Unique identifier for each Webex conference.
siteID	Long.	Unique identifier for each Webex site.
ticket	String.	Ticket used to validate authentication and authorization.

Soap Request:

   POST /nbr/services/NBRStorageService 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:7001
   Cache-Control: no-cache
   POST /nbr/services/NBRStorageService 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:7001
   Cache-Control: no-cache
   Pragma: no-cache
   SOAPAction: ""
   Content-Length: 605

XML Listing:

  <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
    <ns1:downloadWAVFile
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
      <siteId xsi:type="xsd:long">400011074</siteId>
      <confId xsi:type="xsd:long">971775487</recordId>
      <ticket
  xsi:type="xsd:string">64cea870fcb8b7e82f4cfea0a011b2b9</ticket>
   </ns1:downloadNBRStorageFile>
  </soapenv:Body>
</soapenv:Envelope>

downloadWAVFileResponse

downloadWAVFileResponse Parameters

Name	Type	Description
downloadWAVFile	DataHandler[]	Soap with attachment response.
		The following error messages are returned if an exception is thrown:
		* The ticket is invalid.
		* Cannot find the WAV file in the NBR storage.

Note: When more than two files are listed, the first one is a text file that includes the following information: * The first line is the name of first WAV file in the following format: --.wav * Each line of the text file contains the name of a separate WAV file. WSS controls the max download thread count while a Webex admin can configure the max download thread using the following: * wbxservice.properties.webservice.MaxDownloadThreadCount item.

Soap Response:

HTTP/1.1 200 OK
Date: Wed, 28 Apr 2010 10:36:46 GMT
  Content-Type: multipart/related; type="text/xml";
  start="<92AE6C82DBBD12B997D03C502A058511>
    "; boundary="----=_Part_0_23877553.1272451006846"
    Connection: Close
    ------=_Part_0_23877553.1272451006846
    Content-Type: text/xml; charset=UTF-8
    Content-Transfer-Encoding: binary
    Content-Id: <92AE6C82DBBD12B997D03C502A058511>
  <?xml version="1.0" encoding="utf-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:downloadWAVFileResponse
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
        <downloadWAVFileReturn
  soapenc:arrayType="ns1:DataHandler[2]" xsi:type="soapenc:Array"
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
        <downloadWAVFileReturn
  href="cid:B0A8EBE4A6E3C12D01C9AA96201968E5"
  xsi:type="ns1:DataHandler"/>
          <downloadWAVFileReturn
  href="cid:6E5E9F315D7E46BF51A3729E71BD10D3"
  xsi:type="ns1:DataHandler"/>
        </downloadWAVFileReturn>
      </ns1:downloadWAVFileResponse>
    </soapenv:Body>
  </soapenv:Envelope>
  ------=_Part_0_23877553.1272451006846
  Content-Type: application/octet-stream
  Content-Transfer-Encoding: binary
  Content-Id: <B0A8EBE4A6E3C12D01C9AA96201968E5>
    <HOST User Name>-<Meeting ID>-<Number of WAV>.wav
    188607
    ------=_Part_0_23877553.1272451006846
    Content-Type: application/octet-stream
    Content-Transfer-Encoding: binary
    Content-Id: <6E5E9F315D7E46BF51A3729E71BD10D3>
  .............

GetMeetingTicket

Return to NBR APIs

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

getMeetingTicketRequest Parameters

Name	Type	Description
password	String.	Webex user password.
service	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 user.

Http Request:

http://<hostvip>:<port>/nbr/services/nbrXmlService?method=getMeeting
Ticket&siteId=400009412&username=hostid&password=hostpassword&service=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:

<?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getMeetingTicket soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:ns1="nbrXmlService">
        <siteId xsi:type="xsd:long">400009412</siteId>
        <username xsi:type="xsd:string">hostid</username>
        <password xsi:type="xsd:string">hostpassword</password>
        <service xsi:type="xsd:string">MC</service>
      </ns1:getMeetingTicket>
    </soapenv:Body>
  </soapenv:Envelope>

getMeetingTicketResponse

getMeetingTicketResponse Parameters

Name	**Type	Description
getMeetingTicket	String.	Returns the requested ticket.
Return		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:

 <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope?
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"?
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"?
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
    <ns1:getMeetingTicketResponse soapenv:encodingStyle=?
      "http://schemas.xmlsoap.org/soap/encoding/"?
      xmlns:ns1="nbrXmlService">
      <ns1:getMeetingTicketReturn xsi:type="xsd:string">
          IK4gi74h1BfKLYnj6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eX?
          jJW54B8EbQSnYbR/OmQjwpB7Hdm8GKvIPZbQmouAugskje76jmM4=
        </ns1:getMeetingTicketReturn>
      </ns1:getMeetingTicketResponse>
    </soapenv:Body>
  </soapenv:Envelope>

GetMeetingXML

Return to NBR APIs

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:

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified">
    <xs:element name="FileDump">
      <xs:complexType>
        <xs:sequence>
          <xs:element ref="MeetingDetail"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  <xs:element name="Choice">
    <xs:complexType mixed="true">
      <xs:attribute name="is_correct" use="required">
    <xs:simpleType>
      <xs:restriction base="xs:boolean"/>
    </xs:simpleType>
  </xs:attribute>
  <xs:attribute name="check_count" use="required">
    <xs:simpleType>
      <xs:restriction base="xs:string">
      </xs:restriction>
    </xs:simpleType>
  </xs:attribute>
    <xs:attribute name="vote_users" type="xs:string"
  use="required"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="Content">
    <xs:complexType mixed="true">
      <xs:choice minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="Item"/>
      </xs:choice>
      <xs:attribute name="user_count">
      <xs:simpleType>
        <xs:restriction base="xs:string">
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="voted_user_count">
      <xs:simpleType>
        <xs:restriction base="xs:string">
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
   <xs:attribute name="question_count">
        <xs:simpleType>
          <xs:restriction base="xs:integer">
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="CorporateEmailID">
      <xs:simpleType>
      <xs:restriction base="xs:string">
      </xs:restriction>
      </xs:simpleType>
    </xs:element>
  <xs:element name="DateTimeUTC">
    <xs:simpleType>
  </xs:element>
  <xs:element name="EndTimeUTC">
    <xs:simpleType>
      <xs:restriction base="xs:string">
      </xs:restriction>
     </xs:simpleType>
  </xs:element>
  <xs:element name="Item">
    <xs:complexType mixed="true">
      <xs:choice minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="Question"/>
        <xs:element ref="Choice"/>
      </xs:choice>
      <xs:attribute name="ItemID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="vote_users" type="xs:string"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="JoinDateTimeUTC">
    <xs:simpleType>
      <xs:restriction base="xs:string">
      </xs:restriction>
    </xs:simpleType>
  </xs:element>
  <xs:element name="LeaveDateTimeUTC">
    <xs:simpleType>
      <xs:restriction base="xs:string">
      </xs:restriction>
    </xs:simpleType>
  </xs:element>
  <xs:element name="LoginName">
    <xs:complexType mixed="true">
      <xs:attribute name="UID" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="MeetingDetail">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="ModeratorName"/>
        <xs:element ref="ModeratorLogin"/>
        <xs:element ref="MeetingName"/>
        <xs:element ref="StartTimeUTC"/>
        <xs:element ref="EndTimeUTC"/>
        <xs:element ref="ModeratorEmail"/>
        <xs:element ref="ParticipantList"/>
        <xs:element ref="MeetingSession" maxOccurs="3"/>
      </xs:sequence>
      <xs:attribute name="id" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:int"/>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="MeetingName">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="MeetingSession">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Message" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="type" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="chat"/>
          <xs:enumeration value="polling"/>
          <xs:enumeration value="qa"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
  </xs:element>
  <xs:element name="Message">
    <xs:complexType mixed="true">
      <xs:choice minOccurs="0" maxOccurs="unbounded">
      <xs:element ref="LoginName"/>
      <xs:element ref="DateTimeUTC"/>
      <xs:element ref="TargetName"/>
      <xs:element ref="StartTimeUTC"/>
      <xs:element ref="EndTimeUTC"/>
      <xs:element ref="Content"/>
      <xs:element ref="Message"/>
      </xs:choice>
  <xs:attribute name="type" use="required">
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="deferred"/>
        <xs:enumeration value="dismissed"/>
        <xs:enumeration value="private"/>
        <xs:enumeration value="public"/>
      </xs:restriction>
    </xs:simpleType>
  </xs:attribute>
  <xs:attribute name="ind" type="xs:string" use="required"/>
  <xs:attribute name="MessageID">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:attribute>
  <xs:attribute name="Priority">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="High"/>
           <xs:enumeration value="Low"/>
          <xs:enumeration value="Medium"/>
          <xs:enumeration value="NA"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
  </xs:element>
  <xs:element name="ModeratorEmail">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="ModeratorLogin">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="ModeratorName">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="Participant">
    <xs:complexType>
      <xs:sequence>
      <xs:element ref="LoginName"/>
      <xs:element ref="JoinDateTimeUTC"/>
      <xs:element ref="LeaveDateTimeUTC"/>
      <xs:element ref="CorporateEmailID"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ParticipantList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Participant" maxOccurs="unbounded"/>
      </xs:sequence>
  <xs:attribute name="list" use="required">
      <xs:simpleType>
           <xs:restriction base="xs:integer">
           </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="Question">
    <xs:complexType mixed="true">
      <xs:attribute name="type" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
             <xs:enumeration value="multiple answer"/>
             <xs:enumeration value="short answer"/>
             <xs:enumeration value="single answer"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="choice_count" use="required">
         <xs:simpleType>
           <xs:restriction base="xs:integer"/>
       </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="no_check_count" use="required">
         <xs:simpleType>
           <xs:restriction base="xs:string">
           </xs:restriction>
         </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="StartTimeUTC">
     <xs:simpleType>
       <xs:restriction base="xs:string">
       </xs:restriction>
     </xs:simpleType>
  </xs:element>
  <xs:element name="TargetName">
     <xs:simpleType>
        <xs:restriction base="xs:string">
        </xs:restriction>
     </xs:simpleType>
    </xs:element>
  </xs:schema>

getMeetingXmlRequest

getMeetingXmlRequest Parameters

Name	Type	Description
confId	Long.	Unique identifier for each Webex session.
siteId	Long.	Unique identifier for each Webex site.
	String.	The ticket for the user's current session.

Http Request:

http://<hostvip>:<port>/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
32 Cisco Webex Network-Based Recording API
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

XML Listing:

  <?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getMeetingXml soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:ns1="nbrXmlService">
      <siteId xsi:type="xsd:long">400009412</siteId>
      <confId xsi:type="xsd:long">998923752</confId>
        <ticket xsi:type="xsd:string">
          IK4gi74h1BfKLYnj6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eX?
          jJW54B8EbQSnYbR/OmQjwpB7Hdm8GKvIPZbQmouAugskje76jmM4=
        </ticket>
       </ns1:getMeetingXml>
    </soapenv:Body>
  </soapenv:Envelope>

getMeetingXmlResponse

The following figures explain part 1, part 2, and part 3 of getMeetingXmlResponse

The information below provides a list of return parameters and their value. Table 2-16 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.

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.
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.

getMeetingXmlResponse Return Values with Attributes

Name	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.
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.

   <soapenv:Envelope?
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"?
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"?
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getMeetingXmlResponse soapenv:encodingStyle=?
      "http://schemas.xmlsoap.org/soap/encoding/"?
      xmlns:ns1="nbrXmlService">
      <getMeetingXmlReturn href="#id0"/>
    </ns1:getMeetingXmlResponse>
    <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle=?
  "http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:Document"
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns2="http://xml.apache.org/xml-soap">
      <FileDump>
        <MeetingDetail id="998923752">
          <ModeratorName>karl qin</ModeratorName>
          <ModeratorLogin></ModeratorLogin>
          <MeetingName>karl-1016</MeetingName>
          <StartTimeUTC>2321961344</StartTimeUTC>
          <EndTimeUTC>2322540282</EndTimeUTC>
          <ModeratorEmail>karl@hf.webex.com</ModeratorEmail>
          <ParticipantList list="2">
            <Participant>
              <LoginName NodeID="100">Your name</LoginName>
              <JoinDateTimeUTC>1160980889</JoinDateTimeUTC>
              <LeaveDateTimeUTC>1161559826</LeaveDateTimeUTC>
          <CorporateEmailID></CorporateEmailID>
            </Participant>
            <Participant>
              <LoginName NodeID="101">karl qin</LoginName>
              <JoinDateTimeUTC>1160980889</JoinDateTimeUTC>
        <LeaveDateTimeUTC>1161559826</LeaveDateTimeUTC>
              <CorporateEmailID>
                karl@hf.webex.com
          </CorporateEmailID>
        </Participant>
      </ParticipantList>
      <MeetingSession type="chat">
        <Message ind="" type="public">
          <LoginName NodeID="101">karl qin</LoginName>
          <DateTimeUTC>1161208868</DateTimeUTC>
          <TargetName GroupID="10">
            All Participants
          </TargetName>
          <Content>
            fghdgfsgfdsfgsdfg das fasdf as
          </Content>
        </Message>
        <Message ind="" type="public">
          <LoginName NodeID="101">karl qin</LoginName>
          <DateTimeUTC>1161213738</DateTimeUTC>
          <TargetName GroupID="11">
            All Attendees
          </TargetName>
          <Content>Your content here</Content>
        </Message>
      <Message ind="" type="public">
        <LoginName NodeID="101">karl qin</LoginName>
        <DateTimeUTC>1161223922</DateTimeUTC>
        <TargetName GroupID="12">
          Host & Presenter
        </TargetName>
        <Content>Your content here</Content>
      </Message>
    </MeetingSession>
    <MeetingSession type="polling">
      <Message ind="" type="public" MessageID="1000">
        <StartTimeUTC>1161338143</StartTimeUTC>
   <EndTimeUTC>1161349586</EndTimeUTC>
        <Content question_count="3" user_count="2"?
           voted_user_count="2">
          <Item ItemID="100001" vote_users="100">
            <Question type="multiple answer"?
             choice_count="2" no_check_count="1">
               Question goes here
            </Question>
            <Choice check_count="1" cid="0" is_correct="0"?
              vote_users="">sadf</Choice>
            <Choice check_count="0" cid="1" is_correct="1"?
              vote_users="100">asd</Choice>
          </Item>
          <Item ItemID="100002" vote_users="100,101">
            <Question type="multiple answer"?
              choice_count="2" no_check_count="0">
                Question goes here
            </Question>
            <Choice check_count="0" cid="0" is_correct="0"?
               vote_users="">fdasf</Choice>
            <Choice check_count="1" cid="1" is_correct="0"?
               vote_users="100">sdf</Choice>
            <Choice check_count="0" cid="2" is_correct="0"?
               vote_users="">asddf</Choice>
            <Choice check_count="0" cid="3" is_correct="1"?
               vote_users="">asdf</Choice>
            <Choice check_count="0" cid="4" is_correct="0"?
               vote_users="">das</Choice>
            <Choice check_count="2" cid="5" is_correct="1"?
               vote_users="100,101">f</Choice>
            <Choice check_count="0" cid="6" is_correct="0"?
               vote_users="">asdfasdf</Choice>
            <Choice check_count="1" cid="7" is_correct="0"?
               vote_users="101">asddf</Choice>
            <Choice check_count="0" cid="8" is_correct="0" ?
                vote_users="">sda</Choice>
            <Choice check_count="0" cid="9" is_correct="0"?
                 vote_users="">f</Choice>
          </Item>
          <Item ItemID="100003" vote_users="100">
            <Question type="multiple answer" ?
               choice_count="2" no_check_count="2">
              Question goes here
            </Question>
            <Choice check_count="0" cid="0" is_correct="1">?
            asdf</Choice>
            <Choice check_count="0" cid="1" is_correct="1">?
           asd</Choice>
            <Choice check_count="0" cid="2" is_correct="1">?
            dfasdfas</Choice>
            <Choice check_count="0" cid="3" is_correct="1">?
            dfasdf</Choice>
            <Choice check_count="0" cid="4" is_correct="1">?
            asdf</Choice>
           </Item>
         </Content>
       </Message>
     </MeetingSession>
     <MeetingSession type="qa">
       <Message ind="question" type="public" Priority="High">
         <LoginName NodeID="100">Your name</LoginName>
         <DateTimeUTC>1161105322</DateTimeUTC>
         <Content>sdfsdfasdfasfsdfasdfsdf</Content>
         <TargetName NodeID="101">karl qin</TargetName>
         <Message ind="answer" type="">
           <LoginName>Email address</LoginName>
           <DateTimeUTC>1161105322</DateTimeUTC>
           <Content>Your content here</Content>
         </Message>
       </Message>
       <Message ind="question" type="private" Priority="Low">
           <LoginName>Your name</LoginName>
           <DateTimeUTC>1161105322</DateTimeUTC>
           <Content>3453534534</Content>
                 <TargetName NodeID="101">karl qin</TargetName>
             <Message ind="answer" type="">
               <LoginName>Email address</LoginName>
               <DateTimeUTC>1161105322</DateTimeUTC>
               <Content>Your content here</Content>
               </Message>
             </Message>
           </MeetingSession>
          </MeetingDetail>
        </FileDump>
    </multiRef>
  </soapenv:Body>
  </soapenv:Envelope>

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

The siteId is invalid.
The confId is invalid
The ticket is invalid.

GetNBRConfIdList

Return to NBR APIs

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 first Recording function (see the Cisco Webex XML API Reference Guide) returns additional recording information and allows filtering by date range and host.

getNBRConfIdListRequest

getNBRConfIdListRequest Parameters

Name	Type	Description
siteId	Long.	Unique identifier for each Webex site.
ticket	String.	The ticket for the user's current session.

 http://<hostvip>:<port>/nbr/services/nbrXmlService?method=getMeeting
 Xml&siteId=400009412&confId=998923752&ticket=IK4gi74h1BfKLY+
 j6WyGbCnlDtYhzpZEMSdgOCGJc/Mcjh1hkl472eXjJW54B8EbQSnYbR/OmQjwpB7Hdm8
 GKvIPZbQmouAugskje76jmM4=

XML Request:

  <?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getNBRConfIdList
        soapenv:encodingStyle=
          "http://schemas.xmlsoap.org/soap/encoding/"
        xmlns:ns1="nbrXmlService">
        <siteId href="#id0"/>
        <ticket xsi:type="xsd:string">
          T6GJfsFPttOvVCFCzAEsOWZDUqmnScawEfc5aghK5MJTgtJyYrEMZTT3?
          4L9E2L+SZ4ZUVTNv2FlEk9/khkrFSvIPZbQmouAugskje76jmM4=
        </ticket>
        </ns1:getNBRConfIdList>
        <multiRef id="id0" soapenc:root="0"
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xsi:type="xsd:long" xmlns:soapenc=
          "http://schemas.xmlsoap.org/soap/encoding/">
            400011074
          </multiRef>
      </soapenv:Body>
  </soapenv:Envelope>

getNBRConfIdListResponse

getNBRConfIdListResponse Parameters

Name	Type	Description
getNBRConfIdListReturn	XML Document	Returns the confID list for the Webex service: MC, TC, EC, SaC, SC.

XML Listing:

  <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope?
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"?
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"?
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <ns1:getNBRConfIdListResponse?
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"?
  xmlns:ns1="nbrXmlService">
      <ns1:getNBRConfIdListReturn href="#id0"/>
    </ns1:getNBRConfIdListResponse>
    <multiRef id="id0" soapenc:root="0"?
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"?
  xsi:type="ns2:Document"?
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"?
  xmlns:ns2="http://xml.apache.org/xml-soap">
      <NBRConfIDList>
        <ConfID>258287597</ConfID>
        <ConfID>258287598</ConfID>
        <ConfID>1036379567</ConfID>
        <ConfID>258270170</ConfID>
        <ConfID>258209834</ConfID>
        <ConfID>258153118</ConfID>
        <ConfID>258270145</ConfID>
        <ConfID>258128714</ConfID>
        <ConfID>258270149</ConfID>
        <ConfID>258270148</ConfID>
        <ConfID>258270139</ConfID>
        <ConfID>258153179</ConfID>
        <ConfID>258153220</ConfID>
        <ConfID>258150587</ConfID>
        <ConfID>258269590</ConfID>
      </NBRConfIDList>
    </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

GetNBRRecoredIdList

Return to NBR APIs

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

getNBRRecordIdListRequest

getNBRRecordIdListRequest Parameters

Name	Type	Description
password	String.	Webex user password.
siteID	Long.	Unique identifier for each Webex site.
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:

  <?xml version="1.0" encoding="UTF-8"?>
   <soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
    <ns1:getNBRRecordIdList
      soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
      xmlns:ns1="nbrXmlService">
      <siteId href="#id0"/>
      <userName xsi:type="xsd:string">king</userName>
      <password xsi:type="xsd:string">pass</password>
      </ns1:getNBRRecordIdList>
      <multiRef id="id0" soapenc:root="0"
      soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
      xsi:type="xsd:long"
      xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
         400011074
      </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

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

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:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope?
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"?
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"?
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getNBRRecordIdListResponse?
        soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"?
        xmlns:ns1="nbrXmlService">
        <ns1:getNBRRecordIdListReturn href="#id0"/>
      </ns1:getNBRRecordIdListResponse>
      <multiRef id="id0" soapenc:root="0"?
        soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"?
        xsi:type="ns2:Document"?
        xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"?
        xmlns:ns2="http://xml.apache.org/xml-soap">
        <RecordIdList>
          <RecordId type="NBR">971775672</RecordId>
          <RecordId type="NBR">971775657</RecordId>
          <RecordId type="Upload">971775642</RecordId>
          <RecordId type="Upload">971775582</RecordId>
          <RecordId type="NBR">971775567</RecordId>
          <RecordId type="Upload">971775562</RecordId>
          <RecordId type="Upload">971775557</RecordId>
          <RecordId type="NBR">971775532</RecordId>
          <RecordId type="NBR">971775487</RecordId>
        </RecordIdList>
      </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

GetNBRStorageFile

Return to NBR APIs

This service is used to fetch an XML document object of an NBR recording ID. The schema for getNBRStorageFile follows:

  <?xml version="1.0" encoding="utf-8"?>
  <xs:schema attributeFormDefault="unqualified"
  elementFormDefault="qualified"
  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="NBRMaterialList">
      <xs:complexType>
        <xs:sequence>
          <xs:element maxOccurs="unbounded" name="Meeting">
            <xs:complexType>
              <xs:sequence>
                <xs:element maxOccurs="unbounded" name="RecordId">
                  <xs:complexType>
                    <xs:simpleContent>
                      <xs:extension base="xs:unsignedInt">
                        <xs:attribute name="type"
  type="xs:string" use="required" />
                      </xs:extension>
                    </xs:simpleContent>
                  </xs:complexType>
                </xs:element>
              </xs:sequence>
            <xs:attribute name="confId" type="xs:unsignedInt"
   use="required" />
            </xs:complexType>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:schema>

getNBRStorageFileRequest

getNBRStorageFileRequest Parameters

Name	Type	Description
confID	Long.	Unique identifier for each Webex conference. If set to 0, then use the site level record ID.
fileType	String.	Contains the file type. Valid values are: SacReport, NBR, MeetingXML, or null.
		If the value is null, no file type limitation is created.
fromDate	Date	First date used to look for documents. If this is null, then there is no start date limitation.
SiteId	Long.	Unique identifier for each Webex site.
ticket	String.	Ticket used to validate authentication and authorization.
toDate	Date	Latest date to look for documents. If this is null, then there is no end date limitation.

SOAP Request

POST /nbr/services/NBRStorageService 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: 10.224.91.216:2001
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: ""
Content-Length: 856

XML Listing:

  <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getNBRStorageFile
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
      <siteId xsi:type="xsd:long">400011074</siteId>
      <confId xsi:type="xsd:long">258759789</confId>
      <ticket xsi:type="xsd:string">sfNFdk7uazM++
  s0y7417A9UGKE3dmhiViiXEgCWKScb4IPu1wPDka7VdtgnKzB+
  5Z4ZUVTNv2FlEk9/khkrFShiq2g4e/8nvoFH3gL9thlo=</ticket>
        <fileType xsi:type="xsd:string"></fileType>
        <fromDate xsi:type="xsd:dateTime">
          2010-10-10T00:00:00.000Z
        </fromDate>
        <toDate xsi:type="xsd:dateTime">
          2011-10-10T00:00:00.000Z
        </toDate>
      </ns1:getNBRStorageFile>
    </soapenv:Body>
  </soapenv:Envelope>

getNBRStorageFileResponse

getNBRStorageFileResponse Parameters

Name	Type	Description
getNBRStorageFile	Document	XML document of record ID.
		The following error messages are thrown if an exception is encountered:
		* The ticket is invalid
		* Invalidate fileType
		* getNBRStorage Build XML failed

SOAP Response:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: text/xml;charset=utf-8
Date: Wed, 23 Mar 2011 06:52:14 GMT
Connection: close

XML Listing:

  <?xml version="1.0" encoding="utf-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getNBRStorageFileResponse
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
        <getNBRStorageFileReturn href="#id0"/>
          </ns1:getNBRStorageFileResponse>
        <multiRef id="id0" soapenc:root="0"
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xsi:type="ns2:Document"
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns2="NBRStorageService">
        <NBRMaterialList>
           <Meeting confId="258759789" meetingKey="14572209">
             <RecordId type="NBR">971820432</RecordId>
             <RecordId type="MeetingXML">971820442</RecordId>
           </Meeting>
        </NBRMaterialList>
       </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

GetSCXML

Return to NBR APIs

The service is used to get a report on Support Center. It uses the following schema:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--W3C Schema generated by XMLSpy v2005 rel. 3 U
  (http://www.altova.com)-->
  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified">
    <xs:import/>
      <xs:element name="Catalog">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="Item" maxOccurs="unbounded"/>
          </xs:sequence>
          <xs:attribute name="name" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string"/>
            </xs:simpleType>
          </xs:attribute>
        </xs:complexType>
  </xs:element>
  <xs:element name="Content">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="DateTimeUTC">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>
  <xs:element name="Item">
      <xs:complexType>
        <xs:sequence>
          <xs:element ref="Name"/>
          <xs:element ref="Value" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
    <xs:element name="LoginName">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
    </xs:element>
  <xs:element name="MeetingSession">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Message" minOccurs="0"
  maxOccurs="unbounded"/>
      <xs:element ref="SystemInfo" minOccurs="0"
  maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="type" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="chat"/>
        </xs:restriction>
      </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="format" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="UTF-8"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="Message">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="LoginName"/>
        <xs:element ref="DateTimeUTC"/>
        <xs:element ref="TargetName"/>
        <xs:element ref="Content"/>
      </xs:sequence>
  <xs:attribute name="type" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
             <xs:enumeration value="public"/>
            <xs:enumeration value="private"/>
         </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="ind" type="xs:string" use="required"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="Name">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
  </xs:element>
  <xs:element name="SystemInfo">
      <xs:complexType>
          <xs:sequence>
            <xs:element ref="UserName"/>
            <xs:element ref="Catalog" maxOccurs="unbounded"/>
          </xs:sequence>
      </xs:complexType>
  </xs:element>
  <xs:element name="TargetName">
      <xs:simpleType>
          <xs:restriction base="xs:string"/>
      </xs:simpleType>
  </xs:element>
    <xs:element name="UserName">
      <xs:simpleType>
        <xs:restriction base="xs:string"/>
      </xs:simpleType>
    </xs:element>
    <xs:element name="Value" type="xs:string"/>
  </xs:schema>

getSCXMLRequest

getSCXMLRequest Parameters

Name	Type	Description
confId	Long.	Unique identifier for each Webex conference.
siteId	Long.	Unique identifier for each Webex site.
ticket	String.	Ticket used to validate authentication and authorization.

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.4
Host: 10.224.91.216:2001
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: ""
Content-Length: 971

XML Listing:

  <?xml version="1.0" encoding="utf-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getSCXmlResponse
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="nbrXmlService">
        <getSCXmlReturn href="#id0"/>
      </ns1:getSCXmlResponse>
      <multiRef id="id0" soapenc:root="0"
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xsi:type="ns2:Document"
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns2="nbrXmlService">
        <MeetingSession type="chat" encoding="UTF-8">
          <Message ind="" type="public">
            <LoginName UID="-1690347711">sdf sdfsa</LoginName>
            <DateTimeUTC>1285565935278</DateTimeUTC>
            <TargetName GroupID="15">All Participants</TargetName>
            <Content>asdfsadfsaf</Content>
          </Message>
          <Message ind="" type="public">
            <LoginName UID="-1690347711">sdf sdfsa</LoginName>
            <DateTimeUTC>1285565936918</DateTimeUTC>
            <TargetName GroupID="15">All Participants</TargetName>
            <Content>sadfsadfsa</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285565964962</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>king jin gathers system information</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285565965284</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>
              executing the system information 'System Summary'
            </Content>
          </Message>
          <SystemInfo ver="T27">
            <UserName>sdf sdfsa</UserName>
            <Catalog name="System Summary">
  System Name: KING-2163{*}System Type: X86-based PC{*}System
  Manufacturer: System manufacturer{*}System Model: Not
  Available{*}System Domain: hfwbx.hf.webex.com{*}User Name:
  HFWBX\king{*}Number of Processors: 1{*}Total Physical Memory: 3583
  MB{*}Total Virtual Memory: 856 MB{*}Manufacturer:
  GenuineIntel{*}Model: Intel Pentium III Xeon
  processor{*}Architecture: x86{*}Speed: 2.7 GHz{*}CPU Status: Unknown
  {*}MAX Speed: 2.7 GHz{*}WMI Status : True{*}WMI Versions:
  2600.0000{*}Available Physical Memory: 1734 MB{*}Available Virtual
  Memory: 2006 MB{*}Boot Time: 09-27-2010 00:35 AM{*}Page File Size:
  2046 MB{*}Page File: C:\pagefile.sys{*}Locale: United
  States{*}Timezone: Morocco Standard Time{*}
            </Catalog>
            <Catalog name="BIOS">BIOS Name: BIOS Date: 08/26/09
  v20:46:40 Ver: 08.00.12{*}BIOS Version: A_M_I_ - 8000926{*}BIOS Date:
  2009-08-26{*}BIOS Language: en|US|iso8859-1{*}BIOS Description: BIOS
  Date: 08/26/09 20:46:40 Ver: 08.00.12{*}BIOS Manufacturer: American
  Megatrends Inc.{*}BIOS Status: OK{*}
            </Catalog>
            <Catalog name="Storage"/>
            <Catalog name="Video"/>
            <Catalog name="Network"/>
            <Catalog name="Operating System"/>
            <Catalog name="Environment Variables"/>
            <Catalog name="Browser"/>
            <Catalog name="Installed Software"/>
            <Catalog name="Running Software"/>
            <Catalog name="Processes"/>
            <Catalog name="Startup Programs"/>
            <Catalog name="Logical Drives"/>
            <Catalog name="Devices"/>
            <Catalog name="Services"/>
            <Catalog name="System Drivers"/>
            <Catalog name="Signed Drivers"/>
            <Catalog name="Event Viewer"/>
          </SystemInfo>
          <Message ind="" type="private">
            <LoginName/>
              <DateTimeUTC>1285566004641</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
              <Content>king jin gathers system information</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285566004745</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>
              executing the system information 'System Summary'
            </Content>
          </Message>
            <SystemInfo ver="T27">
            <UserName>sdf sdfsa</UserName>
            <Catalog name="System Summary">
  System Name: KING-2163{*}System Type: X86-based PC{*}System
  Manufacturer: System manufacturer{*}System Model: Not
  Available{*}System Domain: hfwbx.hf.webex.com{*}User Name:
  HFWBX\king{*}Number of Processors: 1{*}Total Physical Memory: 3583
  MB{*}Total Virtual Memory: 856 MB{*}Manufacturer:
  GenuineIntel{*}Model: Intel Pentium III Xeon
  processor{*}Architecture: x86{*}Speed: 2.7 GHz{*}CPU Status: Unknown
  {*}MAX Speed: 2.7 GHz{*}WMI Status : True{*}WMI Versions:
  2600.0000{*}Available Physical Memory: 1746 MB{*}Available Virtual
  Memory: 2001 MB{*}Boot Time: 09-27-2010 00:35 AM{*}Page File Size:
  2046 MB{*}Page File: C:\pagefile.sys{*}Locale: United
  States{*}Timezone: Morocco Standard Time{*}
            </Catalog>
            <Catalog name="BIOS">
  BIOS Name: BIOS Date: 08/26/09 20:46:40 Ver: 08.00.12{*}BIOS Version:
  A_M_I_ - 8000926{*}BIOS Date: 2009-08-26{*}BIOS Language:
  en|US|iso8859-1{*}BIOS Description: BIOS Date: 08/26/09 20:46:40 Ver:
  08.00.12{*}BIOS Manufacturer: American Megatrends Inc.{*}BIOS Status:
  OK{*}
            </Catalog>
            <Catalog name="Storage"/>
            <Catalog name="Video"/>
            <Catalog name="Network"/>
            <Catalog name="Operating System"/>
            <Catalog name="Environment Variables"/>
            <Catalog name="Browser"/>
            <Catalog name="Installed Software"/>
            <Catalog name="Running Software"/>
            <Catalog name="Processes"/>
            <Catalog name="Startup Programs"/>
            <Catalog name="Logical Drives"/>
            <Catalog name="Devices"/>
            <Catalog name="Services"/>
            <Catalog name="System Drivers"/>
            <Catalog name="Signed Drivers"/>
            <Catalog name="Event Viewer"/>
           </SystemInfo>
         <Message ind="" type="public">
           <LoginName UID="976304952">king jin</LoginName>
           <DateTimeUTC>1285566009053</DateTimeUTC>
           <TargetName GroupID="15">All Participants</TargetName>
           <Content>sdfsadfsda</Content>
         </Message>
        </MeetingSession>
      </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

getSCXMLResponse

SOAP Response

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: text/xml;charset=utf-8
Date: Wed, 23 Mar 2011 06:52:14 GMT
Connection: close

XML Listing

  <?xml version="1.0" encoding="utf-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getSCXmlResponse
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="nbrXmlService">
        <getSCXmlReturn href="#id0"/>
      </ns1:getSCXmlResponse>
      <multiRef id="id0" soapenc:root="0"
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xsi:type="ns2:Document"
  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns2="nbrXmlService">
        <MeetingSession type="chat" encoding="UTF-8">
          <Message ind="" type="public">
            <LoginName UID="-1690347711">sdf sdfsa</LoginName>
            <DateTimeUTC>1285565935278</DateTimeUTC>
            <TargetName GroupID="15">All Participants</TargetName>
            <Content>asdfsadfsaf</Content>
          </Message>
          <Message ind="" type="public">
            <LoginName UID="-1690347711">sdf sdfsa</LoginName>
            <DateTimeUTC>1285565936918</DateTimeUTC>
            <TargetName GroupID="15">All Participants</TargetName>
            <Content>sadfsadfsa</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285565964962</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>king jin gathers system information</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285565965284</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>
              executing the system information 'System Summary'
            </Content>
          </Message>
          <SystemInfo ver="T27">
            <UserName>sdf sdfsa</UserName>
            <Catalog name="System Summary">
  System Name: KING-2163{*}System Type: X86-based PC{*}System
  Manufacturer: System manufacturer{*}System Model: Not
  Available{*}System Domain: hfwbx.hf.webex.com{*}User Name:
  HFWBX\king{*}Number of Processors: 1{*}Total Physical Memory: 3583
  MB{*}Total Virtual Memory: 856 MB{*}Manufacturer:
  GenuineIntel{*}Model: Intel Pentium III Xeon
  processor{*}Architecture: x86{*}Speed: 2.7 GHz{*}CPU Status: Unknown
  {*}MAX Speed: 2.7 GHz{*}WMI Status : True{*}WMI Versions:
  2600.0000{*}Available Physical Memory: 1734 MB{*}Available Virtual
  Memory: 2006 MB{*}Boot Time: 09-27-2010 00:35 AM{*}Page File Size:
  2046 MB{*}Page File: C:\pagefile.sys{*}Locale: United
  States{*}Timezone: Morocco Standard Time{*}
            </Catalog>
            <Catalog name="BIOS">BIOS Name: BIOS Date: 08/26/09
  v20:46:40 Ver: 08.00.12{*}BIOS Version: A_M_I_ - 8000926{*}BIOS Date:
  2009-08-26{*}BIOS Language: en|US|iso8859-1{*}BIOS Description: BIOS
  Date: 08/26/09 20:46:40 Ver: 08.00.12{*}BIOS Manufacturer: American
  Megatrends Inc.{*}BIOS Status: OK{*}
            </Catalog>
            <Catalog name="Storage"/>
            <Catalog name="Video"/>
            <Catalog name="Network"/>
            <Catalog name="Operating System"/>
            <Catalog name="Environment Variables"/>
            <Catalog name="Browser"/>
            <Catalog name="Installed Software"/>
            <Catalog name="Running Software"/>
            <Catalog name="Processes"/>
            <Catalog name="Startup Programs"/>
            <Catalog name="Logical Drives"/>
            <Catalog name="Devices"/>
            <Catalog name="Services"/>
            <Catalog name="System Drivers"/>
            <Catalog name="Signed Drivers"/>
            <Catalog name="Event Viewer"/>
          </SystemInfo>
          <Message ind="" type="private">
            <LoginName/>
              <DateTimeUTC>1285566004641</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
              <Content>king jin gathers system information</Content>
          </Message>
          <Message ind="" type="private">
            <LoginName/>
            <DateTimeUTC>1285566004745</DateTimeUTC>
            <TargetName>sdf sdfsa</TargetName>
            <Content>
              executing the system information 'System Summary'
            </Content>
          </Message>
            <SystemInfo ver="T27">
            <UserName>sdf sdfsa</UserName>
            <Catalog name="System Summary">
  System Name: KING-2163{*}System Type: X86-based PC{*}System
  Manufacturer: System manufacturer{*}System Model: Not
  Available{*}System Domain: hfwbx.hf.webex.com{*}User Name:
  HFWBX\king{*}Number of Processors: 1{*}Total Physical Memory: 3583
  MB{*}Total Virtual Memory: 856 MB{*}Manufacturer:
  GenuineIntel{*}Model: Intel Pentium III Xeon
  processor{*}Architecture: x86{*}Speed: 2.7 GHz{*}CPU Status: Unknown
  {*}MAX Speed: 2.7 GHz{*}WMI Status : True{*}WMI Versions:
  2600.0000{*}Available Physical Memory: 1746 MB{*}Available Virtual
  Memory: 2001 MB{*}Boot Time: 09-27-2010 00:35 AM{*}Page File Size:
  2046 MB{*}Page File: C:\pagefile.sys{*}Locale: United
  States{*}Timezone: Morocco Standard Time{*}
            </Catalog>
            <Catalog name="BIOS">
  BIOS Name: BIOS Date: 08/26/09 20:46:40 Ver: 08.00.12{*}BIOS Version:
  A_M_I_ - 8000926{*}BIOS Date: 2009-08-26{*}BIOS Language:
  en|US|iso8859-1{*}BIOS Description: BIOS Date: 08/26/09 20:46:40 Ver:
  08.00.12{*}BIOS Manufacturer: American Megatrends Inc.{*}BIOS Status:
  OK{*}
            </Catalog>
            <Catalog name="Storage"/>
            <Catalog name="Video"/>
            <Catalog name="Network"/>
            <Catalog name="Operating System"/>
            <Catalog name="Environment Variables"/>
            <Catalog name="Browser"/>
            <Catalog name="Installed Software"/>
            <Catalog name="Running Software"/>
            <Catalog name="Processes"/>
            <Catalog name="Startup Programs"/>
            <Catalog name="Logical Drives"/>
            <Catalog name="Devices"/>
            <Catalog name="Services"/>
            <Catalog name="System Drivers"/>
            <Catalog name="Signed Drivers"/>
            <Catalog name="Event Viewer"/>
           </SystemInfo>
         <Message ind="" type="public">
           <LoginName UID="976304952">king jin</LoginName>
           <DateTimeUTC>1285566009053</DateTimeUTC>
           <TargetName GroupID="15">All Participants</TargetName>
           <Content>sdfsadfsda</Content>
         </Message>
        </MeetingSession>
      </multiRef>
    </soapenv:Body>
  </soapenv:Envelope>

GetStorageAccessTicket

Return to NBR APIs

The getStorageAccessTicket function is used to retrieve a ticket that allows access to the NBR storage server. The getStorageAccessTicketRequest function is used to request the ticket and accepts the site admin user name and password. The getStorageAccessTicketResponse function is then used to retrieve the ticket. This ticket may be used throughout the session for authentication purposes and the ticket duration is 1 hour.

getStorageAccessTicketRequest

getStorageAccessTicketRequest Parameters

Name	Type	Description
password	String.	Webex SiteAdmin password.
siteId	Long.	Unique identifier for each Webex site.
username	String.	The SiteAdmin user name of the user.

SOAP Request:

POST /nbr/services/NBRStorageService 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: 10.224.91.216:2001 Cache-Control: no-cache Pragma: no-cache SOAPAction: "" Content-Length: 578

XML Listing

  <?xml version="1.0" encoding="UTF-8"?>
  <soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
      <ns1:getStorageAccessTicket
  soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:ns1="NBRStorageService">
        <siteId xsi:type="xsd:long">400011074</siteId>
        <username xsi:type="xsd:string">king</username>
        <password xsi:type="xsd:string">pass</password>
       </ns1:getStorageAccessTicket>
    </soapenv:Body>
  </soapenv:Envelope>

getStorageAccessTicketResponse

getStorageAccessTicketResponse Parameters

Name	Type	Description
getStorageAccess	String.	Returns the requested ticket.
TicketReturn		An unsuccessful response returns one of the following error messages:
		* The siteId is invalid.
		* The user is invalid/inactive or the password is not correct.

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: text/xml;charset=utf-8
Date: Wed, 23 Mar 2011 06:44:37 GMT
Connection: close

 <?xml version="1.0" encoding="utf-8"?>
 <soapenv:Envelope
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
     <ns1:getStorageAccessTicketResponse
 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
 xmlns:ns1="NBRStorageService">
       <getStorageAccessTicketReturn xsi:type="xsd:string">
 M0Wxn4lCIuWAz4Zj0dd/voTJjRAhTZ3beORfyWbSNmGYPMp6HmyRgugXp7itWzf/Z4ZU
 VTNv2FlEk9/khkrFShiq2g4e/8nvoFH3gL9thlo=
       </getStorageAccessTicketReturn>
     </ns1:getStorageAccessTicketResponse>
   </soapenv:Body>
 </soapenv:Envelope>