-
API.V4.DataWrappers.SMSTrigger Object Reference
An SMSTrigger will activate a set of preconfigured actions based upon criteria set for an incoming SMS message.
Field Type Description CreateStamp System.DateTime when this trigger was created ChangeStamp System.DateTime Last time this trigger changed CreatedByUser System.String The user who created this trigger ChangedByUser System.String Last user to change this trigger TriggerCode System.Int32 Unique numerical code identifying this trigger. This value will be assigned by the platform when the trigger is created. IsActive System.Boolean True if this trigger is active AlertName System.String The name of this trigger. Description System.String A brief description of what this trigger is used for. InboundSMSPhone System.String The inbound SMS phone number that the message will be sent to and this trigger is to be bound to. RequireAuthentication System.Boolean When true, the senders phone number and optional pin code must be validated against the access list before the trigger can be activated. AccessList System.Int32 The unique numerical code identifying the contact list to use as the access list for enabling this trigger. The senders phone number must exist on the access list for this trigger to be activated. RequirePincode System.Boolean In order to trigger the associated actions, a pin code must be sent as the first word of the message which is then validated against the senders phone number and associated pincode from the supplied Access List. RequireCommand System.Boolean When true, the supplied command must be specified as the first word of the message in order to trigger the associated actions Command System.String The command word (first word of the message) that must be present to trigger the associated actions. RequireKeyword System.Boolean When true, the supplied Keyword must be present in the body of the message content for this to be triggered. Keyword System.String The keyword to match in the body of the message content that will trigger the associated actions ReplyMessage System.String The reply message sent to the sender upon being triggered ContactList System.Int32 Contact list of recipients for the corresponding actions. This is required for Voice, SMS, Email, Fax and Pager actions. VoiceAction API.V4.DataWrappers.VoiceActionBase Voice Action to take. NULL if none. SMSAction API.V4.DataWrappers.SMSActionBase SMS Action to take. NULL if none. EmailAction API.V4.DataWrappers.EmailActionBase Email Action to take. NULL if none. FaxAction API.V4.DataWrappers.FaxActionBase Fax Action to take. NULL if none. HotlineAction API.V4.DataWrappers.HotlineActionBase Hotline Action to take. NULL if none. ScenarioAction API.V4.DataWrappers.ScenarioAction Scenario Action to take. NULL if none. PagerAction API.V4.DataWrappers.PagerActionBase Pager Action to take. NULL if none. FacebookAction API.V4.DataWrappers.FacebookActionBase Facebook Action to take. NULL if none. TwitterAction API.V4.DataWrappers.TwitterActionBase Twitter Action to take. NULL if none. RssAction API.V4.DataWrappers.RssActionBase RSS Action to take. NULL if none. CapAction API.V4.DataWrappers.CapActionBase CAP Action to take. NULL if none.