Webex Meeting APIs FAQs
This topics describes the URL and XML API FAQs.
Table of contents
URL API FAQs
What is the MU or BU in URL API calls?
MU is the destination of the host once the login command is successful and is used only with the AT=LI command. This URL can only point back to the Webex hosted site. If MU is set to GoBack, it will use the value in the BackURL (BU).
BU is the destination for the host/attendees, once the command has completed its process. This can be a URL that points to anywhere that is accessible on the Internet.
How do I get a meeting key and start an instant meeting?
You can use the meeting key for many reasons, but many use this information for tracking other meeting information in a database on the partner side. The AT=IM command does not return a meeting key; the meeting is started as soon as the command is issued. Use the AT=SM command to schedule the meeting which will return a meeting key. Then, immediately use the AT=HM command to host the meeting using the meeting key.
What is the List open meetings (m.php?AT=OM) command used for?
List Open Meetings returns a list of meetings in progress. The command can be useful to determine if a meeting exceeded its appointed duration to avoid overage charges.
Does the List Meetings (m.php?AT=LM) command act like the Today's Meeting page on the Webex hosted site?
No, the command returns a list of scheduled meetings for the current host. For information on how to obtain a list of Today's Meetings, see Tips & Tricks.
What is the difference between Common Entry Points and the Webex URL API?
While the API allows full control of the look and feel of the user experience, Common Entry Points do not. They result in rendered pages but, in some cases, allow access to items that the Webex URL API currently does not.
Can I copy the URLs from the Webex pages on my own sites?
Many customers and partners have, at some point, attempted to use the links found on the Webex hosted site within pages on their sites. Though this may be occasionally effective, the practice is not supported as these links change from time to time. Only the use of the Common Entry Points and the Webex URL APIs are supported.
The AT=SU command does not have a BU, so how can I know whether the host account is created?
A servlet or applet, such as ASP, can be used to parse the tags returned in the page. The tags will contain a SUCCESS or FAIL message. You can find more information about the format of the tags in the Webex URL API Reference Guide.
Where should I see a solution if the existing Webex URL API would not do what I need?
Webex has a fee-based service through our Professional Services Organization. This team can help, in most cases, with anything from simple Single Sign On (SSO) implementations to complex modifications that involve hosted changes to the Webex API.
URL API Security FAQs
What are the IP and Domain Referrer?
A customer or partner can request the addition of their IP addresses and domain information to their site configuration. In conjunction with the use of the p.php, this will ensure that the processes such as new user creation and user logins are more secure.
What is a PID (Partner ID)?
The PID used in the new user creation process is a unique key that is assigned to each URL. This security measure ensures that only an appropriate party can authorize the creation of a new user. If the incorrect PID is used, an error message is displayed and the user is not created.
XML APIs FAQs
How do I get my Webex Site ID (SID) and/or Partner ID (PID)?
Contact your Webex Account Manager (CSM).
How do I send an XML message to your server?
The XML API uses standard HTTP(S) POST requests for placing API calls. We strongly recommend you to use HTTPS, since it includes your Webex username and password in each call.
To which URL do I post my XML API?
The normal URL to post your XML API request is https://[SITENAME].webex.com/WBXService/XMLService. SITENAME is usually the name of the customer organization.
Can I test the next XML API release before I deploy it on my site?
Yes, we will always notify you at least two weeks in advance before releasing a new version of the XML API. During this time we can provide you with a "sandbox" site where you can test your integration with the upcoming release. Usually two weeks before its production rollout, we make the next release available directly on your site through a "preview" URL. The format for this URL is https://SITENAME.webex.com/WBXService/preview/XMLService where SITENAME is your Webex site name.
apisupport@webex.com -- For general support questions related to the Webex API service. Example: The XML API service takes a long time to respond to my requests.
webex-meetings-api-dev@cisco.com -- For API programming and integration development questions. Example: What elements do I use in createMeeting to allow my attendees to join a meeting ten minutes before the scheduled time?
How do I get the latest release of the API documentation?
The latest XML API documentation is available in the Documentation section on this site.
Can I make SOAP calls to the XML API?
Currently, the Webex XML API does not utilize SOAP envelopes in our request or response format nor publish WSDL files. However, the XML API service responds to XML requests posted thro HTTP. Customers have successfully used XSL transformations or other methods to transform SOAP calls into the Webex XML API format.
What do I use for "meetingType" in CreateMeeting?
<meetingType> is an integer value used to specify the Meeting Type for the meeting you are scheduling. This value can change from site to site and user to user.
The easiest way to set the Meeting Type is to leave out <meetingType> in CreateMeeting. In this case the system will automatically determine a proper meeting type based on the following criteria:
- Among all the meeting types allowed for a host, choose a Meeting Center (MC) PRO-based meeting type with the highest meeting type ID.
- If MC PRO is unavailable, choose an MC STD-based meeting type with the highest meeting type ID.
- If MC STD is unavailable, choose an MC FRE-based meeting type with the highest meeting type ID.
- If none of the meeting types are available, the system throws an exception.
To manually specify a <meetingType> the integration should first call GetUser to retrieve the available meeting types for the user to schedule the meeting.