Table Of Contents
APIs
Cisco Unified JTAPI Developers Guide
Cisco Unified TAPI Developers Guide
Cisco Unified Communications Manager XML Developers Guide
Administrative XML API
New APIs
Changed APIs
Schema and Other Changes
Serviceability XML API
Extension Mobility Service API
New APIs
Changed APIs
Web Dialer API
Routing Rules API
Cisco Unified IP Phone Services Application Development Notes
APIs
This chapter provides the new and changed information in the API Developer Guides for Cisco Unified Communications Manager Release 8.0(1):
•
Cisco Unified JTAPI Developers Guide
•Cisco Unified TAPI Developers Guide
•Cisco Unified Communications Manager XML Developers Guide
•Cisco Unified IP Phone Services Application Development Notes
Cisco Unified JTAPI Developers Guide
This section describes new and changed JTAPI information for Cisco Unified Communications Manager, release 8.0(1):
•Call Pickup—Enables devices to receive alerts within a Call Pickup Groups and events and enable them to act on these alerts by invoking APIs that support various flavors of Call Pickup.
•CallFwdAll Key Press Notification—Enables applications to know whether the call is a normal call or a temporary call, when CallFwdAll key is enabled.
•End to End Call Tracing—Enables the application to track any call uniquely. JTAPI associates a uniqueID with every Connection object.
•Extension Mobility Cross Cluster—Allows users to log in to an IP phone registered to a cluster with a user profiles configured with another cluster.
•External Call Control—Enables Cisco Unified Communications Manager to route calls based on enterprise policies and presence-based routing rules of individual users.
•Hunt List—Provides JTAPI application the capability to observe addresses and terminals that are HuntList LineGroup members.
•Secured Monitoring and Recording—Enhances the ability to monitor or record calls in a secure environment.
Cisco Unified TAPI Developers Guide
This section describes new and changed Cisco Unified TAPI Service Provider (TSP) information for Cisco Unified Communications Manager, release 8.0(1):
•Call Control Discovery—Facilitates provisioning for inter-call agent communications. This feature uses the Service Advertisement Framework (SAF) network service to advertise itself as a call control entity.
•Call PickUp—Provides TAPI applications the ability to invoke the pickup, group-pickup, other-pickup, and directed pickup feature from application.
•CallFwdAll Notification—Allows TAPI applications to distinguish off-hook calls (outgoing calls) from calls made by using the CFwdAll softkey.
•End-To-End Call Trace—Facilitates tracing of calls that traverse multiple Cisco voice products, such as Cisco Unified Communications Manager, Cisco IOS Gateway, and Cisco Call Centers products.
•Extension Mobility Cross Cluster—Allows users provisioned in one cluster to log in to an IP phone in another cluster.
•External Call Control—Enables Cisco Unified Communications Manager to route calls based on enterprise policies and presence-based routing rules of individual users.
•Hunt List—Supports lines and their devices included in the Hunt List and provide appropriate information for applications to understand that the call is offered through a Hunt Pilot.
•New Cisco Media Driver—Allows application to use the new Cisco Media Driver (next generation Wave Driver). Cisco Media Driver provides applications with functions similar to the legacy kernel mode driver, has improved scalability, and supports latest Microsoft operating system releases.
•Secure Monitoring and Recording—Enhances the ability to monitor or record calls in a secure environment.
Cisco Unified Communications Manager XML Developers Guide
This sections provides information on the updates made in the following sections of the XML Developers guide for Cisco Unified Communications Manager, release 8.0:
•Administrative XML API
•Serviceability XML API
•Extension Mobility Service API
•Web Dialer API
•Routing Rules API
Administrative XML API
The following sections describe the Administrative XML (AXL) API updates made in Cisco Unified Communications Manager 8.0:
•New APIs
•Changed APIs
•Schema and Other Changes
New APIs
Table 6-1 describes new AXL APIs in Cisco Unified Communications Manager 8.0.
Table 6-1 New Operations in Cisco Unified Communications Manager 8.0
Features
|
New APIs
|
To support call control discovery feature.
|
add/update/get/remove SafSecurityProfile
add/update/get/remove SafForwarder
add/update/get/remove CcdAdvertisingService
add/update/get/remove CcdRequestingService
add/update/get/remove CcdHostedDN
add/update/get/remove CcdHostedDNGroup
add/update/get/remove SafCcdPurgeBlockLearnedRoutes
|
To support extension mobility cross clusters feature.
|
update/get InterClusterServiceProfile
add/update/get/remove RemoteCluster
|
To support call intercept feature.
|
add/update/get/remove ExternalCallControlProfile
|
To support mobility SIP extension feature.
|
add/update/get/remove CumaServerSecurityProfile
|
To support Unified B2B Link feature.
|
add/update/get/remove ImeClient
add/update/get/remove ImeE164Transformation
add/update/get/remove ImeRouteFilterGroup
add/update/get/remove ImeRouteFilterElement
add/update/get/remove ImeEnrolledPattern
add/update/get/remove ImeEnrolledPatternGroup
add/update/get/remove ImeExclusionNumber
add/update/get/remove ImeExclusionNumberGroup
add/update/get/remove ImeFirewall
add/update/get/remove ImeServer
add/update/get/remove FallbackProfile
|
To support AXL automation.
|
add/update/get/remove PhoneNTP
add/update/get/remove DateTimeGroup
add/update/get/remove PresenceGroup
add/update/get/remove MlppDomain
add/update/get/remove PhoneSecurityProfile
add/update/get/remove ApplicationServer
add/update/get/remove AppDialRules
add/update/get/remove DirectoryLookupDialRules
add/update/get/remove SipDialRules
update/get Annunciator
|
To support AXL automation.
|
add/update/get/remove Mtp
add/update/get/remove MohAudioSource
update/get FixedMohAudioSource
add/update/get/remove MessageWaiting
add/update/get/remove DefaultDeviceProfile
add/update/get/remove IpPhoneServices
add/update/get/remove CiscoCatalyst600024PortFXSGateway
add/update/get/remove CiscoCatalyst6000T1VoIPGatewayT1
add/update/get/remove Srst
add/update/get/remove ApplicationUserCapfProfile
add/update/get/remove EndUserCapfProfile
add UserPhoneAssociation
add/update/get/remove Gateway
add/update/get/remove GatewayEndpointAnalogAccess
add/update/get/remove GatewayEndpointDigitalAccessPri
add/update/get/remove GatewayEndpointDigitalAccessBri
add/update/get/remove GatewayEndpointDigitalAccessT1
add/update/get/remove CiscoCatalyst6000E1VoIPGateway
add/update/get/remove CiscoCatalyst6000T1VoIPGatewayPri
add/update/get/remove CiscoCatalyst6000T1VoIPGatewayT1
list RoutePlan
add/update/get/remove CallingPartyTransformationPattern
add/remove UnitsToGateway
add/remove GatewaySubunits
add/update/get/remove LdapDirectory
add/update/get/remove SafCcdPurgeBlockLearnedRoutes
add/update/get/remove VpnGateway
add/update/get/remove VpnGroup
add/update/get/remove VpnProfile
add/update/get/remove TransformationProfile
add/update/get/remove LdapFilter
add/update/get/remove AppServerInfo
|
Changed APIs
The following AXL APIs are updated in Cisco Unified Communications Manager 8.0.
•AarGroup
•AarGroupMatrix
•AppUser
•CalledPartyTransformationPattern
•CallerFilterList
•CallManager
•CallManagerGroup
•CallPark
•CallPickupGroup
•CmcInfo
•CommonDeviceConfig
•CommonPhoneConfig
•ConferenceBridge
•CredentialPolicy
•Css
•CtiRoutePoint
•Ddi
•DeviceMobility
•DeviceMobilityGroup
•DevicePool
•DeviceProfile
•DhcpServer
•DhcpSubnet
•DialPlan
•DialPlanTag
•DirectedCallPark
•FacInfo
•Gatekeeper
•GeoLocation
•GeoLocationFilter
•GeoLocationPolicy
•H323Gateway
•H323Phone
•H323Trunk
•HuntList
•HuntPilot
•IvrUserLocale
•LicenseCapabilities
•Line
•LineGroup
•Location
•MediaResourceGroup
•MediaResourceList
•MeetMe
•MobileSmartClientProfile
•MobileVoiceAccess
•MohServer
•Phone
•PhoneButtonTemplate
•PhysicalLocation
•ProcessNode
•ProcessNodeService
•RecordingProfile
•Region
•RegionMatrix
•RemoteDestination
•RemoteDestinationProfile
•ResourcePriorityNamespace
•ResourcePriorityNamespaceList
•RouteFilter
•RouteGroup
•RouteList
•RoutePartition
•RoutePattern
•ServiceParameter
•SipProfile
•SipRealm
•SipRoutePattern
•SipTrunk
•SipTrunkSecurityProfile
•SoftKeyTemplate
•TimePeriod
•TimeSchedule
•TodAccess
•Transcoder
•TransPattern
•User
•UserGroup
•Vg224
•VoiceMailPilot
•VoiceMailPort
•VoiceMailProfile
Schema and Other Changes
The following changes are made in the AXL schema in release 8.0:
•The schema is one single file called AXLSoap.xsd and is a combination of axl.xsd and axlsoap.xsd.
•Several API names and tag names are changed to maintain consistency.
•The get and list requests have a new optional tag called returnedTags. This tag has all the tags of that API as optional subtags. If any of the tags are sent in the request, only those tags are returned in the response. Also, there is a new searchCriteria tag in which you can specify the parameters for the search.
•A uuid attribute added to the name tag. There is no uuid tag in any of the operations.
•For internal server errors the AXL returns http code 500 in Unified CM 8.0.
•List API added for every Handler. Specific List APIs like listPhoneByName, listPhoneByDescription, and so on are removed. A listPhone API with a search criteria that can be specified by the user is introduced.
Serviceability XML API
No changes in the Serviceability XML APIs.
Extension Mobility Service API
The following sections describe the Extension Mobility Service API updates made in Cisco Unified Communications Manager 8.0:
•New APIs
•Changed APIs
New APIs
Table 6-2describes new APIs added in Cisco Unified Communications Manager 8.0.
Table 6-2 New APIs in Cisco Unified Communication Manager 8.0
APIs
|
Description
|
LogoutAll
|
This API enables the administrator to logout all users who are currently logged in.
|
DeviceProfileQuery
|
This API gets information of all the device profiles of a user.
|
Changed APIs
No existing APIs are updated in Unified CM release 8.0.
Web Dialer API
No changes in the Web Dialer APIs.
Routing Rules API
The Cisco Unified Routing Rules interface is introduced in the Cisco Unified Communication Manager release 8.0. Cisco Unified Communication Manager 8.0(1) supports the external call control (ECC) feature, which enables an adjunct Route Server to make call-routing decisions for Cisco Unified Communications Manager by using the 8.0(1) Cisco Unified Routing Rules Interface.
Cisco Unified IP Phone Services Application Development Notes
The following are the updates made in the XML service interface for Cisco Unified Communication Manager, release 8.0:
•Support for the latest 9971, 9951, and 8961 series Cisco IP phones.
•The 9971, 9951, 8961 series IP phones does not support the CiscoIPPhoneStatus and CiscoIPPhoneStatusFile XML objects.
•Key URIs supported in 9971, 9951, and 8961 series IP phones and alternate options for unsupported Key URIs.
•Changes in softkey position, behavior, and design.
Feedback