Create Call Control Group


HTTPS Method	POST
URI	https://<server>/adminapi/callControlGroup
Example URI	https://uccx-server/adminapi/callControlGroup
Content Type	Application/XML, Application/JSON
HTTPS Success Code	201, 202, 206
HTTPS Failure Codes	400, 401, 404, 405, 412, 415, 500, 503
Error Codes	—

Sample Input XML—Create a New Call Control Group in WAN with All Parameters (POST) to Configure CTI Ports on Both Nodes

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c11</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>Default</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>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>Default</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 — Create a New Call Control Group in WAN with All Parameters (POST) to Configure CTI Ports on One Node

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c11</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>Default</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—Create a New Call Control Group in WAN with Default Parameters (POST) to Configure CTI Ports on Both Nodes

<?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">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c1</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>
        <hostName>ccx-94-80</hostName>
    </portGroupConfiguration>
    <portGroupConfiguration>
        <startingDirectoryNumber>999001</startingDirectoryNumber>
        <devicePool>Default</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—Create a New Call Control Group in WAN with Default Parameters (POST) to Configure CTI Ports on One Node

<?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">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c1</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>
        <hostName>ccx-94-80</hostName>
    </portGroupConfiguration>
</callControlGroup>

Sample Input XML—Create a New Call Control Group in LAN with All Parameters (POST)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c11</deviceNamePrefix>
    <numOfCTIPorts>10</numOfCTIPorts>
    <mediaTerminationSupport>false</mediaTerminationSupport>
    <portGroupConfiguration>
        <hostName>hostName1</hostName>
        <startingDirectoryNumber>100012</startingDirectoryNumber>
        <devicePool>Default</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—Create a New Call Control Group in LAN with Default Parameters (POST)

<?xml version="1.0" encoding="UTF-8"?>
<callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd">
    <outboundGroup>false</outboundGroup>
    <description>description</description>
    <deviceNamePrefix>c1</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>