Alerts APIs
-
List Alert Campaigns
Description: Returns a list of jobs that ran within the given dates.Usage:
GET api/Alerts/List/{BeginDate}/{EndDate}
Parameter Type Source Description BeginDate String FromUri The starting date of the period to look in. Must be in the format of MM-DD-YYYY. EndDate String FromUri The ending date of the period to look in. Must be in the format of MM-DD-YYYY. Returns:
Array of AlertProfile objects
Examples:
<!-- Intent: retrieve a list of alerting campaigns between the given dates of 12/1/2012 and 12/31/2012. GET to the following url http://api.v4.swiftreach.com/api/Alerts/List/12-1-2012/12-31-2012 --> <!-- No XML input is required --> <!-- example return values --> <ArrayOfAlertProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <AlertProfile> <BeginStamp>12/1/2012 10:54:39 PM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/1/2012 10:54:59 PM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541867</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbjbo3d</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-01T22:54:35.443</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-01T22:54:35.443</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653047</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> <AlertProfile> <BeginStamp>12/2/2012 3:28:44 AM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/2/2012 3:29:04 AM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541897</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbc9yjt</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-02T03:28:42.367</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-02T03:28:42.367</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653077</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> </ArrayOfAlertProfile>
-
List Alert Campaigns
Description: Returns a page from the list of jobs that ran within the given datesUsage:
GET api/Alerts/List/{BeginDate}/{EndDate}/{PageSize}/{PageIndex}
Parameter Type Source Description BeginDate String FromUri The starting date of the period to look in. Must be in the format of MM-DD-YYYY. EndDate String FromUri The ending date of the period to look in. Must be in the format of MM-DD-YYYY. PageSize Int32 FromUri The total number of items to return in a page PageIndex Int32 FromUri The current page to return Returns:
Array of AlertProfile objects
Examples:
<!-- Intent: retrieve a list of alerting campaigns between the given dates of 12/1/2012 and 12/31/2012. This will return the first set of 5 results. (Page 1 with 5 rows per page) GET to the following url http://api.v4.swiftreach.com/api/Alerts/List/12-1-2012/12-31-2012/5/1 --> <!-- No XML input is required --> <!-- example return values --> <ArrayOfAlertProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <AlertProfile> <BeginStamp>12/1/2012 10:54:39 PM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/1/2012 10:54:59 PM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541867</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbjbo3d</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-01T22:54:35.443</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-01T22:54:35.443</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653047</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> <AlertProfile> <BeginStamp>12/2/2012 3:28:44 AM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/2/2012 3:29:04 AM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541897</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbc9yjt</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-02T03:28:42.367</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-02T03:28:42.367</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653077</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> </ArrayOfAlertProfile>
-
Count Alert Campaigns
Description: Returns the total number of jobs that ran within the given dates.Usage:
GET api/Alerts/Count/{BeginDate}/{EndDate}
Parameter Type Source Description BeginDate String FromUri The starting date of the period to look in. Must be in the format of MM-DD-YYYY. EndDate String FromUri The ending date of the period to look in. Must be in the format of MM-DD-YYYY. Returns:
Returns the number of jobs
Examples:
<!-- Intent: retrieve a the total number of alerting campaigns between the given dates of 12/1/2012 and 12/31/2012. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Count/12-1-2012/12-31-2012 --> <!-- No XML input is required --> <!-- Example Return Value --> <int>3</int>
-
List Active Alert Campaigns
Description: Returns a list of all active jobs. This includes in-progress, queing, and paused.Usage:
GET api/Alerts/Active
Returns:
Array of AlertProfile objects
Examples:
<!-- Intent: retrieve a list of alerting campaigns that are currently active GET to the following url http://api.v4.swiftreach.com/api/Alerts/Active --> <!-- No XML input is required --> <!-- example return values --> <ArrayOfAlertProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <AlertProfile> <BeginStamp>12/1/2012 10:54:39 PM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/1/2012 10:54:59 PM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541867</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbjbo3d</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-01T22:54:35.443</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-01T22:54:35.443</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653047</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> <AlertProfile> <BeginStamp>12/2/2012 3:28:44 AM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/2/2012 3:29:04 AM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541897</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbc9yjt</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-02T03:28:42.367</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-02T03:28:42.367</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653077</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> </ArrayOfAlertProfile>
-
Get Alert Campaign Profile
Description: Returns the profile for the given jobcodeUsage:
GET api/Alerts/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri The unique numerical code that identifies the job to return Returns:
Returns the campaignprofile for the given job.
Examples:
<!-- Intent: retrieve the profile for the alerting campaign with jobcode of 1541867 GET to the following url http://api.v4.swiftreach.com/api/Alerts/1541867 --> <!-- No XML input is required --> <!-- Example Return Value --> <AlertProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <BeginStamp>12/1/2012 10:54:39 PM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d2p1:ContactList> <d2p1:ChangeStamp>2012-08-01T15:21:12.653</d2p1:ChangeStamp> <d2p1:ChangedByUser>sample</d2p1:ChangedByUser> <d2p1:CreateStamp>2012-08-01T14:47:57.38</d2p1:CreateStamp> <d2p1:CreatedByUser>sample</d2p1:CreatedByUser> <d2p1:DeleteLocked>false</d2p1:DeleteLocked> <d2p1:Description>Bob's Personal Contact Information</d2p1:Description> <d2p1:ExposeHomePortal>false</d2p1:ExposeHomePortal> <d2p1:ExposeVisitorPortal>false</d2p1:ExposeVisitorPortal> <d2p1:ListCode>668027</d2p1:ListCode> <d2p1:ListName>Bob's Contact List</d2p1:ListName> <d2p1:ListSize>1</d2p1:ListSize> <d2p1:ListType>List</d2p1:ListType> <d2p1:PendingApprovalCount>0</d2p1:PendingApprovalCount> <d2p1:SubscriptionRequiresApproval>false</d2p1:SubscriptionRequiresApproval> </d2p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/1/2012 10:54:59 PM</EndStamp> <FaxObject i:nil="true" xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541867</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d2p1:Body> <d2p1:SMS_Content> <d2p1:Body> <d2p1:SMS_TEXT_SOURCE i:type="d2p1:SMS_TEXT_SOURCE_TEXT"> <d2p1:TextType>sms_text_source_text</d2p1:TextType> <d2p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbjbo3d</d2p1:Text> </d2p1:SMS_TEXT_SOURCE> </d2p1:Body> <d2p1:SpokenLanguage>English</d2p1:SpokenLanguage> <d2p1:Subject>Middlesex County Weather Alerts</d2p1:Subject> </d2p1:SMS_Content> </d2p1:Body> <d2p1:ChangeStamp>2012-12-01T22:54:35.443</d2p1:ChangeStamp> <d2p1:ChangedByUser/> <d2p1:CreateStamp>2012-12-01T22:54:35.443</d2p1:CreateStamp> <d2p1:CreatedByUser>sample</d2p1:CreatedByUser> <d2p1:DefaultSpokenLanguage>English</d2p1:DefaultSpokenLanguage> <d2p1:DeleteLocked>false</d2p1:DeleteLocked> <d2p1:Description>Weather Alert</d2p1:Description> <d2p1:FromAddress/> <d2p1:FromName>S911V4</d2p1:FromName> <d2p1:LastUsed>0001-01-01T00:00:00</d2p1:LastUsed> <d2p1:Name>Bob's Weather Alert</d2p1:Name> <d2p1:ReplyConfirmation/> <d2p1:ReplyCriteria/> <d2p1:ReplyType>None</d2p1:ReplyType> <d2p1:ReplyWindow>15</d2p1:ReplyWindow> <d2p1:SMSCode>653047</d2p1:SMSCode> <d2p1:Visibility>Temporary</d2p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile>
-
Send Alerts to gzipped Array of Contacts and Hotline
Description: Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.Usage:
POST api/Alerts/Send/Publish/Compressed/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}/{Hotline}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. Hotline String FromUri The phone number of the hotline to publish the voice message to Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Contact List and Hotline
Description: Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method.Usage:
POST api/Alerts/Send/Publish/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}/{Hotline}/{ListCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. ListCode Int32 FromUri The unique numerical code of the contact list to send the messages to. Hotline String FromUri The phone number of the hotline to publish the voice message to Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Array of Contacts and Hotline
Description: Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method.Usage:
POST api/Alerts/Send/Publish/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}/{Hotline}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. Contacts Contact[] FromBody Contact array to send the messages to. Hotline String FromUri The phone number of the hotline to publish the voice message to Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to gzipped Array of Contacts
Description: Launches an alert using any combination of the given message types. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.Usage:
POST api/Alerts/Send/Compressed/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to gzipped Array of Contacts
Description: Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.Usage:
POST api/Alerts/Send/Dynamic/Compressed/{TaskName}/{EnableVoice}/{EnableSMS}/{EnableEmail}/{EnablePager}/{EnableHotline}/{Hotline}
Parameter Type Source Description TaskName String FromUri The name of the alert. EnableVoice Boolean FromUri True if this message should be sent by voice phone call EnableSMS Boolean FromUri True if this message should be sent by SMS EnableEmail Boolean FromUri True if this message should be sent by Email EnablePager Boolean FromUri True if this message should be sent by Pager EnableHotline Boolean FromUri True if this message should be posted to an inbound hotline Hotline String FromUri The phone number of the hotline to post this message to (if EnableHotline is True) Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Contact List
Description: Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.Usage:
POST api/Alerts/Send/Dynamic/{TaskName}/{EnableVoice}/{EnableSMS}/{EnableEmail}/{EnablePager}/{EnableHotline}/{Hotline}/{ListCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. EnableVoice Boolean FromUri True if this message should be sent by voice phone call EnableSMS Boolean FromUri True if this message should be sent by SMS EnableEmail Boolean FromUri True if this message should be sent by Email EnablePager Boolean FromUri True if this message should be sent by Pager EnableHotline Boolean FromUri True if this message should be posted to an inbound hotline Hotline String FromUri The phone number of the hotline to post this message to (if EnableHotline is True) ListCode Int32 FromUri The unique numerical code of the contact list to send the messages to. MessageContent String FromBody The content of the alert message. Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Array of Contacts
Description: Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.Usage:
POST api/Alerts/Send/Dynamic/{TaskName}/{EnableVoice}/{EnableSMS}/{EnableEmail}/{EnablePager}/{EnableHotline}/{Hotline}
Parameter Type Source Description TaskName String FromUri The name of the alert. EnableVoice Boolean FromUri True if this message should be sent by voice phone call EnableSMS Boolean FromUri True if this message should be sent by SMS EnableEmail Boolean FromUri True if this message should be sent by Email EnablePager Boolean FromUri True if this message should be sent by Pager EnableHotline Boolean FromUri True if this message should be posted to an inbound hotline Hotline String FromUri The phone number of the hotline to post this message to (if EnableHotline is True) SendData AlertData FromBody Contains message content and the array of contacts to send the message to. See AlertData Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alert that initiates a two-way phone call
Description: Calls the OriginatingPhone. When the person answers the first call and presses any key, a call is automatically initiated to the terminating phone number and bridged with the first call. This is commonly used for applications such as Click-to-Call.Usage:
POST api/Alerts/Send/Bridged/{TaskName}/{OriginatingPhone}/{TerminatingPhone}
Parameter Type Source Description TaskName String FromUri The name of the alert. OriginatingPhone String FromUri Phone number to call initially TerminatingPhone String FromUri The phone number to be bridged onto the call MessageContent String FromBody The message presented to the first phone call - required to state press any key Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Contact List
Description: Launches an alert using any combination of the given message types.Usage:
POST api/Alerts/Send/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}/{ListCode}/{MapCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. ListCode Int32 FromUri The unique numerical code of the contact list to send the messages to. MapCode Int32 FromUri The unique numerical code of the map zone to filter the list contacts by Returns:
Returns the numerical jobcode
Examples:
//-- Currently no examples for XML --//
-
Send Alerts to Contact List
Description: Launches an alert using any combination of the given message types.Usage:
POST api/Alerts/Send/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}/{ListCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. ListCode Int32 FromUri The unique numerical code of the contact list to send the messages to. Returns:
Returns the numerical jobcode
Examples:
<!-- Intent: sends a voice message with voicecode 100123 and sends an email message with emailcode 100278 to an existing contact list with listcode 200000 and name the alert "My Test Alert" POST to the following url http://api.v4.swiftreach.com/api/Alerts/Send/MY%20Test%20Alert/100123/0/0/100278/0/200000 --> <!-- No XML input is required --> <!-- example return value --> <int>123456</int>
-
Send Alerts to Array of Contacts
Description: Launches an alert using any combination of the given message types.Usage:
POST api/Alerts/Send/{TaskName}/{VoiceCode}/{FaxCode}/{SMSCode}/{EmailCode}/{PagerCode}
Parameter Type Source Description TaskName String FromUri The name of the alert. VoiceCode Int32 FromUri The unique numerical code of the voice message to send. A value of 0 will cause this to be ignored. FaxCode Int32 FromUri The unique numerical code of the fax message to send. A value of 0 will cause this to be ignored. SMSCode Int32 FromUri The unique numerical code of the sms message to send. A value of 0 will cause this to be ignored. EmailCode Int32 FromUri The unique numerical code of the email message to send. A value of 0 will cause this to be ignored. PagerCode Int32 FromUri The unique numerical code of the pager message to send. A value of 0 will cause this to be ignored. Contacts Contact[] FromBody Contact array to send the messages to. Returns:
Returns the numerical jobcode
Examples:
<!-- Intent: sends a voice message with voicecode 100123 and sends an email message with emailcode 100278 to an array of contacts and names the alert "My Test Alert" POST to the following url http://api.v4.swiftreach.com/api/Alerts/Send/MY%20Test%20Alert/100123/0/0/100278/0 --> <ArrayOfContact> <Contact> <EntityName>Sample One</EntityName> <EntityGuid>a44667cf-e4e5-4f28-b4e2-948ba2065c09</EntityGuid> <Email>alerts@swiftreach.com</Email> <SMSNetwork>0</SMSNetwork> <PagerNetwork>0</PagerNetwork> <Phones> <PhoneProfile> <Phone>5551234567</Phone> <Extension/> <OptInSMS>true</OptInSMS> <PhoneType>phonetype_voice</PhoneType> <PhoneLabel>Mobile</PhoneLabel> </PhoneProfile> </Phones> <UserDefined> <KeyValue><Key>FieldOne</Key><Value>foobar</Value></KeyValue> <KeyValue><Key>FieldTwo</Key><Value>other</Value></KeyValue> </UserDefined> </Contact> <Contact> <EntityName>Sample Two</EntityName> <EntityGuid>a44667cf-e4e5-4f28-b4e2-948ba2065c09</EntityGuid> <Email>alerts@swiftreach.com</Email> <SMSNetwork>0</SMSNetwork> <PagerNetwork>0</PagerNetwork> <Phones> <PhoneProfile> <Phone>5551234568</Phone> <Extension/> <OptInSMS>true</OptInSMS> <PhoneType>phonetype_voice</PhoneType> <PhoneLabel>Mobile</PhoneLabel> </PhoneProfile> </Phones> <UserDefined> <KeyValue><Key>FieldOne</Key><Value>foobar</Value></KeyValue> <KeyValue><Key>FieldTwo</Key><Value>other</Value></KeyValue> </UserDefined> </Contact> </ArrayOfContact> <!-- example return value --> <int>123456</int>
-
Pause Alert Campaign
Description: Pauses the given active jobUsage:
PUT api/Alerts/Pause/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job Returns:
Returns 0 on success
Examples:
<!-- Intent: Pauses an active alerting campaign with jobcode of 123456 PUT to the following url http://api.v4.swiftreach.com/api/Alerts/Pause/123456 --> <!-- no xml input required --> <!-- example return value --> <int>0</int>
-
Resume Alert Campaign
Description: Resumes the given paused jobUsage:
PUT api/Alerts/Resume/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job Returns:
Returns 0 on success
Examples:
<!-- Intent: Pauses a paused alerting campaign with jobcode of 123456 PUT to the following url http://api.v4.swiftreach.com/api/Alerts/Resume/123456 --> <!-- no xml input required --> <!-- example return value --> <int>0</int>
-
Cancel Alert Campaign
Description: Cancels the given active or paused jobUsage:
PUT api/Alerts/Cancel/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job Returns:
Returns 0 on success
Examples:
<!-- Intent: Cancels an alerting campaign with jobcode of 123456 PUT to the following url http://api.v4.swiftreach.com/api/Alerts/Cancel/123456 --> <!-- no xml input required --> <!-- example return value --> <int>0</int>
-
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>