Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups

From DocWiki

Revision as of 11:01, 1 November 2013 by Deeptija (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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 Port Group

Port groups hold most of the integration configuration settings and some or all of the voice messaging ports for Cisco Unity Connection. This page contains information on how to use the API to create, list, modify, and delete Port Groups. Port groups hold most of the integration configuration settings and some or all of the voice messaging ports for Cisco Unity Connection. While most phone system integrations need only one port group, multiple port groups may be needed in the following circumstances:

  • For integrations with phone systems through PIMG/TIMG units, each PIMG/TIMG unit is connected to one port group with the applicable voice messaging ports. For example, a system that uses five PIMG units requires five port groups, one port group for each PIMG unit.
  • For integrations with other phone systems, an additional port group with its own voice messaging ports may be used for testing a new configuration or for troubleshooting.

In Cisco Unity Connection, you can create three types of port groups:

  • SCCP (Skinny)
  • SIP
  • SIP to DMG
  • Connection port groups provide flexibility for integration configuration settings that apply to different sets of ports.
  • Administrator can use this API to create/update/fetch/delete the port groups API. It can be used to fetch the list of port groups and also a single instance of port group.


Listing Port Group

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

 https://<connection_server>/vmrest/portgrouptemplates 

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:

<PortGroups total="3">
 <PortGroup>
   <URI>/vmrest/portgroups/eee76668-7d26-4e74-ba61-b41630c2819e</URI>
   <MediaPortGroupTemplateObjectId>
   90dd306f-b8af-46b6-8289-f13437cc1e5e
   </MediaPortGroupTemplateObjectId>
   <MediaSwitchObjectId>
   72c5dbe6-9590-40c5-b668-9c599eedf125
   </MediaSwitchObjectId>
   <PhoneSystemURI>
   /vmrest/phonesystems/72c5dbe6-9590-40c5-b668-9c599eedf125
   </PhoneSystemURI>
   <TelephonyIntegrationMethodEnum>1</TelephonyIntegrationMethodEnum>
   <EnableMWI>true</EnableMWI>
   <DisplayName>PhoneSystem-SCCP</DisplayName>
   <EnableAGC>true</EnableAGC>
   <CcmDoAutoFailback>true</CcmDoAutoFailback>
   <MwiRetryCountOnSuccess>1</MwiRetryCountOnSuccess>
   <MwiRetryIntervalOnSuccessMs>2</MwiRetryIntervalOnSuccessMs>
   <ObjectId>eee76668-7d26-4e74-ba61-b41630c2819e</ObjectId>
   <SkinnyDevicePrefix>VVMSetup-VI</SkinnyDevicePrefix>
   <MwiMinRequestIntervalMs>4</MwiMinRequestIntervalMs>
   <OutgoingGuardTimeMs>2500</OutgoingGuardTimeMs>
   <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
   <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
   <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
   <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
   <MwiMaxConcurrentRequests>3</MwiMaxConcurrentRequests>
   <MediaSwitchDisplayName>PhoneSystem123</MediaSwitchDisplayName>
   <PortCount>0</PortCount>
   <SipDoSRTP>true</SipDoSRTP>
   <SipTLSModeEnum>11</SipTLSModeEnum>
   <ResetStatusEnum>0</ResetStatusEnum>
   <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
   <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
   <NoiseFreeEnable>true</NoiseFreeEnable>
   <PortGroupServerURI>
   /vmrest/portgroups/eee76668-7d26-4e74-ba61-b41630c2819e/portgroupservers
   </PortGroupServerURI>
   <PortGroupCodecURI>
   /vmrest/portgroups/eee76668-7d26-4e74-ba61-b41630c2819e/portgroupcodecs
   </PortGroupCodecURI>
   <PortURI>/vmrest/ports/</PortURI>
 </PortGroup>	 
<PortGroup>
   <URI>/vmrest/portgroups/9339356b-133c-4d89-b6e2-a10243dbdebb</URI>
   <MediaPortGroupTemplateObjectId>
   04e0e286-56ed-4f27-a325-756a49dd98e1
   </MediaPortGroupTemplateObjectId>
   <MediaSwitchObjectId>
   24f1171f-27b3-4ad3-a94c-66d1fb2e448b
   </MediaSwitchObjectId>
   <PhoneSystemURI>
   /vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b
   </PhoneSystemURI>
   <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
   <EnableMWI>true</EnableMWI>
   <DisplayName>PhoneSystem-SIP</DisplayName>
   <EnableAGC>true</EnableAGC>
   <CcmDoAutoFailback>true</CcmDoAutoFailback>
   <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
   <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
   <ObjectId>9339356b-133c-4d89-b6e2-a10243dbdebb</ObjectId>
   <SipContactLineName/>
   <SipTransportProtocolEnum>11</SipTransportProtocolEnum>
   <SipRegisterWithProxyServer>false</SipRegisterWithProxyServer>
   <SipDoAuthenticate>false</SipDoAuthenticate>
   <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
   <OutgoingGuardTimeMs>0</OutgoingGuardTimeMs>
   <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
   <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
   <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
   <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
   <MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <PortCount>0</PortCount>
   <WaitForCallInfoMs>0</WaitForCallInfoMs>
   <SipDoSRTP>true</SipDoSRTP>
   <SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
   <SipDoDtmfKPML>true</SipDoDtmfKPML>
   <MediaSipSecurityProfileObjectId>
   4d7e055a-cdcf-43ff-a922-4ce743939a23
   </MediaSipSecurityProfileObjectId>
   <MediaCertificateObjectId>
   c55ef2c3-2475-4505-9566-bcea04a6bb6e
   </MediaCertificateObjectId>
   <SipTLSModeEnum>10</SipTLSModeEnum>
   <ResetStatusEnum>0</ResetStatusEnum>
   <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
   <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
   <NoiseFreeEnable>true</NoiseFreeEnable>
   <PortGroupServerURI>
   /vmrest/portgroups/9339356b-133c-4d89-b6e2-a10243dbdebb/portgroupservers
   </PortGroupServerURI>
   <PortGroupCodecURI>
   /vmrest/portgroups/9339356b-133c-4d89-b6e2-a10243dbdebb/portgroupcodecs
   </PortGroupCodecURI>
   <PortURI>/vmrest/ports/</PortURI>
 </PortGroup>	 
 <PortGroup>
   <URI>/vmrest/portgroups/1404ccd1-45c9-4fb8-9660-5b04cae3373f</URI>
   <MediaPortGroupTemplateObjectId>
   8fc4952c-aa4f-4b96-a4b3-dbe26e49d899
   </MediaPortGroupTemplateObjectId>
   <MediaSwitchObjectId>
   24f1171f-27b3-4ad3-a94c-66d1fb2e448b
   </MediaSwitchObjectId>
   <PhoneSystemURI>
   /vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b
   </PhoneSystemURI>
   <TelephonyIntegrationMethodEnum>3</TelephonyIntegrationMethodEnum>
   <EnableMWI>true</EnableMWI>
   <DisplayName>PIMG-1</DisplayName>
   <EnableAGC>true</EnableAGC>
   <CcmDoAutoFailback>true</CcmDoAutoFailback>
   <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
   <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
   <ObjectId>1404ccd1-45c9-4fb8-9660-5b04cae3373f</ObjectId>
   <SipTransportProtocolEnum>10</SipTransportProtocolEnum>
   <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
   <OutgoingGuardTimeMs>1000</OutgoingGuardTimeMs>
   <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
   <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
   <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
   <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
   <MwiReqPortSpecific>true</MwiReqPortSpecific>
   <MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <PortCount>0</PortCount>
   <WaitForCallInfoMs>0</WaitForCallInfoMs>
   <SipDoSRTP>true</SipDoSRTP>
   <SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
   <SipDoDtmfKPML>true</SipDoDtmfKPML>
   <MediaSipSecurityProfileObjectId>
   87cab9a5-c68d-447a-ab4f-7cd2837aa240
   </MediaSipSecurityProfileObjectId>
   <SipTLSModeEnum>11</SipTLSModeEnum>
   <ResetStatusEnum>0</ResetStatusEnum>
   <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
   <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
   <NoiseFreeEnable>true</NoiseFreeEnable>
   <PortGroupServerURI>
   /vmrest/portgroups/1404ccd1-45c9-4fb8-9660-5b04cae3373f/portgroupservers
   </PortGroupServerURI>
   <PortGroupCodecURI>
   /vmrest/portgroups/1404ccd1-45c9-4fb8-9660-5b04cae3373f/portgroupcodecs
   </PortGroupCodecURI>
   <PortURI>/vmrest/ports/</PortURI>
 </PortGroup>
</PortGroups>
 RESPONSE Code: 200 

JSON Example

To list all port groups configured, do the following:

Request URI:
GET https://<connection-server>/vmrest/portgroups
Accept: application /json
Connection: keep-alive

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

{
  "@total": "1", 
  "PortGroup":
  {
     "URI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-8a220a081990",
     "MediaPortGroupTemplateObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1",
     "MediaSwitchObjectId": "f92e948f-6bd4-4891-ab8b-a3d930688305",
     "PhoneSystemURI": "/vmrest/phonesystems/f92e948f-6bd4-4891-ab8b-a3d930688305",
     "TelephonyIntegrationMethodEnum": "2",
     "EnableMWI": "true",
     "DisplayName": "demo_PhoneSystem_1-1",
     "EnableAGC": "true",
     "CcmDoAutoFailback": "true",
     "MwiRetryCountOnSuccess": "0",
     "MwiRetryIntervalOnSuccessMs": "5",
     "ObjectId": "74a008c0-bdc6-4e4b-a304-8a220a081990",
     "SipContactLineName": "",
     "SipTransportProtocolEnum": "11",
     "SipRegisterWithProxyServer": "false",
     "SipDoAuthenticate": "false",
     "MwiMinRequestIntervalMs": "0",
     "OutgoingGuardTimeMs": "0",
     "OutgoingPostDialDelayMs": "50",
     "OutgoingPreDialDelayMs": "0",
     "DelayBeforeOpeningMs": "0",
     "DtmfDialInterDigitDelayMs": "300",
     "MwiMaxConcurrentRequests": "0",
     "MediaSwitchDisplayName": "demo_PhoneSystem_1",
     "PortCount": "2",
     "WaitForCallInfoMs": "0",
     "SipDoSRTP": "true",
     "SipDoDtmfRfc2833": "true",
     "SipDoDtmfKPML": "true",
     "MediaSipSecurityProfileObjectId": "34e62bbf-a2f8-4281-8b1e-90af4985344e",
     "SipTLSModeEnum": "11",
     "ResetStatusEnum": "0",
     "RecordingDTMFClipMs": "170",
     "RecordingToneExtraClipMs": "250",
     "PreferredCallControl": "0",
     "SipPreferredMedia": "0",
     "NoiseFreeEnable": "true",
     "PortGroupServerURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
     8a220a081990/portgroupservers",
     "PortGroupCodecURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
     8a220a081990/portgroupcodecs",
     "PortURI": "/vmrest/ports/"
  }
}
Response Code: 200

Viewing Details of a Specific Port Group

The following is an example of the GET request that will list details of a particular port group that is represented by an object ID:

GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>

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

<PortGroup>
     <URI>/vmrest/portgroups/ae5656cf-819f-4235-a566-a485ed665eb3</URI>
     <MediaPortGroupTemplateObjectId>04e0e286-56ed-4f27-a325-
  756a49dd98e1</MediaPortGroupTemplateObjectId>
     <MediaSwitchObjectId>5bfd3bae-0c37-4d20-8066-c3065431fc41</MediaSwitchObjectId>
     <PhoneSystemURI>/vmrest/phonesystems/5bfd3bae-0c37-4d20-8066-
  c3065431fc41</PhoneSystemURI>
     <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
     <EnableMWI>true</EnableMWI>
<DisplayName>PhoneSystem-2</DisplayName>
<EnableAGC>true</EnableAGC>
<CcmDoAutoFailback>true</CcmDoAutoFailback>
<MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
<MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
<ObjectId>ae5656cf-819f-4235-a566-a485ed665eb3</ObjectId>
<SipContactLineName>line</SipContactLineName>
<SipTransportProtocolEnum>11</SipTransportProtocolEnum>
<SipRegisterWithProxyServer>false</SipRegisterWithProxyServer>
<SipDoAuthenticate>true</SipDoAuthenticate>
<SipAuthenticateAsUser>SIPUser</SipAuthenticateAsUser>
<SipAuthenticatePassword>TY1U18Zb0s6xg6UAFpyhnw==</SipAuthenticatePassword>
<MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
<OutgoingGuardTimeMs>0</OutgoingGuardTimeMs>
<OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
<OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
<DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
<DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
<MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
<PortCount>0</PortCount>
<WaitForCallInfoMs>0</WaitForCallInfoMs>
<SipDoSRTP>true</SipDoSRTP>
<SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
<SipDoDtmfKPML>true</SipDoDtmfKPML>
<MediaSipSecurityProfileObjectId>8275234c-6ea4-4a4b-87c1-
74abe1394415</MediaSipSecurityProfileObjectId>
<SipTLSModeEnum>11</SipTLSModeEnum>
<ResetStatusEnum>0</ResetStatusEnum>
<RecordingDTMFClipMs>170</RecordingDTMFClipMs>
<RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
<NoiseFreeEnable>true</NoiseFreeEnable>
<PortGroupServerURI>/vmrest/portgroups/ae5656cf-819f-4235-a566-
a485ed665eb3/portgroupservers</PortGroupServerURI>
<PortGroupCodecURI>/vmrest/portgroups/ae5656cf-819f-4235-a566-
a485ed665eb3/portgroupcodecs</PortGroupCodecURI>
<PortURI>/vmrest/ports/</PortURI>
</PortGroup>
Response Code: 200
JSON Example
To list a particular port group, do the following:
GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>
Accept: application/json
Connection: keep-alive
The following is the response from the above *GET* request and the actual response will depend upon
the information given by you:
{
"URI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-8a220a081990",
"MediaPortGroupTemplateObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1",
"MediaSwitchObjectId": "f92e948f-6bd4-4891-ab8b-a3d930688305",
"PhoneSystemURI": "/vmrest/phonesystems/f92e948f-6bd4-4891-ab8b-a3d930688305",
"TelephonyIntegrationMethodEnum": "2",
"EnableMWI": "true",
"DisplayName": "demo_PhoneSystem_1-1",
"EnableAGC": "true",
"CcmDoAutoFailback": "true",
"MwiRetryCountOnSuccess": "0",
"MwiRetryIntervalOnSuccessMs": "5",
"ObjectId": "74a008c0-bdc6-4e4b-a304-8a220a081990",
"SipContactLineName": "",
"SipTransportProtocolEnum": "11",
"SipRegisterWithProxyServer": "false",
"SipDoAuthenticate": "false",
"MwiMinRequestIntervalMs": "0",
"OutgoingGuardTimeMs": "0",
"OutgoingPostDialDelayMs": "50",
"OutgoingPreDialDelayMs": "0",
"DelayBeforeOpeningMs": "0",
"DtmfDialInterDigitDelayMs": "300",
"MwiMaxConcurrentRequests": "0",
"MediaSwitchDisplayName": "demo_PhoneSystem_1",
"PortCount": "2",
"WaitForCallInfoMs": "0",
"SipDoSRTP": "true",
"SipDoDtmfRfc2833": "true",
"SipDoDtmfKPML": "true",
"MediaSipSecurityProfileObjectId": "34e62bbf-a2f8-4281-8b1e-90af4985344e",
"SipTLSModeEnum": "11",
"ResetStatusEnum": "0",
"RecordingDTMFClipMs": "170",
"RecordingToneExtraClipMs": "250",
"PreferredCallControl": "0",
"SipPreferredMedia": "0",
"NoiseFreeEnable": "true",
"PortGroupServerURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
8a220a081990/portgroupservers",
"PortGroupCodecURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
8a220a081990/portgroupcodecs",
"PortURI": "/vmrest/ports/"
}
Response Code: 200

== Port Group Templates ==
Port group templates list the configuration supported by various types of integrated port groups.


=== Viewing Port Group Templates Information ===

The following is an example of the GET request that lists the port group templates:
<pre>
GET https://< connection-server>/vmrest/portgrouptemplates

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

<PortGroupTemplates total="3">
  <PortGroupTemplate>
     <URI>/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e</URI>
     <CopyTelephonyIntegrationMethodEnum>1</CopyTelephonyIntegrationMethodEnum>
     <ObjectId>90dd306f-b8af-46b6-8289-f13437cc1e5e</ObjectId>
     <TemplateDescriptionDefault>SCCP</TemplateDescriptionDefault>
  </PortGroupTemplate>
  <PortGroupTemplate>
     <URI>/vmrest/portgrouptemplates/04e0e286-56ed-4f27-a325-756a49dd98e1</URI>
     <CopyTelephonyIntegrationMethodEnum>2</CopyTelephonyIntegrationMethodEnum>
     <ObjectId>04e0e286-56ed-4f27-a325-756a49dd98e1</ObjectId>
     <TemplateDescriptionDefault>SIP</TemplateDescriptionDefault>
  </PortGroupTemplate>
  <PortGroupTemplate>
     <URI>/vmrest/portgrouptemplates/8fc4952c-aa4f-4b96-a4b3-dbe26e49d899</URI>
     <CopyTelephonyIntegrationMethodEnum>3</CopyTelephonyIntegrationMethodEnum>
     <ObjectId>8fc4952c-aa4f-4b96-a4b3-dbe26e49d899</ObjectId>
     <TemplateDescriptionDefault>SIP to DMG/PIMG/TIMG</TemplateDescriptionDefault>
  </PortGroupTemplate>
</PortGroupTemplates>
Response Code: 200

JSON Example

To view the port group templates information, do the following: Request URI: GET https://<connection-server>/vmrest/portgrouptemplates Accept: application /json Connection: keep-alive The following is the response from the above *GET* request and the actual response will depend upon the information given by you: {

 "@total": "3",
 "PortGroupTemplate": [
 {
    "URI": "/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e",
    "CopyTelephonyIntegrationMethodEnum": "1",
    "ObjectId": "90dd306f-b8af-46b6-8289-f13437cc1e5e",
    "TemplateDescriptionDefault": "SCCP"
 },
 {
    "URI": "/vmrest/portgrouptemplates/04e0e286-56ed-4f27-a325-756a49dd98e1",
    "CopyTelephonyIntegrationMethodEnum": "2",
    "ObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1",
    "TemplateDescriptionDefault": "SIP"
 },
 {
    "URI": "/vmrest/portgrouptemplates/8fc4952c-aa4f-4b96-a4b3-dbe26e49d899",
    "CopyTelephonyIntegrationMethodEnum": "3",
    "ObjectId": "8fc4952c-aa4f-4b96-a4b3-dbe26e49d899",
    "TemplateDescriptionDefault": "SIP to DMG/PIMG/TIMG"
 }
 ]

} </pre>

Response Code: 200


Listing Port Group Templates

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

 https://<connection_server>/vmrest/portgrouptemplates 

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:

<PortGroupTemplates total="3">
 <PortGroupTemplate>
   <URI>/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e</URI>
   <CopyTelephonyIntegrationMethodEnum>1</CopyTelephonyIntegrationMethodEnum>
   <ObjectId>90dd306f-b8af-46b6-8289-f13437cc1e5e</ObjectId>
   <TemplateDescriptionDefault>SCCP</TemplateDescriptionDefault>
 </PortGroupTemplate>
 <PortGroupTemplate>
   <URI>/vmrest/portgrouptemplates/04e0e286-56ed-4f27-a325-756a49dd98e1</URI>
   <CopyTelephonyIntegrationMethodEnum>2</CopyTelephonyIntegrationMethodEnum>
   <ObjectId>04e0e286-56ed-4f27-a325-756a49dd98e1</ObjectId>
   <TemplateDescriptionDefault>SIP</TemplateDescriptionDefault>
 </PortGroupTemplate>
 <PortGroupTemplate>
   <URI>/vmrest/portgrouptemplates/8fc4952c-aa4f-4b96-a4b3-dbe26e49d899</URI>
   <CopyTelephonyIntegrationMethodEnum>3</CopyTelephonyIntegrationMethodEnum>
   <ObjectId>8fc4952c-aa4f-4b96-a4b3-dbe26e49d899</ObjectId>
   <TemplateDescriptionDefault>SIP to DMG/PIMG/TIMG</TemplateDescriptionDefault>
 </PortGroupTemplate>
</PortGroupTemplates>	 
 RESPONSE Code: 200 


Creating New Port Group

This section contains information on how to create port groups:

  • Creating SCCP Port Group
  • Creating SIP Port Group
  • Creating PIMG/TIMG Port Group

Creating SCCP Port Group

For each SCCP port group, you need to enter a value for the following parameters:

  • DisplayName: Enter the display name of the port group.
  • MediaPortGroupTemplateObjectID: The ID of the port group template used for creating the port group. For more information, refer to the Port Group Template section.
  • TelephonyIntegrationMethodEnum: Enter the value “1” to create SCCP port group.
  • HostorIpAddress: Enter the hostname or the IP address of the system on which you want to create port group.

Obtain MediaSwitchObjectId using the following URI:

GET https://<connection-server>/vmrest/phonesystems

Obtain MediaPortGroupTemplateObjectId using the following URI:

GET https://<connection-server>/vmrest/portgrouptemplates

The following is an example of the POST request that will create an SCCP port group:

  POST https://< connection-server>/vmrest/portgroups
Request Body:
<PortGroup>
     <MediaSwitchObjectId>5bfd3bae-0c37-4d20-8066-c3065431fc41</MediaSwitchObjectId>
     <MediaPortGroupTemplateObjectId>90dd306f-b8af-46b6-8289-
  f13437cc1e5e</MediaPortGroupTemplateObjectId>
     <DisplayName>PhoneSystem-6</DisplayName>
     <TelephonyIntegrationMethodEnum>1</TelephonyIntegrationMethodEnum>
     <SkinnyDevicePrefix>Test1-VI</SkinnyDevicePrefix>
     <HostOrIPAddress>10.10.10.10</HostOrIPAddress>
</PortGroup>

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example

To create an SCCP port group, do the following:

POST https://<connection-server>/vmrest/portgroups
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaSwitchObjectId":"8a009b99-22cf-4305-822d-f5e449a42263",
     "MediaPortGroupTemplateObjectId":"90dd306f-b8af-46b6-8289-f13437cc1e5e",
     "DisplayName":"PhoneSystem-6",
     "TelephonyIntegrationMethodEnum":"1",
     "SkinnyDevicePrefix":"Test1-VI",
     "HostOrIPAddress","10.10.10.10"
}

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263


Creating SIP Port Group

For each SIP port group, you need to enter a value for the following parameters:

  • DisplayName: Enter the display name of the port group.
  • MediaPortGroupTemplateObjectID: The ID of the port group template used for creating the port group. For more information, refer to the Port Group Template section.
  • TelephonyIntegrationMethodEnum: Enter the value “2” to create SIP port group.
  • HostorIpAddress: Enter the hostname or the IP address of the system on which you want to create port group.

Obtain MediaSwitchObjectId using the following URI:

GET https://<connection-server>/vmrest/phonesystems

Obtain MediaPortGroupTemplateObjectId using the following URI:

GET https://<connection-server>/vmrest/portgrouptemplates

The following is an example of the POST request that will create a SIP port group:

POST https://< connection-server>/vmrest/portgroups

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example

To create an SIP port group:

POST https://<connection-server>/vmrest/portgroups
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaSwitchObjectId":"8a009b99-22cf-4305-822d-f5e449a42263",
     "MediaPortGroupTemplateObjectId":"90dd306f-b8af-46b6-8289-f13437cc1e5e",
     "DisplayName":"PhoneSystem-7",
     "TelephonyIntegrationMethodEnum":"2",
     "HostOrIPAddress":"10.10.10.10",
     "ResetStatusEnum":"0",
     "EnableMWI":"true",
     "MwiOnCode":"1",
     "MwiOffCode":"1",
     "MwiRetryCountOnSuccess":"1",
     "MwiRetryIntervalOnSuccessMs":"2",
     "MwiMaxConcurrentRequests":"3",
     "MwiMinRequestIntervalMs":"4"
}

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263


Creating PIMG/TIMG Port Group

The following is an example of the POST request that will create a PIMG/TIMG port group:

  POST https://< connection-server>/vmrest/portgroups/<objectId>
Request Body:
<PortGroup>
     <MediaPortGroupTemplateObjectId>8fc4952c-aa4f-4b96-a4b3-
     dbe26e49d899</MediaPortGroupTemplateObjectId>
     <MediaSwitchObjectId>0d15753c-e1b4-4865-b00b-999a1ccf56ce</MediaSwitchObjectId>
     <TelephonyIntegrationMethodEnum>3</TelephonyIntegrationMethodEnum>
     <DisplayName>PIMG-2</DisplayName>
     <HostOrIPAddress>10.78.171.157</HostOrIPAddress>
</PortGroup>

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example To create a PIMG/TIMG port group, do the following:

POST https://<connection-server>/vmrest/portgroups
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaSwitchObjectId":"8a009b99-22cf-4305-822d-f5e449a42263",
     "MediaPortGroupTemplateObjectId":"90dd306f-b8af-46b6-8289-f13437cc1e5e",
     "DisplayName":"PIMG-2",
     "TelephonyIntegrationMethodEnum":"3",
     "HostOrIPAddress":"10.78.171.157"
}

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

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263


Adding New Port Group

This section contains information on how to create port groups:

  • Adding SCCP Port Group
  • Adding SIP Port Group
  • Adding PIMGTIMG Port Group

Adding SCCP Port Group

The following is an example of the POST request that adds the Port Group:

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

Note: The <objectId> is the id of your phone system.

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

For each SCCP port group, you need to enter a value for the following parameters:

  • DisplayName: Enter the display name of the port group.
  • TelephonyIntegrationMethodEnum: Enter the value “1” to create SCCP port Group
  • HostorIpAddress: Enter the Hostname or the IP Address of the system on which you want to create port group.

Adding SIP Port Groups

The following is an example of the POST request that adds the Port Group:

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

Note: The <objectId> is the id of your phone system.

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

<PortGroup>    
 <MediaSwitchObjectId>
 9821a50b-26e7-409e-b2fe-4b1c3953530d
 </MediaSwitchObjectId>
 <MediaPortGroupTemplateObjectId>
 04e0e286-56ed-4f27-a325-756a49dd98e1
 </MediaPortGroupTemplateObjectId>
 <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
 <EnableMWI>true</EnableMWI>
 <DisplayName>PhoneSystem-SIPSANJAY12345678</DisplayName>
 <EnableAGC>true</EnableAGC>
 <CcmDoAutoFailback>true</CcmDoAutoFailback>
 <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
 <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
 <SipTransportProtocolEnum>11</SipTransportProtocolEnum>
 <SipRegisterWithProxyServer>false</SipRegisterWithProxyServer>
 <SipDoAuthenticate>false</SipDoAuthenticate>
 <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
 <HostOrIPAddress>10.78.171.158</HostOrIPAddress>
 <SipTLSModeEnum>11</SipTLSModeEnum>
</PortGroup>
 RESPONSE Code: 201 

For each SIP port group, you need to enter a value for the following parameters:

  • DisplayName: Enter the display name of the port group.
  • MediaPortGroupTemplateObjectID: The id of the port group template used for creating the port group. For More information, refer to Port Group Template section.
  • TelephonyIntegrationMethodEnum: Enter the value “2” to create SCCP port Group
  • HostorIpAddress: Enter the Hostname or the IP Address of the system on which you want to create port group.

Adding PIMGTIMG Port Groups

The following is an example of the POST request that adds the PIMGTIMG Port Group:

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

Note: The <objectId> is the id of your phone system.

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

<PortGroup>
   <MediaPortGroupTemplateObjectId>8fc4952c-aa4f-4b96-a4b3-dbe26e49d899</MediaPortGroupTemplateObjectId>
   <MediaSwitchObjectId>0d15753c-e1b4-4865-b00b-999a1ccf56ce</MediaSwitchObjectId>
   <TelephonyIntegrationMethodEnum>3</TelephonyIntegrationMethodEnum>
   <EnableMWI>true</EnableMWI>
   <DisplayName>PIMG-2</DisplayName>
   <EnableAGC>true</EnableAGC>
   <CcmDoAutoFailback>true</CcmDoAutoFailback>
   <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
   <HostOrIPAddress>10.78.171.157</HostOrIPAddress>
   <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
   <SipTransportProtocolEnum>10</SipTransportProtocolEnum>
   <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
   <OutgoingGuardTimeMs>1000</OutgoingGuardTimeMs>
   <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
   <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
   <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
   <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
   <MwiReqPortSpecific>true</MwiReqPortSpecific>
   <MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
   <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
   <PortCount>0</PortCount>
   <WaitForCallInfoMs>0</WaitForCallInfoMs>
   <SipDoSRTP>true</SipDoSRTP>
   <SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
   <SipDoDtmfKPML>true</SipDoDtmfKPML>
   <MediaSipSecurityProfileObjectId>15a3a4d9-65a0-456a-be38-4a4aff36554c</MediaSipSecurityProfileObjectId>
   <SipTLSModeEnum>11</SipTLSModeEnum>
   <ResetStatusEnum>0</ResetStatusEnum>
   <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
   <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
   <NoiseFreeEnable>true</NoiseFreeEnable>
</PortGroup>
 RESPONSE Code: 201 

Modifying Port Groups

This section contains information on how to modify Port Groups:

  • Modifying SCCP Port Groups
  • Modifying SIP Port Groups


Modifying SCCP Port Groups

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

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

Note: The <sccpobjectId> is the id of your phone system

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

  <EnableMWI>true</EnableMWI>
  <MwiOnCode>98</MwiOnCode>
  <MwiOffCode>99</MwiOffCode>
  <MwiRetryCountOnSuccess>1</MwiRetryCountOnSuccess>
  <<MwiMaxConcurrentRequests>3</MwiMaxConcurrentRequests>
  <MwiMinRequestIntervalMs>4</MwiMinRequestIntervalMs>
 RESPONSE Code: 204 


Modifying SIP Port Group

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

 https://<connection_server>/vmrest/portgroups/<SIPobjectId> 

Note: The <SIPobjectId>is the id of your phone system

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

  <EnableMWI>true</EnableMWI>
  <MwiOnCode>98</MwiOnCode>
  <MwiOffCode>99</MwiOffCode>
  <MwiRetryCountOnSuccess>1</MwiRetryCountOnSuccess>
  <<MwiMaxConcurrentRequests>3</MwiMaxConcurrentRequests>
  <MwiMinRequestIntervalMs>4</MwiMinRequestIntervalMs>
 RESPONSE Code: 204 

Modifying Advance Settings of a Port Group

The following is an example of the GET request that list the Advance Settings of a Port Group:

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

<PortGroup>
 <URI>/vmrest/portgroups/833a6c54-6bb0-40b9-8aa7-210265701ca2</URI>
 <MediaPortGroupTemplateObjectId>
 04e0e286-56ed-4f27-a325-756a49dd98e1
 </MediaPortGroupTemplateObjectId>
 <MediaSwitchObjectId>
 a65f2cb0-1cdf-4290-a00b-37ab2c3d27e8
 </MediaSwitchObjectId>
 <PhoneSystemURI>
 /vmrest/phonesystems/a65f2cb0-1cdf-4290-a00b-37ab2c3d27e8
 </PhoneSystemURI>
 <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
 <EnableMWI>true</EnableMWI>
 <DisplayName>PhoneSystem-SIPSANJAY</DisplayName>
 <EnableAGC>true</EnableAGC>
 <CcmDoAutoFailback>true</CcmDoAutoFailback>
 <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
 <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
 <ObjectId>833a6c54-6bb0-40b9-8aa7-210265701ca2</ObjectId>
 <SipTransportProtocolEnum>11</SipTransportProtocolEnum>
 <SipRegisterWithProxyServer>false</SipRegisterWithProxyServer>
 <SipDoAuthnticate>false</SipDoAuthenticate>
 <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
 <OutgoingGuardTimeMs>0</OutgoingGuardTimeMs>
 <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
 <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
 <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
 <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
 <MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
 <MediaSwitchDisplayName>PhoneSystem123</MediaSwitchDisplayName>
 <PortCount>0</PortCount>
 <WaitForCallInfoMs>0</WaitForCallInfoMs>
 <SipDoSRTP>true</SipDoSRTP>
 <SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
 <SipDoDtmfKPML>true</SipDoDtmfKPML>
 <MediaSipSecurityProfileObjectId>
 87cab9a5-c68d-447a-ab4f-7cd2837aa240
 </MediaSipSecurityProfileObjectId>
 <SipTLSModeEnum>11</SipTLSModeEnum>
 <ResetStatusEnum>0</ResetStatusEnum>
 <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
 <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
 <NoiseFreeEnable>true</NoiseFreeEnable>
 <PortGroupServerURI>
 /vmrest/portgroups/833a6c54-6bb0-40b9-8aa7-210265701ca2/portgroupservers
 </PortGroupServerURI>
 <PortGroupCodecURI>
 /vmrest/portgroups/833a6c54-6bb0-40b9-8aa7-210265701ca2/portgroupcodecs
 </PortGroupCodecURI>
 <PortURI>/vmrest/ports/</PortURI>
</PortGroup>
 RESPONSE Code: 204 

Modifying Port Group Servers

The following is an example of the GET request that lists all the port group servers:

 https://<connection_server>/vmrest/portgroups/<objectId>/portgroupservers 

The following is an example of the response from the above *GET* request:

<PortGroupServer>
 <MediaRemoteServiceEnum>100</MediaRemoteServiceEnum>
 <MediaPortGroupObjectId>eee76668-7d26-4e74-ba61-b41630c2819e</MediaPortGroupObjectId>
 <HostOrIPAddress>10.78.171.158</HostOrIPAddress>
 <Port>2000</Port>
 <TlsPort>2443</TlsPort>
 <Precedence>0</Precedence>
 <SkinnyStateMachineEnum>10</SkinnyStateMachineEnum>
 </PortGroupServer> 
<pre>

<pre> RESPONSE Code: 201 


The following is an example of the PUT request that modifies the Port Group Server:


 https:/<server_ip>/vmrest/portgroups/<SIP mediaswitch-objectid>/portgroupservers/<objectId> 

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

<PortGroupServer>
<HostOrIPAddress>10.78.171.158</HostOrIPAddress>
<Port>2001</Port>
<TlsPort>2443</TlsPort>
<Precedence>2</Precedence>
</PortGroupServer> 
 RESPONSE Code: 204 


Modifying Codec Advertising of a Port Group

There are 5 types codec that you can add and Delete:

  • G.711 mu-law
  • G.729
  • G.711 a-law
  • G.722
  • iLBC


Listing Codecs

The following is an example of the GET request that lists all the 5 codecs:

 https:/<server_ip>/vmrest/rtpcodecdefs 

The following is an example of the response from the above *GET* request:

<RtpCodecDefs total="5">
 <RtpCodecDef>
   <URI>/vmrest/rtpcodecdefs/5623a48c-255d-a121-a4b4-5788238a8123</URI>
   <ObjectId>5623a48c-255d-a121-a4b4-5788238a8123</ObjectId>
   <DisplayName>G.711 mu-law</DisplayName>
 </RtpCodecDef>
 <RtpCodecDef>
   <URI>/vmrest/rtpcodecdefs/672e247c-33de-b232-b5b4-12eb238a8234</URI>
   <ObjectId>672e247c-33de-b232-b5b4-12eb238a8234</ObjectId>
   <DisplayName>G.711 a-law</DisplayName>
 </RtpCodecDef>
 <RtpCodecDef>
   <URI>/vmrest/rtpcodecdefs/7823a48c-105d-b232-07b4-635a20810345</URI>
   <ObjectId>7823a48c-105d-b232-07b4-635a20810345</ObjectId>
   <DisplayName>G.722</DisplayName>
 </RtpCodecDef>
 <RtpCodecDef>
   <URI>/vmrest/rtpcodecdefs/8923aabc-3650-b232-1b00-0788b04a84c6</URI>
   <ObjectId>8923aabc-3650-b232-1b00-0788b04a84c6</ObjectId>
   <DisplayName>G.729</DisplayName>
 </RtpCodecDef>
 <RtpCodecDef>
   <URI>/vmrest/rtpcodecdefs/9a23b48c-060d-b267-2589-5701238ab567</URI>
   <ObjectId>9a23b48c-060d-b267-2589-5701238ab567</ObjectId>
   <DisplayName>iLBC</DisplayName>
 </RtpCodecDef>
</RtpCodecDefs>
 RESPONSE Code: 200 


Addings Codecs to the existing Port Group

The following is an example of the POST request that add codecs:

<PortGroupCodec>
 <MediaPortGroupObjectId>9206847a-cc34-4dab-a08c-9fbed074ba88</MediaPortGroupObjectId>
 <PreferredPacketSizeMs>20</PreferredPacketSizeMs>
 <RtpCodecDefObjectId>9a23b48c-060d-b267-2589-5701238ab567</RtpCodecDefObjectId>
</PortGroupCodec>

The value of the PrefferedPacket SizeMS will be 10, 20, and 30.

Deleting a codec

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

 https://<connection_server>/vmrest/portgroups/<objectId>/portgroupcodecs/<objectId> 


The output for this request returns the successful response code.

 RESPONSE Code: 204 


Updating the Existing Port Group with SIP Integration to Modify SIP Security Profile

SIP port groups can be updated to reconfigure “SIP Security Profile” and “SIP Certificate” and SIP security mode using this URL. SIP Profile can be fetched using the following URL:

GET https://<connection-server>/vmrest/sipprofiles.
<pre>
SIP certificates can be fetched using the following URI: 
<pre>
GET https://<connectionserver>/vmrest/sipcertificates.

The following is an example of the PUT request that will update the existing port groups:

  PUT https://<connection-server>/vmrest/portgroups/<POrtGroupObjectId>
Request Body:
<PortGroup>
     <MediaSipSecurityProfileObjectId>61dc7bd7-06a4-4e64-8104-
   ea9694390358</MediaSipSecurityProfileObjectId>
     <MediaCertificateObjectId>2654ba6a-ae1a-4935-a8ccc1cf7199f695</
     MediaCertificateObjectId>
     <SipTLSModeEnum>10</SipTLSModeEnum>
</PortGroup>

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

Response Code: 204

JSON Example

To update the existing port group with SIP Integration to modify SIP security profile:

PUT https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaSipSecurityProfileObjectId":"61dc7bd7-06a4-4e64-8104-ea9694390358",
     "MediaCertificateObjectId":"2654ba6a-ae1a-4935-a8cc-c1cf7199f695",
     "SipTLSModeEnum":"10"
}

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

Response Code: 204


Viewing Reset Status of a Port Group

Following are the possible values of ResetStatusEnum:

  • 0: Reset Not Required
  • 100: Reset Required
  • 101: Reset In progress

Reset status of port group can be checked with the ResetStatusEnum field in response at the following URI:

Request URI:
GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>

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

<PortGroup>
     <URI>/vmrest/portgroups/ae5656cf-819f-4235-a566-a485ed665eb3</URI>
     <MediaPortGroupTemplateObjectId>04e0e286-56ed-4f27-a325-
   756a49dd98e1</MediaPortGroupTemplateObjectId>
     <MediaSwitchObjectId>5bfd3bae-0c37-4d20-8066-c3065431fc41</MediaSwitchObjectId>
     <PhoneSystemURI>/vmrest/phonesystems/5bfd3bae-0c37-4d20-8066-
   c3065431fc41</PhoneSystemURI>
     <TelephonyIntegrationMethodEnum>2</TelephonyIntegrationMethodEnum>
     <EnableMWI>true</EnableMWI>
     <DisplayName>PhoneSystem-2</DisplayName>
     <EnableAGC>true</EnableAGC>
     <CcmDoAutoFailback>true</CcmDoAutoFailback>
     <MwiRetryCountOnSuccess>0</MwiRetryCountOnSuccess>
     <MwiRetryIntervalOnSuccessMs>5</MwiRetryIntervalOnSuccessMs>
     <ObjectId>ae5656cf-819f-4235-a566-a485ed665eb3</ObjectId>
     <SipContactLineName>line</SipContactLineName>
     <SipTransportProtocolEnum>11</SipTransportProtocolEnum>
     <SipRegisterWithProxyServer>false</SipRegisterWithProxyServer>
     <SipDoAuthenticate>true</SipDoAuthenticate>
     <SipAuthenticateAsUser>SIPUser</SipAuthenticateAsUser>
     <SipAuthenticatePassword>TY1U18Zb0s6xg6UAFpyhnw==</SipAuthenticatePassword>
     <MwiMinRequestIntervalMs>0</MwiMinRequestIntervalMs>
     <OutgoingGuardTimeMs>0</OutgoingGuardTimeMs>
     <OutgoingPostDialDelayMs>50</OutgoingPostDialDelayMs>
     <OutgoingPreDialDelayMs>0</OutgoingPreDialDelayMs>
     <DelayBeforeOpeningMs>0</DelayBeforeOpeningMs>
     <DtmfDialInterDigitDelayMs>300</DtmfDialInterDigitDelayMs>
     <MwiMaxConcurrentRequests>0</MwiMaxConcurrentRequests>
     <MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
     <PortCount>0</PortCount>
     <WaitForCallInfoMs>0</WaitForCallInfoMs>
     <SipDoSRTP>true</SipDoSRTP>
     <SipDoDtmfRfc2833>true</SipDoDtmfRfc2833>
     <SipDoDtmfKPML>true</SipDoDtmfKPML>
     <MediaSipSecurityProfileObjectId>8275234c-6ea4-4a4b-87c1-
   74abe1394415</MediaSipSecurityProfileObjectId>
     <SipTLSModeEnum>11</SipTLSModeEnum>
     <ResetStatusEnum>0</ResetStatusEnum>
     <RecordingDTMFClipMs>170</RecordingDTMFClipMs>
     <RecordingToneExtraClipMs>250</RecordingToneExtraClipMs>
     <NoiseFreeEnable>true</NoiseFreeEnable>
     <PortGroupServerURI>/vmrest/portgroups/ae5656cf-819f-4235-a566-
   a485ed665eb3/portgroupservers</PortGroupServerURI>
     <PortGroupCodecURI>/vmrest/portgroups/ae5656cf-819f-4235-a566-
   a485ed665eb3/portgroupcodecs</PortGroupCodecURI>
     <PortURI>/vmrest/ports/</PortURI>
</PortGroup>
Response Code: 200

JSON Example

Request URI:
GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>
Accept: application/json
Connection: keep-alive

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

{
     "URI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-8a220a081990",
     "MediaPortGroupTemplateObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1",
     "MediaSwitchObjectId": "f92e948f-6bd4-4891-ab8b-a3d930688305",
     "PhoneSystemURI": "/vmrest/phonesystems/f92e948f-6bd4-4891-ab8b-a3d930688305",
     "TelephonyIntegrationMethodEnum": "2",
     "EnableMWI": "true",
     "DisplayName": "demo_PhoneSystem_1-1",
     "EnableAGC": "true",
     "CcmDoAutoFailback": "true",
     "MwiRetryCountOnSuccess": "0",
     "MwiRetryIntervalOnSuccessMs": "5",
     "ObjectId": "74a008c0-bdc6-4e4b-a304-8a220a081990",
     "SipContactLineName": "",
     "SipTransportProtocolEnum": "11",
     "SipRegisterWithProxyServer": "false",
     "SipDoAuthenticate": "false",
     "MwiMinRequestIntervalMs": "0",
     "OutgoingGuardTimeMs": "0",
     "OutgoingPostDialDelayMs": "50", 
     "OutgoingPreDialDelayMs": "0",
     "DelayBeforeOpeningMs": "0",
     "DtmfDialInterDigitDelayMs": "300",
     "MwiMaxConcurrentRequests": "0",
     "MediaSwitchDisplayName": "demo_PhoneSystem_1",
     "PortCount": "2",
     "WaitForCallInfoMs": "0",
     "SipDoSRTP": "true",
     "SipDoDtmfRfc2833": "true",
     "SipDoDtmfKPML": "true",
     "MediaSipSecurityProfileObjectId": "34e62bbf-a2f8-4281-8b1e-90af4985344e",
     "SipTLSModeEnum": "11",
     "ResetStatusEnum": "0",
     "RecordingDTMFClipMs": "170",
     "RecordingToneExtraClipMs": "250",
     "PreferredCallControl": "0",
     "SipPreferredMedia": "0",
     "NoiseFreeEnable": "true", 
     "PortGroupServerURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
     8a220a081990/portgroupservers",
     "PortGroupCodecURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
     8a220a081990/portgroupcodecs",
     "PortURI": "/vmrest/ports/"
}
Response Code 200


Resetting the Port Group

Administrator will be able to reset a port group when the ResetStatusEnum field value is 100 by sending a PUT request to the URI.

PUT https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/reset
Request Body:
Not required

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

Response Code: 204

JSON Example

PUT https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/reset
Accept: application/json
Connection: keep-alive
Request Body:
Not required

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

Response Code: 204

Note: If ResetStatusEnum is 0 or 101 and we try to reset port group then error will be thrown.


Explanation of Data Fields

Explanation of Data Fields for SIP Port Group

Parameter Operations Data Type Comments
ObjectId Read Only String(36) Object Id of the port group created.
DisplayName Read Only String(64) Display name of the port group, where maximum characters can be 64.
MediaSwitchObjectId Read Only String(36) Object Id of the phone system for which the port group is created.
MediaPortGroupTemplateObjectId Read Only String(36) Object Id of the port group template being used.
TelephonyIntegrationMethodEnum Read Only Enum The following options are available:
  • 1 - Skinny Client Control Protocol (SCCP) integration method.
  • 2 - Session Initiation Protocol (SIP) integration method.
  • 3 - Intel PBX IP Media Gateway (PIMG) integration method.
ResetStatusEnum Read Only Enum Shows whether the port group needs to be reset in order to cause configuration changes to take effect.

The values can be:

  • 0: Reset Not Required
  • 100: Reset Required
  • 101: Reset In progress
EnableMWI Read/Write Boolean A flag indicating whether this port group can transmit message waiting indicator (MWI) on/off messages to the switch.

Default value is false.

MwiMaxConcurrentRequests Read/Write Integer The maximum number of MWI requests that can be in progress at any instant. The range can vary from 0 through 250. This field is pertinent only if EnableMWI =TRUE. Default value is 0.
MwiRetryCountOnSuccess Read/Write Integer Specifies the number of times Cisco Unity Connection should repeat activating/deactivating an MWI upon success. The range can vary from 0 through 10. This field is pertinent only if EnableMWI = TRUE.

Default value is 0.

MwiRetryIntervalOnSuccessMs Read/Write Integer Specifies the minimum time interval (in milliseconds) between repeated transmissions of MWI on/off.The range can vary from 0 through 100. This field is pertinent only if EnableMWI = TRUE.

Default value is 5.

MwiMinRequestIntervalMs Read/Write Integer The minimum amount of time (in milliseconds) between sending MWI on/off requests to the switch. The range can vary from 0 through 5000. This field is pertinent only if EnableMWI = TRUE.

Default value is 0.

PreferredCallControl Read/Write Enum Used when registering with Call Manager via SCCP and when initiating SIP requests. This field is only applicable when IPv6Enable and address mode is Ipv4_Ipv6.

Values can be:

  • 0: Ipmodev4
  • 1: IPmodev6
  • 2: IPmodev4_v6

Default value is 0.

SipPreferredMedia Read/Write Enum Indicates SIP media preference when sending an SDP offer. This field is only applicable if IPv6Enable is set to true and Addressing mode is

IPv4_IPv6. Values can be:

  • 0: IPmodev4
  • 1:IPmodev6
  • 2:IPmodev4_v6

Default value is 0.

SipRegisterWithProxyServer Read/Write Boolean A flag indicating whether Unity Connection should register with a SIP proxy server.

Default value is false.

SipDoAuthenticate Read/Write Boolean Specifies if Unity Connection should authenticate with the remote endpoint.

Values can be:

  • false: Do not authenticate
  • true: Must authenticate

Default value is false.

SipAuthenticateAsUser Read/Write String(64) The user name used for SIP authentication.

Default value is NULL.

SipAuthenticatePassword Read/Write String(256) The password to use during SIP authentication. This field is encrypted.

Default value is NULL.

SipContactLineName Read/Write String(64) The extension number of the lines in this group, where the maximum character can be 64. All alphabetical and digit characters are allowed. Among the special characters hyphen, underscore, period, exclamation mark, tilde, asterisk, single quote, opening and closing parenthesis, ampersand,

equals, plus, dollar sign, comma, semicolon, question mark, backslash, and percent sign are allowed where maximum character is 64.

MediaSipSecurityProfileObjectId Read/Write String(36) Object Id of the SIP security profile. Applies only to SIP and PIMG port groups.
MediaCertificateObjectId Read/Write String(36) Object Id of the SIP certificate. This field is pertinent only if SIP security profile is 5061/TLS. Applies only to SIP and PIMG port groups.
SIPTransportProtocol Read/Write Enum Specifies Transport protocol used for the SIP integration. The values can be:
  • UDP = 10
  • TCP = 11

Default value is 10.

SipTLSModEnum Read/Write Integer TLS uses cipher NULL-SHA and cipher AES128-SHA. Values can be:
  • Authenticated = 10
  • Encrypted = 11

This field is pertinent only if SIP security profile is 5061/TLS. Default value is 11.

SipDoSRTP Read/Write Boolean A flag indicating whether the audio stream between CUC and the remote endpoint should be encrypted. Values can be:
  • false: No encryption – RTP
  • true: Encrypted – SRTP

This field is pertinent only if SIP security profile is 5061/TLS. Default value is true.

DelayBeforeOpeningMs Read/Write Integer Specifies the delay after answer. The range can vary from 0 through 3000.

Default value is 0.

OutgoingGuardTimeMs Read/Write Integer The amount of time (in milliseconds) a port in this group must be on-hook before the Unity Connection will allow an outgoing call on that port. The range can vary from 0 through 10000.

Default value is 2500.

OutgoingPreDialDelayMs Read/Write Integer The delay (in milliseconds) before dialing. The range can vary from 0 through 3000.

Default value is 0.

OutgoingPostDialDelayMs Read/Write Integer The delay (in milliseconds) after dialing an outgoing call. The range can vary from 0 through 3000.

Default value is 50.

DtmfDialInterDigitDelayMs Read/Write Integer Specifies the DTMF Interdigit delay. The range can vary from 0 through 500.

Default value is 50.

RecordingDTMFClipMs Read/Write Integer Number of milliseconds to remove from the end of a recording when the recording is terminated with a digit press. The range can vary from 0 through 300.

Default value is 170.

RecordingToneExtraClipMs Read/Write Integer Additional number of milliseconds to remove from the end of a recording when the recording is terminated by a tone. The range can vary from 0 through 5000.

Default value is 250.

SipRPIDDisplayName Read/Write String(64) Name of the Cisco Unity Connection system that Cisco Unity Connection places in the SIP Remote-Party-ID header per draft-ietf-sip-privacy-04. Specifies the Remote-Party-ID for SIP/PIMG only.
SipDoDtmfKPML Read/Write Boolean If value = true, the port group will accept subscriptions from the peer endpoint for KPML events. Use DTMF KPML, for SIP/PIMG only.

Default value is true.

SipDoDtmfRfc2833 Read/Write Boolean If value = true (1), the port group advertises support for RFC 2833 during call build-up. Use DTMF RFC 2833, for SIP/PIMG only.

Default value is true.

EnableAGC Read/Write Boolean Audio Normalization for Recordings and Messages. It also enables audio normalization for recordings and messages.

Default value is true.

NoiseFreeEnable Read/Write Boolean Enable noise reduction settings.

Default value is true.

Explanation of Data Fields for SCCP Port Group

Parameter Operations Data Type Comments
ObjectId Read Only String(36) Object Id of the port group created.
DisplayName Read Only String(64) Display name of the port group where maximum characters can be 64.
MediaSwitchObjectId Read Only String(36) Object Id of the phone system for which the port group is created.
MediaPortGroupTemplateObjectId Read Only String(36) Object Id of the port group template being used.
TelephonyIntegrationMethodEnum Read Only Integer Values can be:
  • 1 - Skinny Client Control Protocol (SCCP) integration method.
  • 2 - Session Initiation Protocol (SIP) integration method.
  • 3 - Intel PBX IP Media Gateway (PIMG) integration method.
SkinnyDevicePrefix Read Only String Used for SCCP Integration. The maximum length can be 48 characters.
ResetStatusEnum Read Only Integer Shows whether the port group needs to be reset in order to cause configuration changes to take effect.

Deleting a Port Group

The following is an example of the DELETE request that deletes a Port Group as represented by <mediaswitch- objectid>:

 https://<connection_server>/vmrest/portgroups/<mediaswitch - objectId> 

The output for this request returns the successful response code.

 Response Code: 204 

When a port group is deleted, all ports associated to the port group are also deleted.

Rating: 0.0/5 (0 votes cast)

Personal tools