Modify Call Control Group

HTTPS Method

PUT

URI

https://<server>/adminapi/callControlGroup/{id}

Example URI

https://uccx-server/adminapi/callControlGroup/12

Content Type

Application/XML, Application/JSON

HTTPS Success Code

200, 202, 206

HTTPS Failure Codes

400, 401, 404, 405, 412, 500, 503

Error Codes

Sample Input XML—Modify Common Parameters of an Existing Call Control Group in WAN when CTI Ports are Configured for Both Nodes (PUT)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
         <id>7</id>
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>mod1</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>true</mediaTerminationSupport>
    <portGroupConfiguration>
        <startingDirectoryNumber>999001</startingDirectoryNumber>
        <devicePool>Default</devicePool>
        <location>Hub_None</location>
        <presenceGroup>Standard Presence group</presenceGroup>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>false</requireDTMFReception>
        <hostName>ccx-94-80</hostName>
    </portGroupConfiguration>
    <portGroupConfiguration>
        <startingDirectoryNumber>999001</startingDirectoryNumber>
        <devicePool>mod_DP</devicePool>
        <location>Hub_None</location>
        <presenceGroup>Standard Presence group</presenceGroup>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <hostName>ccx-94-81</hostName>
    </portGroupConfiguration>
</callControlGroup>

Sample Input XML—Modify Node-Specific Parameters of an Existing Call Control Group for One Node in WAN when CTI Ports are Created for Both Nodes (PUT)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
         <id>7</id>
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>mod1</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>true</mediaTerminationSupport>
    <portGroupConfiguration>
        <startingDirectoryNumber>999001</startingDirectoryNumber>
        <devicePool>Default</devicePool>
        <location>Hub_None</location>
        <presenceGroup>Standard Presence group</presenceGroup>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>false</requireDTMFReception>
        <hostName>ccx-94-80</hostName>
    </portGroupConfiguration>
</callControlGroup>

Sample Input XML—Modify an Existing Call Control Group in WAN with All Parameters (PUT)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
         <id>5</id>
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c11</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>mod_De</devicePool>
        <dnCallingSearchSpace>None</dnCallingSearchSpace>
        <location>Hub_None</location>
        <partition>Mod_Part</partition>
        <mediaResourceGroupList>None</mediaResourceGroupList>
        <voiceMailProfile>None</voiceMailProfile>
        <presenceGroup>Standard Presence group</presenceGroup>
        <AARGroup>None</AARGroup>
        <userHoldAudioSource>None</userHoldAudioSource>
        <networkHoldAudioSource>None</networkHoldAudioSource>
        <callPickUpGroup>None</callPickUpGroup>
        <alertingNameAscii>alteringNameAscii</alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display>display</display>
        <externalPhoneMaskNumber>12345</externalPhoneMaskNumber>
    </portGroupConfiguration>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>Default</devicePool>
        <dnCallingSearchSpace>None</dnCallingSearchSpace>
        <location>Hub_None</location>
        <partition>Mod_Part</partition>
        <mediaResourceGroupList>Mod_MRGL</mediaResourceGroupList>
        <voiceMailProfile>None</voiceMailProfile>
        <presenceGroup>Standard Presence group</presenceGroup>
        <AARGroup>None</AARGroup>
        <userHoldAudioSource>None</userHoldAudioSource>
        <networkHoldAudioSource>None</networkHoldAudioSource>
        <callPickUpGroup>None</callPickUpGroup>
        <alertingNameAscii>alteringNameAscii</alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display>display</display>
        <externalPhoneMaskNumber>12345</externalPhoneMaskNumber>
    </portGroupConfiguration>
</callControlGroup>

Sample Input XML—Modify an Existing Call Control Group in LAN with All Parameters (PUT)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
        <id>23</id>
        <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c11</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>ModDevPool</devicePool>
        <dnCallingSearchSpace>None</dnCallingSearchSpace>
        <location>Hub_None</location>
        <partition>None</partition>
        <mediaResourceGroupList>None</mediaResourceGroupList>
        <voiceMailProfile>None</voiceMailProfile>
        <presenceGroup>Standard Presence group</presenceGroup>
        <AARGroup>None</AARGroup>
        <userHoldAudioSource>None</userHoldAudioSource>
        <networkHoldAudioSource>None</networkHoldAudioSource>
        <callPickUpGroup>None</callPickUpGroup>
        <alertingNameAscii>alteringNameAscii</alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display>display</display>
        <externalPhoneMaskNumber>12345</externalPhoneMaskNumber>
    </portGroupConfiguration>
</callControlGroup>

Sample Input XML—Modify an Existing Call Control Group in LAN with Default Parameters (PUT)

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
         <id>24</id>
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>mod</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <startingDirectoryNumber>999001</startingDirectoryNumber>
        <devicePool>Default</devicePool>
        <location>Hub_None</location>
        <presenceGroup>Standard Presence group</presenceGroup>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
    </portGroupConfiguration>
</callControlGroup>