Campaign Status API

Use the Campaign Status API to get the real-time status of running Outbound Option campaigns.

URL

https://<server>/unifiedconfig/config/campaign/<campaign-id>/runtimestats

Note	You must specify the ID for a campaign that was created using the Outbound Campaign API (see Outbound Campaign API). If you specify the ID for a campaign created using the Outbound Option Campaign tool, the request returns CceDBDataNotFoundException.

Operations

get: Returns the runtime status of a campaign.

Response Parameters

abandonDetectCount: The number of calls abandoned by the dialer.
abandonToIvrCount: The number of calls that were abandoned by the dialer and transferred to IVR.
agentClosedCount: The number of preview and callback calls that were closed by the agent.
agentRejectedCount: The number of preview and callback calls that were rejected by the agent.
answeringMachineCount: The number of calls that detected an answering machine.
attemptedCount: Summary total of the number of calls attempted.
busyCount: The number of calls that detected a busy signal.
callBackCount: The number of callback contacts.
cancelledDetectCount: The number of calls where the dialer canceled a ringing customer call.
closedCount: The number of contacts closed for any reason other than reaching a live customer.
customerAbandonDetectCount: The number of calls where the customer hung up immediately after picking up the phone.
customerNotHomeCount: The number of contacts where the party who answered the phone was not the customer.
dateTime: The date and time when this data was updated last. The format is yyyy-MM-ddTHH:mm:ss (for example, 2016-03-13T04:50:31).
faxDetectCount: The number of calls that detected a fax machine.
networkAnsMachineCount: The number of calls that detected a network answering machine.
noAnswerDetectCount: The number of calls that were not answered.
noDialToneDetectCount: The number of calls that did not detect a dial tone.
noRingBackDetectCount: The number of calls that did not detect a ring back.
personalCallbackCount: The number of callback contacts scheduled.
sitToneDetectCount: The number of calls that detected a special information tone (SIT).
talkTimeCount: The total number of seconds that agents spent talking on the phone since midnight.
totalCount: The total number of records available to dial for the current campaign.
totalVoiceCount: The number of live customers that have been reached for this campaign since the last time the imported dialing list was overwritten.
voiceCount: The number of calls for the day that ended in successful customer contact.
wrapupTimeCount: The number of seconds that agents spent in wrap-up mode since midnight.
wrongNumberCount: The number of contacts where the party who answered the phone indicated that the customer did not live there.

Example Get Response

Code Snippet

Copy
<runtimeStatus>
    <abandonDetectCount>0</abandonDetectCount>
    <abandonToIvrCount>0</abandonToIvrCount>
    <agentClosedCount>0</agentClosedCount>
    <agentRejectedCount>0</agentRejectedCount>
    <answeringMachineCount>0</answeringMachineCount>
    <attemptedCount>1</attemptedCount>
    <busyCount>0</busyCount>
    <callBackCount>0<callBackCount>
    <cancelledDetectCount>0</cancelledDetectCount>
    <closedCount>0</closedCount>
    <customerAbandonDetectCount>0</customerAbandonDetectCount>
    <customerNotHomeCount>0</customerNotHomeCount>
    <dateTime>2016-01-15T13:43:00</dateTime>
    <faxDetectCount>0</faxDetectCount>
    <networkAnsMachineCount>0</networkAnsMachineCount>
    <noAnswerDetectCount>0</noAnswerDetectCount>
    <noDialToneDetectCount>0</noDialToneDetectCount>
    <noRingBackDetectCount>0</noRingBackDetectCount>
    <personalCallbackCount>0</personalCallbackCount>
    <sitToneDetectCount>0</sitToneDetectCount>
    <talkTimeCount>1</talkTimeCount>
    <totalCount>0</totalCount>
    <totalVoiceCount>1</totalVoiceCount>
    <voiceCount>1</voiceCount>
    <wrapupTimeCount>0</wrapupTimeCount>
    <wrongNumberCount>0</wrongNumberCount>
</runtimeStatus>