Get Call Control Group

HTTPS Method

GET

URI

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

Example URI

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

Accept

Application/XML, Application/JSON

HTTPS Success Code

200

HTTPS Failure Codes

401, 404, 412, 500, 503

Error Codes

Success Response

For LAN

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<callControlGroup>
    <self href="https://uccx-server/adminapi/callControlGroup/107" rel="self" type="callControlGroup"/>
    <id>107</id>
    <outboundGroup>false</outboundGroup>
    <description>testccg</description>
        <deviceNamePrefix>testc</deviceNamePrefix>
        <numOfCTIPorts>5</numOfCTIPorts>
        <mediaTerminationSupport>false</mediaTerminationSupport>
        <portGroupConfiguration>
     <listOfCTIPorts>testc_68900,testc_68907,testc_68908,testc_68909,testc_68910,testc_68911,testc_68912,testc_68913,
testc_68914,testc_68915</listOfCTIPorts>
        <startingDirectoryNumber>68900</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></alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display></display>
        <externalPhoneMaskNumber></externalPhoneMaskNumber>
    </portGroupConfiguration>
</callControlGroup>

For WAN—When CTI ports are configured for both nodes

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<callControlGroup>
    <self href="https://uccx-server/adminapi/callControlGroup/12" rel="self" type="callControlGroup"/>
    <id>2</id>
    <outboundGroup>false</outboundGroup>
    <description>TEST</description>
        <deviceNamePrefix>VISH1</deviceNamePrefix>
        <numOfCTIPorts>1</numOfCTIPorts>
        <mediaTerminationSupport>false</mediaTerminationSupport>
        <portGroupConfiguration>
        <hostName>ccx-94-80</hostName>
        <listOfCTIPorts>VISH1_1000</listOfCTIPorts>
        <startingDirectoryNumber>1000</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></alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display></display>
        <externalPhoneMaskNumber></externalPhoneMaskNumber>
    </portGroupConfiguration>
    <portGroupConfiguration>
        <hostName>ccx-94-81</hostName>
        <listOfCTIPorts>VISH1_576</listOfCTIPorts>
        <startingDirectoryNumber>576</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></alertingNameAscii>
        <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
        <requireDTMFReception>true</requireDTMFReception>
        <display></display>
        <externalPhoneMaskNumber></externalPhoneMaskNumber>
    </portGroupConfiguration>
</callControlGroup>

For WAN—When CTI ports are configured for only one node

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <callControlGroup>
        <self href="https://uccx-server/adminapi/callControlGroup/12" rel="self" type="callControlGroup"/>
        <id>2</id>
        <outboundGroup>false</outboundGroup>
        <description>TEST</description>
        <deviceNamePrefix>VISH1</deviceNamePrefix>
        <numOfCTIPorts>1</numOfCTIPorts>
        <mediaTerminationSupport>false</mediaTerminationSupport>
        <portGroupConfiguration>
                <hostName>ccx-94-80</hostName>
                 <listOfCTIPorts>VISH1_1000</listOfCTIPorts>
                 <startingDirectoryNumber>1000</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></alertingNameAscii>
                 <redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace>
                 <requireDTMFReception>true</requireDTMFReception>
                 <display></display>
                 <externalPhoneMaskNumber></externalPhoneMaskNumber>
          </portGroupConfiguration>
</callControlGroup>