Chat with Us!

URL API Overview

The WebEx Web Conferencing URL API is based on HTTP(S), and provides a convenient, lightweight mechanism to offer browser-based, external hooks into the WebEx Meeting services. The diagram below provides a high level overview of where the URL API integration layer resides.

The WebEx Web Conferencing URL API is typically used in enterprise portal integrations supporting basic interactions such as Single Sign-On (SSO), scheduling meetings, starting and joining simple meetings, and inviting attendees and presenters.
If more advanced integration is needed, Cisco strongly recommends utilizing the WebEx Web Conferencing XML API.

NOTE: Before implementation, testing, and deployment of WebEx Web Conferencing services can occur, a signed usage agreement between WebEx Web Conferencing and your organization is needed.

How does the URL API work?

The URL API centers around HTTP(S) URLs with imbedded PHP calls which invoke service requests on the WebEx Web Conferencing server. The WebEx Web Conferencing server processes the PHP request and returns the destination web page ('Back URL') provided as a parameter in the initial request. The Back URL is typically either a specific page served by the WebEx Web Conferencing service being invoked, or a page external to WebEx Web Conferencing residing on the corporate portal being integrated.

What services are available for the URL API?

In order to properly integrate URL API WebEx Web Conferencing services into your organization's website, you will need to include PHP calls into the appropriate corporate web pages. The table below is a summary of available URL API services and simple commands for integrating with your WebEx-Meetings-hosted website.

Service Name Integration Usage
Managing User Accounts
  • Creating a new user account
  • Edit an existing user account
  • Activate and deactivate user accounts
WebEx-hosted website login/logout
  • Use an authenticated server-to-server connection for logging into and out of WebEx-Meetings-hosted website
Using and Managing Meetings
  • Schedule a meeting
  • Edit a meeting
  • Starting or deleting a host's scheduled meeting
  • Listing all scheduled meetings
  • Listing all open meetings
  • Joining an open meeting
Modifying 'My WebEx Web Conferencing' page
  • Modifying user information on My WebEx Web Conferencing page
  • Managing user's My Contacts list
Using Attendee Registration forums Users must fill out a registeration form before attending some meetings:

  • Create a Registration Form
  • Determine current required, optional, or do-not-display settings for a registration page
  • Add check boxes, buttons, and drop-down lists to the Registration Form
Managing Attendee Lists The host of a scheduled meeting can:

  • Add attendees to a list of invited users
  • Remove attendees from a list of invited users
Playing back a recorded event Allow an attendee to get a list of recorded events for playback.
Querying for Questions and Answers
  • View a list of custom questions created by the host
  • View attendees' answers to the custom questions
  • View a list of standard questions created by the host
  • View attendees' answers to the standard questions
Making Recording Training Sessions available for viewing Make all aspects of a previously recorded Training Center session available for later playback.
Reporting
  • Send email notifications with attendee information
  • Display reporting information about training sessions you hosted
  • View a list of enrollees and attendees for events
  • View a list of all events a specific attendee has joined
  • View a list of people who have downloaded files
Using Support Center Sessions
  • Starting a support session
  • Joining a support session

URL API Command Structure

URL requests are formed by constructing a base URL and appending "AT" commands with parameters specifying each PHP call.

Your WebEx-Meetings-hosted website is the foundation of the URL request. In the below example, 'yourWebExHostedName' represents the first part of the domain name for your WebEx-Meetings-hosted Web site, such as your company name, assigned by WebEx Web Conferencing.

Below is the general syntax showing the base URL along with an example using XYZ_Corp as the company name:

Syntax Structure: http://yourWebExHostedName.webex.com/yourWebExHostedName/
XYZ_Corp Company example: http://XYZ_corp.webex.com/XYZ_Corp/

The URL API command set is organized across a few PHP command pages that support certain categories of operations. To invoke a URL command on your organization's WebEx-Meetings-hosted Web site, you append the desired command page, the actual URL command, and arguments. Below displays the URL API command to log out of the WebEx Web Conferencing site for the current XYZ_Corp user. The logout command (AT=LO) is specified from the Partner page (p.php):

Syntax Structure: http://yourWebExHostedName.webex.com/yourWebExHostedName/p.php?AT=command
XYZ_Corp Company example: http://XYZ_Corp.webex.com/XYZ_Corp/p.php?AT=LO

If you would like the user to be taken to a specific page following the URL API command, a 'Back URL' (&BU=) will need to be a specified parameter within the original request. Below provides the same logout example providing the needed Back URL:

Syntax Structure: http://yourWebExHostedName.webex.com/yourWebExHostedName/p.php?AT=command&BU=backURL
XYZ_Corp Company example: http://XYZ_Corp.webex.com/XYZ_Corp/p.php?AT=LO&BU=http://www.XYZ_Corp.com/mypage.html

NOTE: If the 'back URL' is not specified in the parameter, WebEx will default to the home page of your WebEx-Meetings-hosted web site (http://yourWebExHostedname.webex.com).

For a complete reference to the PHP commands and more details on WebEx Web Conferencing integration utilizing the URL API, please refer to the WebEx Web Conferencing URL API Reference Guide.