Alerts APIs
-
Get Alert Campaign Progress
Description: Returns the progress of the given jobUsage:
GET api/Alerts/Progress/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job Returns:
JOBSTATUS object with the current progress of the given active job
Examples:
<!-- Intent: returns the progress of alerting campaign with jobcode of 1541867 GET to the following url http://api.v4.swiftreach.com/api/Alerts/Progress/1541867 --> <!-- No XML input is required --> <!-- example return values --> <JOBSTATUS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Notification"> <CallsAnswered>0</CallsAnswered> <CallsBusy>0</CallsBusy> <CallsCongested>0</CallsCongested> <CallsOperatorIntercepted>0</CallsOperatorIntercepted> <CallsRemaining>0</CallsRemaining> <CallsUnanswered>0</CallsUnanswered> <EmailSize>0</EmailSize> <EmailsRemaining>0</EmailsRemaining> <EmailsSent>0</EmailsSent> <JobState>job_completed</JobState> <PageSize>0</PageSize> <PagesRemaining>0</PagesRemaining> <PagesSent>0</PagesSent> <SMSSize>1</SMSSize> <SMSsRemaining>0</SMSsRemaining> <SMSsSent>1</SMSsSent> <TotalCalls>0</TotalCalls> <VoiceSize>0</VoiceSize> </JOBSTATUS>