Outbound Campaign API

An Outbound Campaign makes outgoing calls to customers for a specific purpose or task and delivers these calls to agents.

Use the Outbound Campaign API to define new outbound campaigns, and to view, edit, or delete existing outbound campaigns.

URL

https://<server>/unifiedconfig/config/campaign

Operations

Parameters

Search and Sort Parameters

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters

Sort parameters

  • name

  • description

  • name (default)

  • description

See Search and Sort.

Disable All Campaigns (Emergency Stop)

The Outbound Campaign API provides a method to immediately disable all outbound campaigns that are currently enabled. To disable all of the campaigns, perform a PUT on the following URL:

https://<server>/unifiedconfig/config/campaign/disable

This request retrieves a list of all campaigns created using the Outbound Campaign API that are currently enabled and sets the enabled parameter to false. The Campaign Manager stops sending out records to the Dialer for these campaigns. All active records in the Dialer's memory are removed.

Example Get Response

<campaign>
    <changeStamp>48</changeStamp>
    <refURL>/unifiedconfig/config/campaign/5168</refURL>
    <import>
        <refURL>/unifiedconfig/config/import/5000</refURL>
    </import>
    <abandonEnabled>true</abandonEnabled>
    <abandonPercent>3.0</abandonPercent>
    <amdTreatmentMode>abandonCall</amdTreatmentMode>
    <campaignPrefix>978</campaignPrefix>
    <campaignPurposeType>agentCampaign</campaignPurposeType>
    <dialingMode>PREVIEWONLY</dialingMode>
    <enabled>true</enabled>
    <endDate>2016-01-15</endDate>
    <endTime>17:00</endTime>
    <ipAMDEnabled>true</ipAmdEnabled>
    <ipTerminatingBeepDetect>false</ipTerminatingBeepDetect>
    <linesPerAgent>1.5</linesPerAgent>
    <maxAttempts>3</maxAttempts>
    <maximumLinesPerAgent>100.0</maximumLinesPerAgent>
    <minimumCallDuration>1</minimumCallDuration>
    <name>APIoct1</name>
    <noAnswerRingLimit>4</noAnswerRingLimit>
    <personalizedCallbackEnabled>false</personalizedCallbackEnabled>
    <predictiveCorrectionPace>70</predictiveCorrectionPace>
    <predictiveGain>1.0</predictiveGain>
    <rescheduleCallbackMode>useCampaignDN</rescheduleCallbackMode>
    <reservationPercentage>100</reservationPercentage>
    <retries>
        <answeringMachineDelay>60</answeringMachineDelay>
        <busySignalDelay>60</busySignalDelay>
        <customerAbandonedDelay>30</customerAbandonedDelay>
        <customerNotHomeDelay></customerNotHomeDelay>
        <dialerAbandonedDelay>60</dialerAbandonedDelay>
        <noAnswerDelay>60</noAnswerDelay>
    </retries>    
    <skillGroupInfos>
    <skillGroupInfo> 
        <ivrPorts>0</ivrPorts>
        <overflowAgents>0</overflowAgents>
        <recordsToCache>1</recordsToCache>
        <abandonedRoutePoint>12345</abandonedRoutePoint>
        <dialedNumber>123</dialedNumber>
        <ivrRoutePoint>91234</ivrRoutePoint>
        <skillGroup>
            <refURL>/unifiedconfig/config/skillgroup/5004</refURL>
            <name>errorDetailsRouteScript</name>
        </skillGroup>
    </skillGroupInfo>
    </skillGroupInfos>
    <startDate>2016-01-14</startDate>
    <startTime>09:00</startTime>
    <timeZone>
        <displayName>(UTC-05:00) Eastern Time (US & Canada)</displayName>        
        <refURL>/unifiedconfig/config/timezone/Eastern%20Standard%20Time</refURL>                
    </timeZone>
    <callProgressAnalysis>
        <enabled>true</enabled>
        <record>false</record>
        <minSilencePeriod>608</minSilencePeriod>
        <analysisPeriod>2500</analysisPeriod>
        <minimumValidSpeech>112</minimumValidSpeech>
        <maxTimeAnalysis>3000</maxTimeAnalysis>
        <maxTermToneAnalysis>30000</maxTermToneAnalysis>
    </callProgressAnalysis>
</campaign>

Example Create Request

<campaign>
    <name>APIOct1</name>
    <description>APIOct1</description>
    <dialingMode>PREVIEWONLY</dialingMode>
    <skillGroupInfos>
        <skillGroupInfo>
            <ivrPorts>0</ivrPorts>
            <overflowAgents>0</overflowAgents>
            <recordsToCache>1</recordsToCache>
            <skillGroup>
                <refURL>/unifiedconfig/config/skillgroup/5001</refURL>
                <name>sgcampaign</name>
            </skillGroup>
        </skillGroupInfo>
    </skillGroupInfos>
    <timeZone>
        <refURL>/unifiedconfig/config/timezone/UTC</refURL>
    </timeZone>
    <callProgressAnalysis>
        <enabled>true</enabled>
        <record>false</record>
        <minSilencePeriod>608</minSilencePeriod>
        <analysisPeriod>2500</analysisPeriod>
        <minimumValidSpeech>112</minimumValidSpeech>
        <maxTimeAnalysis>3000</maxTimeAnalysis>
        <maxTermToneAnalysis>30000</maxTermToneAnalysis>
    </callProgressAnalysis>
</campaign>