Text Message

The Text Message output allows you to send a text message via an externally accessible SMTP server. The subject and message body of the text message can be configured to use attribute values. A text message will be sent for each output feature sent to the output.

Example

  • An analyst configures a real-time analytic to filter events ingested by a feed and then sends a text message for any features that meet the filter criteria.
  • After performing analysis in a big data analytic, a researcher wants to summarize attributes of the results and send the resulting information in a text message.

Usage notes

  • The SMTP server must be externally accessible on the Internet.
  • When using the Text Message output, it is important to understand the velocity of the data. Each record sent to the output will generate a separate text message. This could quickly overload the capacity or rate limiting settings of an SMTP server. The recommended best practice is to use the Text Message output for incidents expected to occur infrequently.
  • Text messages can be sent to a single recipient, or to a set of recipients via a comma-separated list.
  • Text message recipients can be configured from an existing field, or by entering phone numbers for each carrier.
    • If configured from a field, the addresses should be in the format number@carrier_domain. Thus for a phone number of (123) 456-7890 using the carrier AT&T, the corresponding recipient address would be (123) 456-7890@txt.att.net.
    • If entering recipients by carrier, enter the phone numbers for each carrier selected in the Carrier drop-down.
  • Phone numbers can be entered with formatting such as (123) 456-7890 or without such as 1234567890. All extraneous characters are removed in processing, but a 10-digit number is required.

Parameters

ParameterDescriptionData Type

SMTP host

The SMTP server that will send the text message. For example:

smtp.HOST-NAME.com

String

SMTP server security

The type of SMTP encryption to use on all outgoing messages. Options include:

  • STARTTLS
  • SSL/TLS

String

Username

Username for the SMTP server.

String

Password

Password for the SMTP server.

Password

Sender's address

The address that will appear as the sender of the text message. For example:

(123) 456-7890@txt.att.net

Email

Recipients

The text message recipient(s). This can be supplied by an attribute in the outgoing data, or manually when configuring the output.

If using an attribute from the data and sending text messages to more than one recipient, use a comma-separated list.

Single recipient example: (123) 456-7890@txt.att.net

Multiple recipient example: (123) 456-7890@txt.att.net,(234) 567-8901@txt.att.net,(345) 678-9012@txt.att.net

If configuring manually, enter the phone numbers for each carrier selected in the drop-down. Multiple recipients can be entered in a comma-separated list.

Single recipient example: (123) 456-7890 with @txt.att.net selected in the Carrier drop-down.

Multiple recipient example: (123) 456-7890,(234) 567-8901,(345) 678-9012 with @txt.att.net selected in the Carrier drop-down.

Email

Subject

The subject of the text message. The subject can be configured in a singleline Arcade expression.

Arcade Singleline Text

Message body

The body of the text message. The message body can be configured in a multiline Arcade expression.

Access feature attribute values by enclosing it in the following token sequence:

$${$feature.any_attribute_name}

Arcade Multiline Text

Considerations and limitations

  • The SMTP server must be externally accessible on the Internet.
  • The recommended best practice is to use the Text Message output for incidents expected to occur relatively infrequently.