Reports Campaign Queue

Returns called Campaign Queue details for given period.

100 records maximum for a single request.

A sync method.


Required Parameters:

FieldDescription
app_tokenMandatory. Application token supplied by Alotech.
startdateMandatory. Start date in %Y-%m-%d %H:%M:%S format.
finishdateMandatory. Finish date in %Y-%m-%d %H:%M:%S format.
campaignMandatory. Campaign key for target campaign.
contactOptional. If provided startdate, finishdate and campaign parameters will be ignored. Only records belong this contact will be displayed.
uniqueidOptional. If provided startdate, finishdate and campaign parameters will be ignored. Only records belong this uniqueid will be displayed.
cursorOptional. You can request to get more records with the cursor.

Explanation of Fields in Response:

FieldDescription
callkeyCall key of Campaign Queue call.
campaignqueuekeyKey of Campaign Queue record.
contactkeyContact key of Campaign Queue call.
agentnameAgent name if call connected to an agent.
agentusernameAgent username if call connected to an agent.
listnameList name of list that has current contact.
campaignnameCampaign name of current Campaign Queue call.
phonenumberCalled phone number.
isSuccess"true" if call successfully completed. If not "false".
insertdatetimeInsert date and time of current Campaign Queue record.
reasoncodeReason code of call.
finishcodeFinish code of call.
planned_call_datePlanned call date and time if this is a scheduled call.
call_start_timeStart date and time of call.
call_finish_timeFinish date and time of call.
call_connect_timeConnection date and time of call.
call_disconnect_timeDisconnection date and time of call.
campaignkeyCampaign key of current Campaign Queue call.
cursorCursor for retrieve next set of data. Supply this with same request to get next records.

Example Requests:

https://alotech.alo-tech.com/api/?function=reportsCampaignQueue&app_token=123456789&startdate=2019-01-10%2000:01:00&finishdate=2019-04-25%2023:59:59&campaign=abcd123456

https://alotech.alo-tech.com/api/?function=reportsCampaignQueue&app_token=123456789&contact=abcd123456

https://alotech.alo-tech.com/api/?function=reportsCampaignQueue&app_token=123456789&uniqueid=8566583