Introduction

The Administration XML API (AXL) provides a mechanism for inserting, retrieving, updating and removing data from the Unified Communication configuration database using an eXtensible Markup Language (XML) Simple Object Access Protocol (SOAP) interface. This allows a programmer to access Cisco Unified Communications Manager (Unified CM) provisioning services using XML and exchange data in XML form, instead of using a binary library or DLL. The AXL methods, referred to 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 Unified CM Publisher server. The Publisher then returns the AXL response, which is also a SOAP message.

Technology/Solution Details

The AXL API allows applications to Get, List, Add, Update, and Delete objects in the Unified CM database. Examples of Unified CM objects that can be provisioned with AXL include: 


  • Unified CM Subscribers

  • Unified CM Groups

  • Call Park DNs

  • Call Pickup Groups

  • Calling Search Spaces

  • CTI Route Points

  • Device Pools

  • Device Profiles

  • Dial Plan Tags

  • Dial Plans

  • Digit Discard Instructions

  • Directory Numbers

  • Gateways (Analog, T1, PRI)

  • Locations

  • MGCP Devices

  • Phones

  • Process Nodes

  • Process Node Services

  • Regions

  • Route Filters

  • Route Groups

  • Route Lists

  • Route Partitions

  • Service Parameters

  • Translation Patterns

  • Users

  • Voice Mail Ports


 


A complete list of available AXL methods can be found here:
http://developer.cisco.com/web/axl/wikidocs?src=/wiki/display/AXL/AXL+Request-Release+Matrix

 Request methods represent XML structures that are passed to the AXL service running on the Unified CM Publisher. The server receives
the XML structures and executes the request. If the request completes successfully, the system returns
the appropriate AXL response. All responses get named identically to the associated requests, except
that the word “Response” is appended.

For example, the XML response that is returned from an addPhone request is named addPhoneResponse

The Cisco Unified Communications Manager AXL implementation complies with XML Schema 1.0,
which was tested for XML Schema compliance with a third-party application that is called XML Spy
version 4.x.

The Cisco Unified Communications Manager AXL implementation also complies with SOAP 1.1 as
defined by the World Wide Web Consortium as well as HTTPS 1.1. The AXL API runs as an independent
service that can be accessed only via HTTPS.