Webex Meetings > Develop and Test > URL API > Overview

URL API Overview

The Webex Meetings 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 Meetings 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 Meetings XML API.

NOTE: Before implementation, testing, and deployment of Webex Meetings services can occur, a signed usage agreement between Webex Meetings 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 Meetings server. The Webex Meetings 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 Meetings service being invoked, or a page external to Webex Meetings residing on the corporate portal being integrated.

What services are available for the URL API?

In order to properly integrate URL API Webex Meetings 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 Meetings' page	Modifying user information on My Webex Meetings 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 Meetings.

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 Meetings 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 Meetings integration utilizing the URL API, please refer to the Webex Meetings URL API Reference Guide.

URL API Overview

Developer Platform Overview

Cisco Webex Cloud