Access to Webex API

[mharidas]

Hi,

How do we get access to Webex APIs as a new user? How do we get access token. Is there a test environment we can play with?

We are interested in accessing the Training Center, Meeting Center and recorded sessions.

Thank you

Minnie

[dstaudt]

Basic developer access (primarily none admin actions) is available via the WebEx Sandbox (link here:)

https://developer.cisco.com/site/webex-developer/develop-test/try-webex-apis/

For more in-depth development (e.g. varying system types, recordings, etc.) you will likely need to inquire about joining the WebEx Gold Developer Program, via contacting WebEx Sales:

Cisco WebEx Contact Sales.

[mharidas]

Thank you.

I was able to reserve a sandbox environment for Webex Conferencing APIs

I get the following informational side note.

Do you have sample code I can exercise to access the site via API?

It is confusing as to what to do next ! As a Cisco Employee I am assuming I do not need a Gold Support. Please advise!

Site URL:  https://apidemoeu.webex.com
SiteID:  690319
PartnerID:  g0webx!
XML Service URL:  https://apidemoeu.webex.com/WBXService/XMLService

[dstaudt]

If you haven't seen it yet, the WebEx Learning Lab will guide you through some simple exercises of the API using a REST test tool (Postman):

Cisco DevNet Learning Labs

Additional sample code you can use with your credentials can be found here (e.g. Java:)

Cisco DevNet: WebEx Conferencing - XML API - Sample Code

[mharidas]

Hi,

We explored the XML API guide and need a clarification on the Event Center API.

Once a event  is created (Event Center/Host an Event/Schedule an event)  , how can we search for this event using the API. How can we restrict the search other thank start date and end date in the LstsummaryMeeting?

Is there another API that will help with the search?

Thanks

Minnie

[kasutton]

Hi Minnie,

You'll probably want to check out LstsummaryEvent:

https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lstsummaryevent

The following link should take you to the schema, which will give you an idea of which options you may have:

Cisco DevNet: WebEx Conferencing - XML API - XML API Schema

Kasey

[dstaudt]

From my interpretation of the API reference/schema - perhaps someone else from the WebEx team can correct me:

- If you know the event ID, you can retrieve info on it directly via GetEvent

- You can retrieve a bulk listing of events via LstSummaryEvent

- You can narrow the search by AND'ing or OR'ing - indicated by listControl/listMethod - based on the criteria elements: dateScope, sessionKey, hostWebExID, programID..? (not 100% sure on this part)

- Further narrowing (i.e. regex'ing the event name or description) would need to be handled by the application after retrieving the bulk event list

[kasutton]

Pretty good! And yes, programID is one of the available constraints, though it's its own element, rather than a child of listControl.

Additionally, I would suggest that even though the documentation code samples include startTimeScope AND endTimeScope, you should choose one or the other.

Kasey

[mharidas]

Thank you David.

how can we retrieve the WebEx ID of the host user.

Is the host here referring to the user who created the event?

We should be able to narrow down the search based on the webex ID and the dates if my assumption is correct.

Please advise.

[dstaudt]

It looks like similar to LstSummaryEvent, you can use LstSummaryUser to search by first-name, last-name, webex ID, active, or registration date:

https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#request30

The event host appears to be specified either at time of event creation via:

- createEvent/schedule/hostWebexID

Or later via:

- setEvent/schedule/hostWebexID

[mharidas]

Hi

So java:com.webex.service.binding.event.LstsummaryEvent gives the summary of the Event.

How do we the event's image (if added), collateral(if added), participants and complete details including registration URL?

Also I am assuming that Customize registration form if any for the Program to which the Event belongs shows up on the Registration Page.

Thanks

Minnie