Cisco Unity Connection Provisioning Interface (CUPI) API -- Phone Systems

From DocWiki

Revision as of 17:59, 2 October 2012 by Deeptija (Talk | contribs)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About Phone Systems

This page contains information on how to use the API to create, list, modify, and delete Phone Systems. The phone system pages in Cisco Unity Connection Administration identify the phone systems that Cisco Unity Connection integrates with. In Connection Administration, a phone system has one or more port groups, which in turn have voice messaging ports. You can manage the phone systems to meet the changing needs of your system.


Listing Phone Systems

Example 1

The following is an example of the GET request that lists the Phone Systems:

 https://<connection_server>/vmrest/phonesystems 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<PhoneSystems total="1">
 <PhoneSystem>
   <URI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a</URI>
   <ObjectId>aa6d3f45-ccdf-4fa2-8170-e5c94b51813a</ObjectId>
   <DisplayName>PhoneSystem</DisplayName>
   <MwiAlwaysUpdate>false</MwiAlwaysUpdate>
   <MwiPortMemory>false</MwiPortMemory>
   <CallLoopSupervisedTransferDetect>false</CallLoopSupervisedTransferDetect>
   <CallLoopForwardNotificationDetect>false</CallLoopForwardNotificationDetect>
   <CallLoopDTMF>A</CallLoopDTMF>
   <CallLoopGuardTimeMs>2500</CallLoopGuardTimeMs>
   <PortCount>0</PortCount>
   <EnablePhoneApplications>false</EnablePhoneApplications>
   <DefaultTRaPSwitch>true</DefaultTRaPSwitch>
   <MwiForceOff>false</MwiForceOff>
   <RestrictDialUnconditional>false</RestrictDialUnconditional>
   <RestrictDialScheduled>false</RestrictDialScheduled>
   <RestrictDialStartTime>0</RestrictDialStartTime>
   <RestrictDialEndTime>0</RestrictDialEndTime>
   <CallLoopExtensionDetect>true</CallLoopExtensionDetect>
   <AXLServerURI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a/axlservers</AXLServerURI>
   <PhoneSystemAssociationURI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a/phonesystemassociations</PhoneSystemAssociationURI>
 </PhoneSystem>
</PhoneSystems>
 Response Code: 200 

Example 2

The following is an example of the GET request that lists a particular phone system represented by <phonesystemId>:

 https:/<connection_server>/vmrest/phonesystem/<objectId> 


The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<PhoneSystem>
 <URI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a</URI>
 <ObjectId>aa6d3f45-ccdf-4fa2-8170-e5c94b51813a</ObjectId>
 <DisplayName>PhoneSystem</DisplayName>
 <MwiAlwaysUpdate>false</MwiAlwaysUpdate>
 <MwiPortMemory>false</MwiPortMemory>
 <CallLoopSupervisedTransferDetect>false</CallLoopSupervisedTransferDetect>
 <CallLoopForwardNotificationDetect>false</CallLoopForwardNotificationDetect>
 <CallLoopDTMF>A</CallLoopDTMF>
 <CallLoopGuardTimeMs>2500</CallLoopGuardTimeMs>
 <PortCount>0</PortCount>
 <EnablePhoneApplications>false</EnablePhoneApplications>
 <DefaultTRaPSwitch>true</DefaultTRaPSwitch>
 <MwiForceOff>false</MwiForceOff>
 <RestrictDialUnconditional>false</RestrictDialUnconditional>
 <RestrictDialScheduled>false</RestrictDialScheduled>
 <RestrictDialStartTime>0</RestrictDialStartTime>
 <RestrictDialEndTime>0</RestrictDialEndTime>
 <CallLoopExtensionDetect>true</CallLoopExtensionDetect>
 <AXLServerURI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a/axlservers</AXLServerURI>
 <PhoneSystemAssociationURI>/vmrest/phonesystems/aa6d3f45-ccdf-4fa2-8170-e5c94b51813a/phonesystemassociations</PhoneSystemAssociationURI>
</PhoneSystem>
 Response Code: 200 

Adding a New Phone System

The following is an example of the POST request that adds the Phone Systems:

 https://<connection_server>/vmrest/phonesystems 

The actual response will depend upon the information given by you.

<PhoneSystem>
 <DisplayName>PhoneSystem1</DisplayName>
</PhoneSystem>
 Response Code: 201 

Note: To create a phone system, only the <DisplayName> parameter is mandatory.


Modifying a Phone System

The following is an example of the PUT request that modifies the Phone System as represented by <phonesystemid>:

 https:/<Connection_server>/vmrest/ phonesystem/< objectId > 

The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:

<PhoneSystem>
 <MwiAlwaysUpdate>false</MwiAlwaysUpdate>
 <MwiPortMemory>false</MwiPortMemory>
 <CallLoopSupervisedTransferDetect>false</CallLoopSupervisedTransferDetect>
 <CallLoopForwardNotificationDetect>false</CallLoopForwardNotificationDetect>
 <CallLoopDTMF>A</CallLoopDTMF>
 <CallLoopGuardTimeMs>2500</CallLoopGuardTimeMs>
 <PortCount>2</PortCount>
</PhoneSystem>
 Response Code: 204 

You can also update the following in a phone system:

  • AXL Servers
  • Phone System Associations

AXL Servers

This page contains information on how to use the API to create, list, modify, and delete Phone Systems AXL Servers. AXL servers are supported only for Cisco Unified Communications Manager phone systems and are needed when Cisco Unity Connection must have access to the Cisco Unified CM database for importing Cisco Unified CM users and for changing certain phone settings for users of Connection personal call transfer rules.


Listing AXL Servers

The following is an example of the GET request that lists the Phone Systems:

 https://<connection_server>/vmrest/phonesystems/<objectId>/axlservers 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<AXLServers total="2">
 <AXLServer>
   <URI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b/axlservers/5f3c84e3-8ab1-4fae-a051-bc1db938dae4</URI>
   <ObjectId>5f3c84e3-8ab1-4fae-a051-bc1db938dae4</ObjectId>
   <MediaRemoteServiceEnum>103</MediaRemoteServiceEnum>
   <HostOrIPAddress>0.0.0.0</HostOrIPAddress>
   <Port>0</Port>
   <TlsPort>0</TlsPort>
   <Precedence>0</Precedence>
   <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
   <SkinnyStateMachineEnum>10</SkinnyStateMachineEnum>
   <HostOrIPAddressV6>0:0:0:0:0:0:0:1</HostOrIPAddressV6>
   <CcmAXLUser>abcd</CcmAXLUser>
   <CcmAXLPassword/>
 </AXLServer>
 <AXLServer>
   <URI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b/axlservers/841aafd9-5f84-458c-9a0f-eade9788c1fb</URI>
   <ObjectId>841aafd9-5f84-458c-9a0f-eade9788c1fb</ObjectId>
   <MediaRemoteServiceEnum>103</MediaRemoteServiceEnum>
   <HostOrIPAddress>0.0.0.0</HostOrIPAddress>
   <Port>0</Port>
   <TlsPort>0</TlsPort>
   <Precedence>0</Precedence>
   <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
   <SkinnyStateMachineEnum>10</SkinnyStateMachineEnum>
   <HostOrIPAddressV6>0:0:0:0:0:0:0:1</HostOrIPAddressV6>
   <CcmAXLUser>abcd</CcmAXLUser>
   <CcmAXLPassword/>
 </AXLServer>
</AXLServers>
 Response Code: 200 

Adding New AXL Server

The following is an example of the POST request that adds the AXL servers in the Phone Systems:

 https://<connection_server>/vmrest/phonesystems/<objectId>/axlservers 

The actual response will depend upon the information given by you.

<AXLServer>
 <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
 <MediaRemoteServiceEnum>103</MediaRemoteServiceEnum>
 <HostOrIPAddress>10.105.255.1</HostOrIPAddress>
 <Port>2001</Port>
 <TlsPort>2000</TlsPort>
 <Precedence>1</Precedence>
 <CcmAXLUser>abcd</CcmAXLUser>
 <CcmAXLPassword/>
</AXLServer>
 RESPONSE Code: 201 

Modifying AXL Server

The following is an example of the PUT request that modifies the AXL Server as represented by <axlserverid>:

 https://<connection_server>/vmrest/phonesystems/<objectId>/axlservers/<objectId> 

The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:

<AXLServer>
 <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
 <CcmAXLUser>CiscoCCM</CcmAXLUser>
 <CcmAXLPassword>cisco@1234</CcmAXLPassword>
</AXLServer>
 RESPONSE Code: 204 

Deleting AXL Server

The following is an example of the DELETE request that deletes an AXL Server as represented by < axlserverid >:

 https:/<connection_server>/vmrest/phonesystems/<objectId>/axlservers/<objectId> 

The input for the PUT request will be. The output for this request returns the successful response code.

 RESPONSE Code: 204 

Phone System Associations

This page contains information on how to use the API to list Phone Systems Associations. Phone Systems Associations are required to view a list of all of the Cisco Unity Connection users who are associated with your phone system. Listing Phone System Associations

Listing Phone Systems Associations

The following is an example of the GET request that lists the Phone Systems:

 https://<connection_server>/vmrest/phonesystems/<objectId>/phonesystemassociations 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<PhoneSystemAssociations total="2">
 <PhoneSystemAssociation>
   <URI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b/phonesystemassociations/219ce340-a3a5-428c-8dc6-4776690b69ee</URI>
   <Alias>undeliverablemessagesmailbox</Alias>
   <DisplayName>Papa Recommended Web Application Authentication Rule</DisplayName>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
   <numNotificationDevice>4</numNotificationDevice>
   <numNotificationMWI>1</numNotificationMWI>
   <numPrimaryCallHandler>1</numPrimaryCallHandler>
   <ObjectId>219ce340-a3a5-428c-8dc6-4776690b69ee</ObjectId>
 </PhoneSystemAssociation>
 <PhoneSystemAssociation>
   <URI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b/phonesystemassociations/6b455973-13d1-4b10-871e-1d1d55f160d2</URI>
   <Alias>operator</Alias>
   <DisplayName>Operator</DisplayName>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
   <numNotificationDevice>4</numNotificationDevice>
   <numNotificationMWI>1</numNotificationMWI>
   <numPrimaryCallHandler>1</numPrimaryCallHandler>
   <ObjectId>6b455973-13d1-4b10-871e-1d1d55f160d2</ObjectId>
 </PhoneSystemAssociation>	 
</PhoneSystemAssociations>
 RESPONSE Code: 200 

Deleting a Phone System

The following is an example of the DELETE request that deletes a Phone System as represented by <phonesystemid>:

 https://<server-ip>/vmrest/phonesystems/<objectId> 

The input for the PUT request will be. The output for this request returns the successful response code.

 RESPONSE Code: 204 

Rating: 0.0/5 (0 votes cast)

Personal tools