Table Of Contents
Cisco CallManager 4.2(1) AXL Programming Guide
Target Audience for this Guide
Integration considerations and Inter-operability
Cisco Product Security Overview
Reporting Security Problems in Cisco Products
Obtaining Technical Assistance
Cisco Technical Support & Documentation Website
Definitions of Service Request Severity
Obtaining Additional Publications and Information
Cisco CallManager 4.2(1) AXL Programming Guide
To access all AXL SOAP API downloads and AXL requests and responses found in this document, refer to the following URL:
http://www.cisco.com/pcgi-bin/dev_support/access_level/product_support
This manual contains the following sections:
•
Target Audience for this Guide
•
•
•
Introduction
The Administrative XML Layer (AXL) Application Programming Interface (API) provides a mechanism for inserting, retrieving, updating, and removing data from the database using an eXtensible Markup Language (XML) Simple Object Access Protocol (SOAP) interface. This allows a programmer to access Cisco CallManager data using XML and receive the data in XML form, instead of using a binary library or DLL.
The AXL API methods, known as requests, are performed using a combination of HTTP and SOAP. SOAP is an XML remote procedure call protocol. Users perform requests by sending XML data to the Cisco CallManager server. The server then returns the AXL response, which is also a SOAP message.
Target Audience for this Guide
This programming guide is designed for fairly experienced developers who would like access to one or more of the following items:
•
•
•
This guide assumes the developer has knowledge of a high-level programming language such as C++, Java, or an equivalent language. The developer must also have knowledge or experience in the following areas:
•
•
•
•
In addition, the users of the AXL API and this programming guide must have a firm grasp of XML Schema, which was used to define the AXL requests, responses, and errors. For more information on XML Schema, please refer to http://www.w3.org/TR/xmlschema-0/.
Caution
New and Changed Information
This section describes the new or changed API calls for Cisco CallManager Release 4.2(1).
Added API Calls
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Changed API Calls
These changes may require changes to existing user code that makes use of the following:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
AXL API
Request methods are XML structures that are passed to the AXL API server. The server receives the XML structures and executes the request. If the request completes successfully, then the appropriate AXL response is returned. All responses are named identically to the associated requests, except that the word "Response" has been appended.
For example, the XML response returned from an addPhone request is called addPhoneResponse.
If an error occurs, then an XML error structure is returned wrapped inside of a SOAP Fault structure (see "AXL Error Codes" section).
Note
AXL Methods
The Server Impact column is a sample measuring of the time (in milliseconds) it takes for the AXL server to handle the request. The tests were performed on a 7835-1000 MCS server. These figures should only be used as a guideline, and can drastically change due to cluster configuration, hardware configuration, and the size of the database.
The database used for these tests had the following entries:
•
•
•
•
•
•
•
•
•
•
•
•
AXL Error Codes
If an exception occurs on the server, or if any other error occurs during the processing of an AXL request, then an error is returned in the form of a SOAP Fault message:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Body><SOAP-ENV:Fault><faultcode>SOAP-ENV:Client</faultcode><faultstring><![CDATA[An error occurred during parsingMessage: End element was missing the character '>'.Source = Line : 41, Char : 6Code : c00ce55f, Source Text : </re]]></faultstring></SOAP-ENV:Fault></SOAP-ENV:Body></SOAP-ENV:Envelope>SOAP Fault messages can also contain more detailed information. The following is an example of a detailed SOAP Fault.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Body><SOAP-ENV:Fault><faultcode>SOAP-ENV:Client</faultcode><faultstring>Device not found with name SEP003094C39708.</faultstring><detail xmlns:axl="http://www.cisco.com/AXL/1.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.cisco.com/AXL/1.0http://myhost/CCMApi/AXL/V1/axlsoap.xsd"> <axl:error sequence="1234"><code>0</code><message><![CDATA[Device not found with name SEP003094C39708.]]></message><request>doDeviceLogin</request></axl:error></detail></SOAP-ENV:Fault></SOAP-ENV:Body></SOAP-ENV:Envelope>Error codes are included in the <detail> element of a SOAP Fault. The errors are represented by the axl:Error element. If a response to a request contains an <error> element, the user agent can determine the cause of the error by looking at the sub-elements of the <error> tag.
The following list describes the <error> element.
code
The <code> element is a numerical value that is used by the user agent to find out what type of error has occurred. The error codes are as follows:
message
The <message> element is provided so that the user agent gets a detailed error message explaining the error.
request
The <request> element is provided so that the user agent can determine what type of request generated this error. This element is optional; therefore it may not always appear.
Examples of AXL Requests
The following examples describe how to make an AXL request and read back the response to the request. Each SOAP request must be sent to the web server via an HTTP POST. The endpoint URL is an ISAPI Extension DLL. The following list contains the only four required HTTP headers.
•
The first header identifies that this particular POST is intended for the AXL SOAP API. The AXL API only responds to the POST method.
•
The second header confirms that the data being sent to AXL is XML. If this header is not found then an HTTP 415 error is returned to the client.
•
The third header is the Base64 encoding of the user name and password for the administrator of the AXL Server. Since Base64 encoding takes three 8-bit bytes and represents them as four printable ASCII characters, if the encoded header does not contain an even multiple of four ASCII characters (16, 20, 24, and so on), then padding characters (=) must be added to complete the final group of four as in the examples below.
If authentication of the user fails, then an HTTP 401 Access Denied error is returned to the client.
•
The fourth header is the length (in bytes) of the AXL request.
Note
The following example contains an HTTP header for an AXL SOAP request:
POST /CCMApi/AXL/V1/soapisapi.dllHost: axl.myhost.com:80Accept: text/*Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==Content-type: text/xmlContent-length: 613The following AXL request will be used in the code examples displayed in the following sections. This is an example of a getPhone request:
POST /CCMApi/AXL/V1/soapisapi.dllHost: axl.myhost.com:80Accept: text/*Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==Content-type: text/xmlContent-length: 613<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><SOAP-ENV:Body><axl:getPhone xmlns:axl="http://www.cisco.com/AXL/1.0" xsi:schemaLocation="http://www.cisco.com/AXL/1.0 http://gkar.cisco.com/schema/axlsoap.xsd" sequence="1234"><phoneName>SEP222222222245</phoneName></axl:getPhone></SOAP-ENV:Body></SOAP-ENV:Envelope>C or C++ Example
This code example uses a hard-coded AXL request and sends it to the AXL Server running on the local system (localhost). It then reads the response back, outputting the response to the screen.
#include <winsock2.h> // required for sockets#include <iostream> // required for console I/O#include <sstream>#include <string> // required for std::stringusing namespace std;int main(int argc, char* argv[]){// make connection to serverWSADATA WSAData;// initialize socketsif (int iError = WSAStartup (MAKEWORD(2,0), &WSAData)){cout << "Windows Sockets startup error. Aborting." << endl;return -1;}SOCKET Socket = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);if (Socket == INVALID_SOCKET){cout << "Socket creation error. Aborting." << endl;return -1;}SOCKADDR_IN sinRemote;sinRemote.sin_family = AF_INET;sinRemote.sin_port = htons (80) ;sinRemote.sin_addr.s_addr = inet_addr( "127.0.0.1" );cout << "connecting to service" << endl;int retval = connect(Socket, (SOCKADDR *)&sinRemote, sizeof (sinRemote));if (retval != 0){cout << "Error occured while connecting to socket. Aborting." << endl;closesocket(Socket);return -1;}const int BUFSIZE = 2048;char buff[BUFSIZE]; // the temporary receive bufferstring strHTTPHeader; // the HTTP Headerstring strAXLRequest; // the AXL SOAP request// The AXL request: getPhonestrAXLRequest = "<SOAP-ENV:Envelope xmlns:SOAP- \ ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" \ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \ xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"> \<SOAP-ENV:Body> \<axl:getPhone xmlns:axl=\"http://www.cisco.com/AXL/1.0\" \ xsi:schemaLocation=\"http://www.cisco.com/AXL/1.0 \ http://gkar.cisco.com/schema/axlsoap.xsd\" sequence=\"1234\"> \<phoneName>SEP222222222245</phoneName> \</axl:getPhone> \</SOAP-ENV:Body> \</SOAP-ENV:Envelope>";// temporarily use the buffer to store the length of the requestsprintf(buff, "%d", strAXLRequest.length());// build the HTTP headerstrHTTPHeader = "POST /CCMApi/AXL/V1/soapisapi.dll\r\n \Host: localhost:80\r\n \Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==\r\n \Accept: text/*\r\n \Content-type: text/xml\r\n \Content-length: ";strHTTPHeader += buff;strHTTPHeader += "\r\n\r\n";// put the HTTP header and SOAP XML togetherstrAXLRequest = strHTTPHeader + strAXLRequest;// send these bytes to the socketretval = send (Socket, strAXLRequest.c_str(),strAXLRequest.length(), 0);if ( retval != SOCKET_ERROR){// output responsecout << "received response: " << endl;int iTotalRead = 0;// read BUFSIZE at a time, writing to another ostringstreamdo {iNumRead = recv (Socket, buff, BUFSIZE-1, 0);buff[iNumRead] = NULL;cout << buff;iTotalRead += iNumRead;} while (iNumRead == BUFSIZE-1);cout << "Read " << iTotalRead << " bytes." << endl;}else{cout << "An error occured while sending the data to socket." << endl;}// all finished, close socketclosesocket(Socket);return 0;Java Example
This code example uses a hard-coded AXL request and sends it to the AXL Server running on the local system (localhost). It then reads the response back, outputting the response to the screen.
import java.io.*;import java.net.*;public class main{public static void main(String[] args){//Declare referencesString sAXLSOAPRequest = null; // will hold the complete request,// HTTP header and SOAP payloadString sAXLRequest = null; // will hold only the SOAP payloadSocket socket = null; // socket to AXL serverOutputStream out = null; // output stream to serverInputStream in = null; // input stream from serverbyte[] bArray = null; // buffer for reading response from serverserver// Build the HTTP HeadersAXLSOAPRequest = "POST /CCMApi/AXL/V1/soapisapi.dll\r\n";sAXLSOAPRequest += "Host: localhost:80\r\n";sAXLSOAPRequest += "Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==\r\n";sAXLSOAPRequest += "Accept: text/*\r\n";sAXLSOAPRequest += "Content-type: text/xml\r\n";sAXLSOAPRequest += "Content-length: ";// Build the SOAP payloadsAXLRequest = "<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" ";sAXLRequest += "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"> ";sAXLRequest += "<SOAP-ENV:Body> <axl:getPhone xmlns:axl=\"http://www.cisco.com/AXL/1.0\" ";sAXLRequest += " xsi:schemaLocation=\"http://www.cisco.com/AXL/1.0 http://gkar.cisco.com/schema/axlsoap.xsd\" ";sAXLRequest += "sequence=\"1234\"> <phoneName>SEP222222222245</phoneName> ";sAXLRequest += "</axl:getPhone> </SOAP-ENV:Body> </SOAP-ENV:Envelope>";// finish the HTTP HeadersAXLSOAPRequest += sAXLRequest.length();sAXLSOAPRequest += "\r\n\r\n";// now add the SOAP payload to the HTTP header, which completes the AXL SOAP requestsAXLSOAPRequest += sAXLRequest;// now that the message has been built, we can connect to server and send ittry{socket = new Socket("localhost", 80);out = socket.getOutputStream();in = socket.getInputStream();// send the request to the hostout.write(sAXLSOAPRequest.getBytes());// read the response from the hostStringBuffer sb = new StringBuffer(2048);bArray = new byte[2048];int ch = 0;int sum = 0;while ( (ch = in.read(bArray)) != -1 ){sum += ch;sb.append(new String(bArray, 0, ch));}socket.close();// output the response to the standard outSystem.out.println(sb.toString());} catch (UnknownHostException e){System.err.println("Error connecting to host: " + e.getMessage());return;} catch (IOException ioe){System.err.println("Error sending/receiving from server: " + ioe.getMessage());// close the sockettry{if (socket != null) socket.close();} catch (Exception exc){System.err.println("Error closing connection to server: " + exc.getMessage());}return;}Throttling of Requests
The side-effects of updating the Cisco CallManager database can adversely affect system performance; therefore, the system administrator is capable of controlling how many AXL requests are allowed to update the database per minute. This value is controlled via the Database Layer service parameter "MaxAXLWritesPerMinute".
AXL accommodates all requests until the "MaxAXLWritesPerMinute" value is reached. Subsequent attempts to modify the database with AXL are rejected with an HTTP 503 Service Unavailable response. Every minute, AXL resets its internal counter and begins to accept AXL update requests until the limit gets reached again.
The following AXL requests are considered "Reads" and do not count against the "MaxAXLWritesPerMinute" service parameter. All other AXL requests not in the following list count against the service parameter:
•
•
•
•
The AXL Schema Documentation
The complete AXL schema (including details of all requests, responses, XML objects, data types, etc.) is encapsulated in the following four files found on the Cisco CallManager server: axlsoap.xsd, axl.xsd, axlmessage.xsd, and AXLEnums.xsd. The default path is: C:\CiscoWebs\API\AXL\V1.
Standard XML handling IDEs and development environments can illuminate or auto-generate 'friendly' formatted documents based on the AXL schema files.
The following describes a complete auto-generated HTML document based on the schema that is available for download from the Developer Services web site at the following URL: http://www.cisco.com/go/developersupport (follow the Supported Product link).
Example XML Structure
Authentication
Anonymous access to the AXL SOAP service should be deactivated to enforce user authentication. User authentication gets controlled via the HTTP Basic Authentication scheme. Therefore, you must include the Authorization header in the HTTP Header.
For example, if the user agent wishes to send the userid "larry" and password "curly and moe", it would use the following header field:
Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==
where the string "bGFycnk6Y3VybHkgYW5kIG1vZQ==" is the Base 64 encoding of "larry:curly and moe".
Data Encryption
If the user agent wishes to encrypt the AXL SOAP message, then the user agent must use HTTP SSL.
SSL is not functional on the web server by default. The customer must request and install a SSL Certificate from a certified authority such as VeriSign. Once the SSL Certificate has been installed on the web server, AXL requests can be made using the "https" protocol in lieu of "http".
Integration considerations and Inter-operability
The AXL API gives much power to developers to modify the Cisco CallManager system database. The developer must take caution when using AXL, since each API call impacts the system. Abuse of the API can lead to dropped calls and slower system performance. AXL is not intended as a real-time API, but as a provisioning and configuration API.
If AXL is determined to be using too much of the CPU time, consider lowering the MaxAXLWritesPerMinute service parameter. If this does not solve the problem, consider purchasing a second server to be used only by applications using AXL.
Obtaining Documentation
Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation at this URL:
http://www.cisco.com/techsupport
You can access the Cisco website at this URL:
You can access international Cisco websites at this URL:
http://www.cisco.com/public/countries_languages.shtml
Product Documentation DVD
The Product Documentation DVD is a comprehensive library of technical product documentation on a portable medium. The DVD enables you to access multiple versions of installation, configuration, and command guides for Cisco hardware and software products. With the DVD, you have access to the same HTML documentation that is found on the Cisco website without being connected to the Internet. Certain products also have .PDF versions of the documentation available.
The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com users (Cisco direct customers) can order a Product Documentation DVD (product number DOC-DOCDVD= or DOC-DOCDVD=SUB) from Cisco Marketplace at this URL:
http://www.cisco.com/go/marketplace/
Ordering Documentation
Registered Cisco.com users may order Cisco documentation at the Product Documentation Store in the Cisco Marketplace at this URL:
http://www.cisco.com/go/marketplace/
Nonregistered Cisco.com users can order technical documentation from 8:00 a.m. to 5:00 p.m. (0800 to 1700) PDT by calling 1 866 463-3487 in the United States and Canada, or elsewhere by calling 011 408 519-5055. You can also order documentation by e-mail at tech-doc-store-mkpl@external.cisco.com or by fax at 1 408 519-5001 in the United States and Canada, or elsewhere at 011 408 519-5001.
Documentation Feedback
You can rate and provide feedback about Cisco technical documents by completing the online feedback form that appears with the technical documents on Cisco.com.
You can submit comments about Cisco documentation by using the response card (if present) behind the front cover of your document or by writing to the following address:
Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883We appreciate your comments.
Cisco Product Security Overview
Cisco provides a free online Security Vulnerability Policy portal at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html
From this site, you will find information about how to:
•
•
•
A current list of security advisories, security notices, and security responses for Cisco products is available at this URL:
To see security advisories, security notices, and security responses as they are updated in real time, you can subscribe to the Product Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed. Information about how to subscribe to the PSIRT RSS feed is found at this URL:
http://www.cisco.com/en/US/products/products_psirt_rss_feed.html
Reporting Security Problems in Cisco Products
Cisco is committed to delivering secure products. We test our products internally before we release them, and we strive to correct all vulnerabilities quickly. If you think that you have identified a vulnerability in a Cisco product, contact PSIRT:
•
An emergency is either a condition in which a system is under active attack or a condition for which a severe and urgent security vulnerability should be reported. All other conditions are considered nonemergencies.
•
In an emergency, you can also reach PSIRT by telephone:
•
•
Tip
Never use a revoked or an expired encryption key. The correct public key to use in your correspondence with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page at this URL:
http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html
The link on this page has the current PGP key ID in use.
If you do not have or use PGP, contact PSIRT at the aforementioned e-mail addresses or phone numbers before sending any sensitive material to find other means of encrypting the data.
Obtaining Technical Assistance
Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco Technical Support & Documentation website on Cisco.com features extensive online support resources. In addition, if you have a valid Cisco service contract, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not have a valid Cisco service contract, contact your reseller.
Cisco Technical Support & Documentation Website
The Cisco Technical Support & Documentation website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, at this URL:
http://www.cisco.com/techsupport
Access to all tools on the Cisco Technical Support & Documentation website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL:
http://tools.cisco.com/RPF/register/register.do
Note
Submitting a Service Request
Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool provides recommended solutions. If your issue is not resolved using the recommended resources, your service request is assigned to a Cisco engineer. The TAC Service Request Tool is located at this URL:
http://www.cisco.com/techsupport/servicerequest
For S1 or S2 service requests, or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly.
To open a service request by telephone, use one of the following numbers:
Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447For a complete list of Cisco TAC contacts, go to this URL:
http://www.cisco.com/techsupport/contacts
Definitions of Service Request Severity
To ensure that all service requests are reported in a standard format, Cisco has established severity definitions.
Severity 1 (S1)—An existing network is down, or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.
Severity 2 (S2)—Operation of an existing network is severely degraded, or significant aspects of your business operations are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.
Severity 3 (S3)—Operational performance of the network is impaired, while most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.
Severity 4 (S4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online and printed sources.
•
•
http://www.cisco.com/go/marketplace/
•
•
•
http://www.cisco.com/go/iqmagazine
or view the digital edition at this URL:
http://ciscoiq.texterity.com/ciscoiq/sample/
•
•
http://www.cisco.com/en/US/products/index.html
•
http://www.cisco.com/discuss/networking
•
http://www.cisco.com/en/US/learning/index.html
CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, StrataView Plus, TeleRouter, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0502R)
Copyright © 2006. Cisco Systems, Inc. All rights reserved.
Guest
