Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Profiles

From DocWiki

Latest revision as of 09:46, 3 October 2012

Links to Other API pages: Cisco_Unity_Connection_APIs

Listing SIP Profiles

Generic Examples to List SIP Profiles

Example 1

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

 https:/<server_ip>/vmrest/sipsecurityprofiles 

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:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SipSecurityProfiles total="2"><SipSecurityProfile>
 <URI>/vmrest/sipsecurityprofiles/87cab9a5-c68d-447a-ab4f-7cd2837aa240</URI>
 <ObjectId>87cab9a5-c68d-447a-ab4f-7cd2837aa240</ObjectId><Port>5069</Port>
 <DoTLS>false</DoTLS><DisplayName>5069</DisplayName>
 </SipSecurityProfile><SipSecurityProfile>
 <URI>/vmrest/sipsecurityprofiles/4d7e055a-cdcf-43ff-a922-4ce743939a23</URI>
 <ObjectId>4d7e055a-cdcf-43ff-a922-4ce743939a23</ObjectId><Port>5066</Port>
 <DoTLS>true</DoTLS><DisplayName>5066/TLS</DisplayName>
</SipSecurityProfile></SipSecurityProfiles>

<Pre> RESPONSE Code: 200 

Example 2

The following is an example of the GET request that lists a specified SIP Profile:

 https://<connection_server>/vmrest/sipsecurityprofiles/<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:

<SipSecurityProfile>
 <URI>/vmrest/sipsecurityprofiles/87cab9a5-c68d-447a-ab4f-7cd2837aa240</URI>
 <ObjectId>87cab9a5-c68d-447a-ab4f-7cd2837aa240</ObjectId><Port>5069</Port>
 <DoTLS>false</DoTLS><DisplayName>5069</DisplayName>
</SipSecurityProfile><SipSecurityProfile>

<pre> Response code: 200 

JSON Examples to List SIP Profiles

Example 1

The following is a JSON example of the GET request that lists the SIP Profiles:

 https:/<connection_server>/vmrest/sipsecurityprofiles 

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:

{
  "@total": "6",
  "SipSecurityProfile":    
  {
    "URI": "/vmrest/sipsecurityprofiles/08aef04e-8775-4ea5-916b-f7e36cbdb3d4",
    "ObjectId": "08aef04e-8775-4ea5-916b-f7e36cbdb3d4",
    "Port": "5065",
    "DoTLS": "true",
    "DisplayName": "5065/TLS"
  },
  {
    "URI": "/vmrest/sipsecurityprofiles/b3c533a4-bc28-4c70-9912-c22edf81910e",
    "ObjectId": "b3c533a4-bc28-4c70-9912-c22edf81910e",
    "Port": "5062",
    "DoTLS": "true",
    "DisplayName": "5062/TLS"
   },
   {
     "URI": "/vmrest/sipsecurityprofiles/e667342c-3ce2-49f7-ae2b-27daf850b159",
     "ObjectId": "e667342c-3ce2-49f7-ae2b-27daf850b159",
     "Port": "5088",
     "DoTLS": "true",
     "DisplayName": "5088/TLS"
   },
   {
     "URI": "/vmrest/sipsecurityprofiles/9062519a-05d4-42f2-933e-250d5a24efb5",
     "ObjectId": "9062519a-05d4-42f2-933e-250d5a24efb5",
     "Port": "5067",
     "DoTLS": "false",
     "DisplayName": "5067"
   },
   {
     "URI": "/vmrest/sipsecurityprofiles/9adbf7ac-c882-4ad1-84d5-d67d56d44d6d",
     "ObjectId": "9adbf7ac-c882-4ad1-84d5-d67d56d44d6d",
     "Port": "5077",
     "DoTLS": "false",
     "DisplayName": "5077"
   },
   {
     "URI": "/vmrest/sipsecurityprofiles/15a3a4d9-65a0-456a-be38-4a4aff36554c",
     "ObjectId": "15a3a4d9-65a0-456a-be38-4a4aff36554c",
     "Port": "5060",
     "DoTLS": "false",
     "DisplayName": "5060"
   }
   
}

<pre> RESPONSE Code: 200 

Example 2

The following is a example of the GET request that lists a specified SIP Profile:

 https://<connection_server>/vmrest/sipsecurityprofiles/<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:

{
   "URI": "/vmrest/sipsecurityprofiles/9adbf7ac-c882-4ad1-84d5-d67d56d44d6d",
   "ObjectId": "9adbf7ac-c882-4ad1-84d5-d67d56d44d6d",
   "Port": "5077",
   "DoTLS": "false",
   "DisplayName": "5077"
}

 RESPONSE Code: 200 

Adding a new SIP Profiles

Example 1

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

 https://<connection_server>/vmrest/sipsecurityprofiles 

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:

<SipSecurityProfile>
 <Port>5070</Port>
 <DoTLS>true</DoTLS>
</SipSecurityProfile>

 Response code: 201 

Example 2

The following is a JSON example of the POST request that lists the SIP Profiles:

 https://<connection_server>/vmrest/sipsecurityprofiles 

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": "5080",
   "DoTLS": "true"
}

 Response code: 201 

Modifying SIP Profiles

Example 1

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

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

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

<SipSecurityProfile>
 <Port>5070</Port>
 <DoTLS>true</DoTLS>
 </SipSecurityProfile>

 Response code: 204 

Example 2

The following is a JSON example of the PUT request that modifies the SIP Profile:

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

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

{
   "Port": "5077",
   "DoTLS": "true"
}

 Response code: 204 

Deleting SIP Profiles

The following is an example of the DELETE request that deletes a specified SIP Profiles as represented by <sipsecurityprofileid>:

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

The output for this request returns the successful response code.

 Response Code: 204 

Minimum Software Version

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