Cisco Cisco Prime Collaboration 10.5 Developer's Guide

Page of 81
 
 
© 2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
17 
Voicemail Profile 
IC_name 
Voice Region 
IC_name 
VG202 
IC_name 
VG204 
IC_name 
VG224 
IC_name 
 
Subscriber Product Key Attributes 
 lists the key attributes for subscriber products. Any subscriber product not listed does not have any key 
attributes. 
Table 9: Status Code ENUMS for CupmApiStatusValue  Attribute 
Subscriber Product 
Key Attributes 
Phone 
o
 
type (for example, Cisco_7970) 
o
 
macaddress (for all phone types except for 
          Cisco_IP_Communicator, CTI_Port, CUPC) 
o
 
devicename (only for the phone types Cisco_IP_Communicator, 
          CTI_Port, and CUPC) 
Line 
o
 
directorynumber 
o
 
routepartition 
o
 
selectedPhone
LineOnSharedPhone 
o
 
directorynumber 
o
 
routepartition 
o
 
targetphone
EM_Access 
Name 
EM_Line 
o
 
directorynumber 
o
 
routepartition 
o
 
SelectedEM_Access 
Voicemail 
VoicemailAlias 
Email 
Alias 
UnifiedMessaging 
SelectedEmail 
 
1. 
All selectedPhone and targetPhone names are MAC addresses. MAC addresses consist of 12 hexadecimal characters (0-9 and A-F). 
For a physical phone on Cisco Unified Communications Manager, the name can be the MAC address preceded by SEP (for example, 
SEPAAAA00001111), or the MAC address preceded by BAT in the case of a TAPS phone (for example, BATAAAA00001111). For a 
physical phone on Cisco Unified Communications Manager Express, nothing precedes the MAC address. 
Note: For XML returned objects with keys and all product attributes, send the getSubscrberService and 
getConfiguredInfraProduct requests querying existing services, or the listSubscriberService and 
listConfiguredInfraProduct requests for subscribers and devices respectively, with a filter set to return all attributes. 
Referencing Product Attributes from the Product Catalog 
The product catalog defines all infrastructure and subscriber products that can be ordered using Prime 
Collaboration Provisioning. The product definition is in the productdirectory\schema directory in the 
product_catalog_translated.xsd file. Each orderable product is defined in a file in the productcatalog\metadata 
folder. For example, the HuntList file name is CUPMProduct_IC_HuntList.xml. 
For all products, the attribute’s name and type are defined in these files. Each file contains the <product> tag to 
define the product name and the <productAttribute> tag to define the product attribute name. The ID of the 
<productAttribute> tag should be used in the data file. The <name> tag of the <productAttribute> tag explains what 
the attribute does.