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

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Adding PIMGTIMG Port Groups)
m (1 revision)

Revision as of 17:59, 2 October 2012

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About Port Group

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

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 

Port Group Templates

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


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 


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 

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 

Rating: 0.0/5 (0 votes cast)

Personal tools