SMSTrigger APIs
-
Delete existing SMS Alert Trigger
Description: Deletes an SMSTriggerUsage:
DELETE api/Alerts/Triggers/Text/Delete/{TriggerCode}
Parameter Type Source Description TriggerCode Int32 FromUri The unique numerical code identifying the SMSTrigger to delete Returns:
0 on success
Examples:
<!-- Intent: Delete Text alert trigger with TriggerCode of 100000 DELETE to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/Delete/100000 --> <!-- No XML input is required --> <!-- example return value --> <int>0</int>
-
Create a new SMS Alert Trigger
Description: Creates a new SMS Alert trigger.Usage:
POST api/Alerts/Triggers/Text/Create
Parameter Type Source Description Trigger SMSTrigger FromBody SMSTrigger object to create Returns:
Non-zero TriggerCode on success
Examples:
<!-- Intent: Create a new Text Alert Trigger POST to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/Create --> <SMSTrigger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <CreateStamp i:nil="true" /> <CreatedByUser i:nil="true" /> <ChangeStamp i:nil="true" /> <ChangedByUser i:nil="true" /> <TriggerCode>0</TriggerCode> <InboundSMSPhone>2012583529</InboundSMSPhone> <AlertName>Lock Down</AlertName> <Description>There is a lockdown</Description> <IsActive>true</IsActive> <ReplyMessage>The lock down sequence has been activated!</ReplyMessage> <RequireAuthentication>true</RequireAuthentication> <AccessList>668927</AccessList> <RequirePincode>false</RequirePincode> <RequireCommand>true</RequireCommand> <Command>lockdown</Command> <RequireKeyword>false</RequireKeyword> <Keyword i:nil="true" /> <ContactList>668927</ContactList> <CapAction i:nil="true" /> <EmailAction i:type="EmailActionAuto"> <Type>AutoGenerate</Type> <FromAddress>nick@swiftreach.com</FromAddress> <FromName>Swift911V4</FromName> </EmailAction> <FacebookAction i:nil="true" /> <FaxAction i:nil="true" /> <HotlineAction i:type="HotlineActionAuto"> <HotlinePhone>2012583529</HotlinePhone> <Type>AutoGenerate</Type> </HotlineAction> <PagerAction i:nil="true" /> <RssAction i:nil="true" /> <SMSAction i:type="SMSActionAuto"> <Type>AutoGenerate</Type> <FromName>S911V4</FromName> </SMSAction> <ScenarioAction i:nil="true" /> <TwitterAction i:nil="true" /> <VoiceAction i:type="VoiceActionPredefined"> <Type>Predefined</Type> <VoiceCode>665847</VoiceCode> </VoiceAction> </SMSTrigger>
-
Update an existing SMS Alert Trigger
Description: Updates an existing SMSTrigger profileUsage:
PUT api/Alerts/Triggers/Text/Update
Parameter Type Source Description Trigger SMSTrigger FromBody SMSTrigger object to update Returns:
0 on success
Examples:
<!-- Intent: Update the Text Alert Trigger with TriggerCode of 100227 PUT to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/Update --> <SMSTrigger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <CreateStamp>2013-06-28T17:00:06.003</CreateStamp> <CreatedByUser>sample</CreatedByUser> <ChangeStamp>2013-06-28T19:35:41.453</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <TriggerCode>100227</TriggerCode> <InboundSMSPhone>2012583529</InboundSMSPhone> <AlertName>Lock Down</AlertName> <Description>There is a lockdown</Description> <IsActive>true</IsActive> <ReplyMessage>The lock down sequence has been activated!</ReplyMessage> <RequireAuthentication>true</RequireAuthentication> <AccessList>668927</AccessList> <RequirePincode>false</RequirePincode> <RequireCommand>true</RequireCommand> <Command>lockdown</Command> <RequireKeyword>false</RequireKeyword> <Keyword i:nil="true" /> <ContactList>668927</ContactList> <CapAction i:nil="true" /> <EmailAction i:type="EmailActionAuto"> <Type>AutoGenerate</Type> <FromAddress>nick@swiftreach.com</FromAddress> <FromName>Swift911V4</FromName> </EmailAction> <FacebookAction i:nil="true" /> <FaxAction i:nil="true" /> <HotlineAction i:type="HotlineActionAuto"> <HotlinePhone>2012583529</HotlinePhone> <Type>AutoGenerate</Type> </HotlineAction> <PagerAction i:nil="true" /> <RssAction i:nil="true" /> <SMSAction i:type="SMSActionAuto"> <Type>AutoGenerate</Type> <FromName>S911V4</FromName> </SMSAction> <ScenarioAction i:nil="true" /> <TwitterAction i:nil="true" /> <VoiceAction i:type="VoiceActionPredefined"> <Type>Predefined</Type> <VoiceCode>665847</VoiceCode> </VoiceAction> </SMSTrigger>
-
List SMS Alert Triggers
Description: Returns a list of SMSTrigger objectsUsage:
GET api/Alerts/Triggers/Text/List
Returns:
List of SMSTrigger objects
Examples:
<!-- Intent: retrieve a list of existing Text Alert Triggers GET to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/List --> <!-- No XML input is required --> <!-- example return values --> <ArrayOfSMSTrigger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <SMSTrigger> <CreateStamp>2013-06-28T17:00:06.003</CreateStamp> <CreatedByUser>sample</CreatedByUser> <ChangeStamp>2013-06-28T19:35:41.453</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <TriggerCode>100227</TriggerCode> <InboundSMSPhone>2012583529</InboundSMSPhone> <AlertName>Lock Down</AlertName> <Description>There is a lockdown</Description> <IsActive>true</IsActive> <ReplyMessage>The lock down sequence has been activated!</ReplyMessage> <RequireAuthentication>true</RequireAuthentication> <AccessList>668927</AccessList> <RequirePincode>false</RequirePincode> <RequireCommand>true</RequireCommand> <Command>lockdown</Command> <RequireKeyword>false</RequireKeyword> <Keyword i:nil="true" /> <ContactList>668927</ContactList> <CapAction i:nil="true" /> <EmailAction i:type="EmailActionAuto"> <Type>AutoGenerate</Type> <FromAddress>nick@swiftreach.com</FromAddress> <FromName>Swift911V4</FromName> </EmailAction> <FacebookAction i:nil="true" /> <FaxAction i:nil="true" /> <HotlineAction i:type="HotlineActionAuto"> <HotlinePhone>2012583529</HotlinePhone> <Type>AutoGenerate</Type> </HotlineAction> <PagerAction i:nil="true" /> <RssAction i:nil="true" /> <SMSAction i:type="SMSActionAuto"> <Type>AutoGenerate</Type> <FromName>S911V4</FromName> </SMSAction> <ScenarioAction i:nil="true" /> <TwitterAction i:nil="true" /> <VoiceAction i:type="VoiceActionPredefined"> <Type>Predefined</Type> <VoiceCode>665847</VoiceCode> </VoiceAction> </SMSTrigger> <SMSTrigger> <CreateStamp>2013-06-28T14:08:10.71</CreateStamp> <CreatedByUser>sample</CreatedByUser> <ChangeStamp>2013-07-01T15:08:55.173</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <TriggerCode>100217</TriggerCode> <InboundSMSPhone>2012583529</InboundSMSPhone> <AlertName>My Test SMS Feed</AlertName> <Description>this is a test</Description> <IsActive>true</IsActive> <ReplyMessage>Thank You!</ReplyMessage> <RequireAuthentication>false</RequireAuthentication> <AccessList>0</AccessList> <RequirePincode>false</RequirePincode> <RequireCommand>false</RequireCommand> <Command i:nil="true" /> <RequireKeyword>false</RequireKeyword> <Keyword i:nil="true" /> <ContactList>667987</ContactList> <CapAction i:nil="true" /> <EmailAction i:type="EmailActionAuto"> <Type>AutoGenerate</Type> <FromAddress>someone@swiftreach.com</FromAddress> <FromName>Swift911V4</FromName> </EmailAction> <FacebookAction i:nil="true" /> <FaxAction i:nil="true" /> <HotlineAction i:nil="true" /> <PagerAction i:nil="true" /> <RssAction i:nil="true" /> <SMSAction i:nil="true" /> <ScenarioAction i:nil="true" /> <TwitterAction i:nil="true" /> <VoiceAction i:nil="true" /> </SMSTrigger> </ArrayOfSMSTrigger>
-
Get total number of sms alert trigger
Description: Returns the total number of existing SMSTriggersUsage:
GET api/Alerts/Triggers/Text/Count
Returns:
Total number of existing SMSTriggers
Examples:
<!-- Intent: get the total number of existing Text Alert Triggers GET to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/Count --> <!-- No XML input is required --> <!-- example return value --> <int>2</int>
-
Enable or Disable an SMS Alert Trigger
Description: Enables or Disables an existing SMSTriggerUsage:
GET api/Alerts/Triggers/Text/Activate/{TriggerCode}/{Enabled}
Parameter Type Source Description TriggerCode Int32 FromUri The unique numerical code identifying the SMSTrigger to enable or disable Enabled Boolean FromUri True will enable the trigger. False will disable the trigger. Returns:
0 on success
Examples:
<!-- Intent: disable the Text alert trigger with TriggerCode of 100000 GET to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/Activate/100000/False --> <!-- No XML input is required --> <!-- example return value --> <int>0</int>
-
Get SMS Alert Trigger Profile
Description: Returns the SMSTrigger object for the given TriggerCodeUsage:
GET api/Alerts/Triggers/Text/{TriggerCode}
Parameter Type Source Description TriggerCode Int32 FromUri The unique numerical code identifying the SMSTrigger to return Returns:
SMSTrigger object
Examples:
<!-- Intent: retrieve the profile for Text Alert Trigger with TriggerCode of 100227 GET to the following url http://api.v4.swiftreach.com/api/Alerts/Triggers/Text/100227 --> <!-- No XML input is required --> <!-- example return value --> <SMSTrigger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <CreateStamp>2013-06-28T17:00:06.003</CreateStamp> <CreatedByUser>sample</CreatedByUser> <ChangeStamp>2013-06-28T19:35:41.453</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <TriggerCode>100227</TriggerCode> <InboundSMSPhone>2012583529</InboundSMSPhone> <AlertName>Lock Down</AlertName> <Description>There is a lockdown</Description> <IsActive>true</IsActive> <ReplyMessage>The lock down sequence has been activated!</ReplyMessage> <RequireAuthentication>true</RequireAuthentication> <AccessList>668927</AccessList> <RequirePincode>false</RequirePincode> <RequireCommand>true</RequireCommand> <Command>lockdown</Command> <RequireKeyword>false</RequireKeyword> <Keyword i:nil="true" /> <ContactList>668927</ContactList> <CapAction i:nil="true" /> <EmailAction i:type="EmailActionAuto"> <Type>AutoGenerate</Type> <FromAddress>nick@swiftreach.com</FromAddress> <FromName>Swift911V4</FromName> </EmailAction> <FacebookAction i:nil="true" /> <FaxAction i:nil="true" /> <HotlineAction i:type="HotlineActionAuto"> <HotlinePhone>2012583529</HotlinePhone> <Type>AutoGenerate</Type> </HotlineAction> <PagerAction i:nil="true" /> <RssAction i:nil="true" /> <SMSAction i:type="SMSActionAuto"> <Type>AutoGenerate</Type> <FromName>S911V4</FromName> </SMSAction> <ScenarioAction i:nil="true" /> <TwitterAction i:nil="true" /> <VoiceAction i:type="VoiceActionPredefined"> <Type>Predefined</Type> <VoiceCode>665847</VoiceCode> </VoiceAction> </SMSTrigger>