Create Campaign

HTTPS Method

POST

URI

https://<server>/adminapi/campaign

Example URI

https://uccx-server/adminapi/campaign

Content Type

Application/XML, Application/JSON

HTTPS Success Code

201

HTTPS Failure Codes

400, 401, 405

Error Codes

—

Note
When Cisco Finesse is deactivated, new agent predictive and agent progressive campaigns cannot be created.

Success Response

HTTPS/1.1 201 Created

Sample Input XML—Outbound IVR - Progressive Campaign

<?xml version="1.0" encoding="UTF-8"?>
<campaign>
    <self>https://uccx-server/adminapi/campaign/201</self>
    <campaignId>201</campaignId>
    <campaignName>IVRProgressive</campaignName>
    <enabled>false</enabled>
    <description>This is IVR Progressive campaign</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>IVR</campaignType>
    <dialerType>PROGRESSIVE</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obIvrProgressive>
            <campaignCallingNum>12345</campaignCallingNum>
            <applicationTrigger name="5657656">
                <refURL>https://uccx-server/adminapi/trigger/5657656</refURL>
            </applicationTrigger>
            <maxDialAttempts>3</maxDialAttempts>
            <callbackTimeLimit>15</callbackTimeLimit>
            <numDedicatedPorts>0</numDedicatedPorts>
            <linesPerPort>1.0</linesPerPort>
            <treatLowVolAsVoice>true</treatLowVolAsVoice>
            <ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment>
            <noAnswerRingLimit>15</noAnswerRingLimit>
            <abandonedCallWaitTime>2</abandonedCallWaitTime>
            <retryNoAnswerDelay>60</retryNoAnswerDelay>
            <retryBusySignalDelay>60</retryBusySignalDelay>
            <retryCustAbandonedDelay>30</retryCustAbandonedDelay>
            <retryDialerAbandonedDelay>60</retryDialerAbandonedDelay>
        </obIvrProgressive>
    </typeSpecificInfo>
</campaign>

Sample Input XML—Outbound IVR - Predictive Campaign

<?xml version="1.0" encoding="UTF-8"?>
<campaign>
    <self>https://uccx-server/adminapi/campaign/202</self>
    <campaignId>202</campaignId>
    <campaignName>IVRPredictive</campaignName>
    <enabled>false</enabled>
    <description>This is IVR Predictive campaign</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>IVR</campaignType>
    <dialerType>PREDICTIVE</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obIvrPredictive>
            <campaignCallingNum>112233</campaignCallingNum>
            <applicationTrigger name="464355">
                <refURL>https://uccx-server/adminapi/trigger/464355</refURL>
            </applicationTrigger>
            <maxDialAttempts>3</maxDialAttempts>
            <callbackTimeLimit>15</callbackTimeLimit>
            <numDedicatedPorts>0</numDedicatedPorts>
            <linesPerPort>1.5</linesPerPort>
            <treatLowVolAsVoice>true</treatLowVolAsVoice>
            <ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment>
            <noAnswerRingLimit>15</noAnswerRingLimit>
            <abandonedCallWaitTime>2</abandonedCallWaitTime>
            <retryNoAnswerDelay>60</retryNoAnswerDelay>
            <retryBusySignalDelay>60</retryBusySignalDelay>
            <retryCustAbandonedDelay>30</retryCustAbandonedDelay>
            <retryDialerAbandonedDelay>60</retryDialerAbandonedDelay>
            <maxLinesPerPort>3.0</maxLinesPerPort>
            <predictiveCorrectionPace>100</predictiveCorrectionPace>
            <predictiveGain>1.0</predictiveGain>
            <callAbandonLimit>3.0</callAbandonLimit>
        </obIvrPredictive>
    </typeSpecificInfo>
</campaign>

Sample Input XML—Preview Campaign

<?xml version="1.0" encoding="UTF-8"?>
<campaign>
    <self>https://uccx-server/adminapi/campaign/200</self>
    <campaignId>200</campaignId>
    <campaignName>OBPreview</campaignName>
    <enabled>false</enabled>
    <description>This is Outbound Preview campaign</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>AGENT</campaignType>
    <dialerType>DIRECT_PREVIEW</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obPreview>
            <maxDialAttempts>3</maxDialAttempts>
            <cacheSize>20</cacheSize>
            <ansMachineRetry>false</ansMachineRetry>
            <callbackTimeLimit>15</callbackTimeLimit>
            <missedCallbackAction>NEXT_DAY</missedCallbackAction>
            <assignedCSQs>
                <csq name="1">
                    <refURL>https://uccx-server/adminapi/csq/1</refURL>
                </csq>
            </assignedCSQs>
        </obPreview>
    </typeSpecificInfo>
</campaign>

Sample Input XML—Outbound Agent - Progressive Campaign 

<?xml version="1.0" encoding="UTF-8"?> 
<campaign>
    <self>https://uccx-server/adminapi/campaign/105</self>
    <campaignId>105</campaignId>
    <campaignName>Agent Progressive</campaignName>
    <enabled>false</enabled>
    <description>description</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>AGENT</campaignType>
    <dialerType>PROGRESSIVE</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obAgentProgressive>
           <campaignCallingNum>7777</campaignCallingNum>
           <maxDialAttempts>3</maxDialAttempts>
           <callbackTimeLimit>15</callbackTimeLimit>
           <treatLowVolAsVoice>true</treatLowVolAsVoice>
           <noAnswerRingLimit>15</noAnswerRingLimit>
           <abandonedCallWaitTime>2</abandonedCallWaitTime>
           <retryNoAnswerDelay>60</retryNoAnswerDelay>
           <retryBusySignalDelay>60</retryBusySignalDelay>
           <retryCustAbandonedDelay>0</retryCustAbandonedDelay>
           <retryDialerAbandonedDelay>0</retryDialerAbandonedDelay>
           <linesPerAgent>1.0</linesPerAgent>
           <assignedCSQs>
              </csq>
                <csq name="37">
                <refURL>https://uccx-server/adminapi/csq/37</refURL>
              </csq>
           </assignedCSQs>
           <answerMachineTreatment>TRANSFER_TO_IVR</answerMachineTreatment>
           <answerMachineTreatmentTrigger name="4600">
              <refURL>https://uccx-server/adminapi/trigger/4600</refURL>
           </answerMachineTreatmentTrigger>
           <abandonedCallTreatment>TRANSFER_TO_IVR</abandonedCallTreatment>
           <abandonedCallTreatmentTrigger name="4800">
              <refURL>https://uccx-server/adminapi/trigger/4800</refURL>
           </abandonedCallTreatmentTrigger>
           <missedCallbackAction>NEXT_DAY</missedCallbackAction>
        </obAgentProgressive>
    </typeSpecificInfo>
</campaign>

Sample Input XML—Outbound Agent - Predictive Campaign 

<?xml version="1.0" encoding="UTF-8"?>    
<campaign>
    <self>https://uccx-server/adminapi/campaign/114</self>
    <campaignId>114</campaignId>
    <campaignName>Agent predictive</campaignName>
    <enabled>false</enabled>
    <description>description</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>AGENT</campaignType>
    <dialerType>PREDICTIVE</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obAgentPredictive>
           <campaignCallingNum>7777</campaignCallingNum>
           <maxDialAttempts>3</maxDialAttempts>
           <callbackTimeLimit>15</callbackTimeLimit>
           <treatLowVolAsVoice>true</treatLowVolAsVoice>
           <noAnswerRingLimit>15</noAnswerRingLimit>
           <abandonedCallWaitTime>2</abandonedCallWaitTime>
           <retryNoAnswerDelay>60</retryNoAnswerDelay>
           <retryBusySignalDelay>60</retryBusySignalDelay>
           <retryCustAbandonedDelay>0</retryCustAbandonedDelay>
           <retryDialerAbandonedDelay>0</retryDialerAbandonedDelay>
           <linesPerAgent>2.0</linesPerAgent>
           <assignedCSQs>
              </csq>
                 <csq name="37">
                 <refURL>https://uccx-server/adminapi/csq/37</refURL>
              </csq>
           </assignedCSQs>
           <answerMachineTreatment>TRANSFER_TO_IVR</answerMachineTreatment>
           <answerMachineTreatmentTrigger name="4600">
              <refURL>https://uccx-server/adminapi/trigger/4600</refURL>
           </answerMachineTreatmentTrigger>
           <abandonedCallTreatment>TRANSFER_TO_IVR</abandonedCallTreatment>
           <abandonedCallTreatmentTrigger name="4800">
              <refURL>https://uccx-server/adminapi/trigger/4800</refURL>
           </abandonedCallTreatmentTrigger>
           <missedCallbackAction>NEXT_DAY</missedCallbackAction>
           <maxLinesPerAgent>2.0</maxLinesPerAgent>
           <predictiveCorrectionPace>100</predictiveCorrectionPace>
           <predictiveGain>1.0</predictiveGain>
           <callAbandonLimit>0.0</callAbandonLimit>
        </obAgentPredictive>
    </typeSpecificInfo>
</campaign>