-
API.V4.DataWrappers.IncidentTriggerInstructionsProfile Object Reference
Defines the actions taken for sending instructions to the occupants when an incident begins
Field Type Description IncludeOccupants System.Boolean True if occupants should be included to recieve instructions when the incident begins OccupantsList System.Int32 The unique numerical ListCode identifying the pre-defined list of occupants to be loaded into the incident IncludeRoamingOccupants System.Boolean True if occupants, not on any predefined list, but roaming within the boundaries of the incident should be loaded into the incident. OccupantsPullCallback API.V4.DataWrappers.CallbackProfile Information required to pull occupant information dynamically from a 3rd party system upon incident creation. SendInstructions System.Boolean True if instructions should be sent to occupants UseDescriptionAsInstructions System.Boolean True if the instructions should be the same as the incident description. This overrides any instructions specified in Content. SendByVoice System.Boolean If true instructions will be sent to occupants by voice phone call. IncludeOccupants must be set to true. SendBySMS System.Boolean If true instructions will be sent to occupants by SMS. IncludeOccupants must be set to true. SendByChat System.Boolean If true instructions will be sent to occupants by chat message. IncludeOccupants must be set to true. Content System.String The instructions to send to the building occupants. This must not exceed 140 characters. VoiceCallerId System.String The caller-id that the voice call with the instructions will be sent from. Both SendByVoice and IncludeOccupants must be set to true. SMSFromName System.String The from-name that will be prepended to the sms body containing the instructions. Both SendByVoice and IncludeOccupants must be set to true. EnableCheckinBySMS System.Boolean True if occupants should also be prompted to check-in using SMS.