Cisco Unity Connection Provisioning Interface (CUPI) API -- Ports

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(About Ports)
 
(One intermediate revision not shown)
Line 12: Line 12:
This page contains information on how to use the API to create, list, modify, and delete Ports. The voice messaging ports let Cisco Unity Connection receive calls (for example, to record a message) and let Connection make calls (for example to send message notifications or to set MWIs).  
This page contains information on how to use the API to create, list, modify, and delete Ports. The voice messaging ports let Cisco Unity Connection receive calls (for example, to record a message) and let Connection make calls (for example to send message notifications or to set MWIs).  
-
Each voice messaging port can belong to only one port group. Port groups, when there are several, each have their own voice messaging ports. The total voice messaging ports belonging to all port groups must not exceed the maximum number of voice messaging ports that are enabled by the Connection license files.  
+
Each voice messaging port can belong to only one port group. Port groups, when there are several, each have their own voice messaging ports. The total voice messaging ports belonging to all port groups must not exceed the maximum number of voice messaging ports that are enabled by the Connection license files.
 +
 
 +
For information on minimum software required with this API, see [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_Basic_User_Template_Information#Minimum_Software_Version]]
== Listing Ports ==
== Listing Ports ==

Latest revision as of 09:44, 3 October 2012

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About Ports

This page contains information on how to use the API to create, list, modify, and delete Ports. The voice messaging ports let Cisco Unity Connection receive calls (for example, to record a message) and let Connection make calls (for example to send message notifications or to set MWIs). Each voice messaging port can belong to only one port group. Port groups, when there are several, each have their own voice messaging ports. The total voice messaging ports belonging to all port groups must not exceed the maximum number of voice messaging ports that are enabled by the Connection license files.

For information on minimum software required with this API, see Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_Basic_User_Template_Information#Minimum_Software_Version

Listing Ports

Example 1

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

 https://<connection_server>/vmrest/ports 

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:

<Ports total="2">
 <Port>
   <URI>/vmrest/ports/ec664876-5879-4cff-a022-4929b37bd575</URI>
   <ObjectId>ec664876-5879-4cff-a022-4929b37bd575</ObjectId>
   <MediaPortGroupObjectId>1edf504a-e9a1-4876-bcfc-bb674da8e385</MediaPortGroupObjectId>
   <PortGroupURI>/vmrest/portgroups/1edf504a-e9a1-4876-bcfc-bb674da8e385</PortGroupURI>
   <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
   <VmsServerObjectId>574ca5d3-9041-4ff9-8e7d-727c32d80dab</VmsServerObjectId>
   <DisplayName>PhoneSystem-1-001</DisplayName>
   <CapAnswer>true</CapAnswer>
   <CapNotification>true</CapNotification>
   <CapMWI>true</CapMWI>
   <CapEnabled>true</CapEnabled>
   <CapTrapConnection>true</CapTrapConnection>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <MediaSwitchObjectId>a8eb65f5-795b-41cd-98b1-934f6b987313</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/a8eb65f5-795b-41cd-98b1-934f6b987313</PhoneSystemURI>
   <MediaPortGroupDisplayName>PhoneSystem-1</MediaPortGroupDisplayName>
   <VmsServerName>ucbu-aricent-vm413</VmsServerName>
 </Port>
 <Port>
   <URI>/vmrest/ports/761fa322-63ae-47d9-9fbf-b35142b11eef</URI>
   <ObjectId>761fa322-63ae-47d9-9fbf-b35142b11eef</ObjectId>
   <MediaPortGroupObjectId>1edf504a-e9a1-4876-bcfc-bb674da8e385</MediaPortGroupObjectId>
   <PortGroupURI>/vmrest/portgroups/1edf504a-e9a1-4876-bcfc-bb674da8e385</PortGroupURI>
   <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
   <VmsServerObjectId>574ca5d3-9041-4ff9-8e7d-727c32d80dab</VmsServerObjectId>
   <DisplayName>PhoneSystem-1-002</DisplayName>
   <CapAnswer>true</CapAnswer>
<CapNotification>true</CapNotification>
   <CapMWI>true</CapMWI>
   <CapEnabled>true</CapEnabled>
   <CapTrapConnection>true</CapTrapConnection>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <MediaSwitchObjectId>a8eb65f5-795b-41cd-98b1-934f6b987313</MediaSwitchObjectId>
   <PhoneSystemURI>/vmrest/phonesystems/a8eb65f5-795b-41cd-98b1-934f6b987313</PhoneSystemURI>
   <MediaPortGroupDisplayName>PhoneSystem-1</MediaPortGroupDisplayName>
   <VmsServerName>ucbu-aricent-vm413</VmsServerName>
 </Port>
 RESPONSE Code: 20o 


Example 2

The following is an example of the GET request that lists the Ports configuration:

<Port>
  <URI>/vmrest/ports/e4a48f12-d22b-438c-89eb-0b25f2f73d12</URI>
  <ObjectId>e4a48f12-d22b-438c-89eb-0b25f2f73d12</ObjectId>
  <MediaPortGroupObjectId>668e5869-7c16-48d6-8858-cd0e00fdd47c</MediaPortGroupObjectId>
  <PortGroupURI>/vmrest/portgroups/668e5869-7c16-48d6-8858-cd0e00fdd47c</PortGroupURI>
  <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
  <VmsServerObjectId>d190d99e-e9e8-4d63-8c6c-9aca4956afff</VmsServerObjectId>
  <DisplayName>PhoneSystem-1-002</DisplayName>
  <CapAnswer>true</CapAnswer>
  <CapNotification>false</CapNotification>
  <CapMWI>true</CapMWI>
  <CapEnabled>true</CapEnabled>
  <CapTrapConnection>true</CapTrapConnection>
  <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
  <MediaSwitchObjectId>0d15753c-e1b4-4865-b00b-999a1ccf56ce</MediaSwitchObjectId>
  <PhoneSystemURI>/vmrest/phonesystems/0d15753c-e1b4-4865-b00b-999a1ccf56ce</PhoneSystemURI>
  <MediaPortGroupDisplayName>PhoneSystem-1</MediaPortGroupDisplayName>
  <VmsServerName>ucbu-aricent-vm413</VmsServerName>
</Port>

Adding Ports

This section contains information on how to add ports:

  • Adding SCCP Ports
  • Adding SIP Ports
  • Adding PIMGTIMG Ports

Note: Before adding ports to port group, you need to know the id of the vmservers. The vmservers id is required as you need to mention the machine on which the ports need to be added.

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

 https://<connection_server>/vmrest/vmsservers 


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:

<VmsServers total="1">
 <VmsServer>
   <URI>/vmrest/vmsservers/574ca5d3-9041-4ff9-8e7d-727c32d80dab</URI>
   <ServerName>ucbu-aricent-vm413</ServerName>
   <VmsServerObjectId>574ca5d3-9041-4ff9-8e7d-727c32d80dab</VmsServerObjectId>
 </VmsServer>
</VmsServers>

Note: Make sure that you always add ports in even number and not in odd number.


Adding SCCP Ports

The following is an example of the POST request that lists the SCCP Ports:

 https:/<server_ip>/vmrest/ports 

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

<Port>   
   <MediaPortGroupObjectId>3c011243-e3e2-42f7-b658-d9fbdc966f26</MediaPortGroupObjectId>       
   <VmsServerObjectId>574ca5d3-9041-4ff9-8e7d-727c32d80dab</VmsServerObjectId>
   <HuntOrder>0</HuntOrder>
   <CapAnswer>true</CapAnswer>
   <CapNotification>true</CapNotification>    
   <NumberOfPorts>10</NumberOfPorts>
   <CapEnabled>true</CapEnabled>
   <CapTrapConnection>true</CapTrapConnection>   
   <VmsServerName>ucbu-aricent-vm413</VmsServerName>
</Port>
 RESPONSE Code: 201 


Adding SIP Ports

The following is an example of the POST request that lists the SIP Ports:

 https:/<server_ip>/vmrest/ports 

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

<Port>   
   <MediaPortGroupObjectId>575f43be-f5d0-4af7-a689-06d968227ff7</MediaPortGroupObjectId>      <VmsServerObjectId>574ca5d3-9041-4ff9-8e7d-727c32d80dab</VmsServerObjectId>
   <HuntOrder>0</HuntOrder>
   <DisplayName>PhoneSystem-Rohit-001</DisplayName>
   <CapAnswer>true</CapAnswer>
   <CapNotification>true</CapNotification>    
   <NumberOfPorts>4</NumberOfPorts>
   <CapEnabled>true</CapEnabled>
   <CapTrapConnection>true</CapTrapConnection>   
   <VmsServerName>ucbu-aricent-vm413</VmsServerName>
</Port>
 RESPONSE Code: 201 


Adding PIMGTIMG Ports

The following is an example of the POST request that create the PIMGTIMG Ports:

 https:/<server_ip>/vmrest/ports 

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

<Port> 
  <MediaPortGroupObjectId>2c24f5a9-fb22-47fe-a74b-da9c72d6e7f3</MediaPortGroupObjectId>
  <HuntOrder>0</HuntOrder>
  <DisplayName>PhoneSystem-Rohit-002</DisplayName>
  <CapAnswer>true</CapAnswer>
  <CapNotification>true</CapNotification> 
  <NumberOfPorts>2</NumberOfPorts>
  <CapEnabled>true</CapEnabled>
  <CapTrapConnection>true</CapTrapConnection> 
</Port>
 RESPONSE Code: 201 


The number of ports should be in even number and not in odd number.

Modifying Ports

This section contains information on how to modify Ports:

  • Modifying SCCP Ports
  • Modifying SIP Port


Modifying SCCP Ports

The following is an example of the PUT request that modifies the SCCP Ports:

 https://<connection_server>/vmrest/ports/<sccpobjectId> 

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

<Port>   
 <CapAnswer>true</CapAnswer>
 <CapNotification>true</CapNotification>
 <CapMWI>true</CapMWI>
 <CapTrapConnection>true</CapTrapConnection>
<HuntOrder>0</HuntOrder>
<SkinnySecurityModeEnum>0</SkinnySecurityModeEnum>
<CapEnabled>true</CapEnabled>
</Port>
 RESPONSE Code: 204 


Modifying SIP Ports

The following is an example of the PUT request that modifies the SIP Ports:

 https://<connection_server>/vmrest/ports/<sipobjectIdd> 

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

<Port>   
 <CapAnswer>true</CapAnswer>
 <CapNotification>true</CapNotification>
 <CapMWI>true</CapMWI>
 <CapTrapConnection>true</CapTrapConnection>
 <HuntOrder>0</HuntOrder>
 <SkinnySecurityModeEnum>0</SkinnySecurityModeEnum>
 <CapEnabled>true</CapEnabled>
</Port>
 RESPONSE Code: 204 


Deleting ports

The following is an example of the DELETE request that deletes a Port as represented by <portId>:

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


The output for this request returns the successful response code.

 RESPONSE Code: 204 

Rating: 0.0/5 (0 votes cast)

Personal tools