Version:

LESSON

Twilio Voice Notification Profile

Description

Learn how to configure Twilio Voice Notifications in the Ignition Gateway and Designer and listen to an example Twilio Voice notification.

Video recorded using: Ignition 8.3

Transcript

(open in window)

[00:00] If you are looking for more direct, synchronous alarm notification options in Ignition, Twilio Voice notifications might be the perfect fit for your next project. This feature rounds out Ignition's Twilio support and offers an easier alternative to voice messaging solutions than VoIP- or SIP-based notifications. This video will primarily demonstrate the application of user-defined Twilio elements within Ignition. If you'd like more information on the Twilio side of setup, please be sure to view the Twilio Voice Settings Review video before moving on with the rest of this lesson. For more comprehensive guides and tutorials, please refer to the Twilio documentation linked below. In order to get us set up for success, there are some prerequisites we need to get in place. On the gateway, we'll explore the required modules. Next, we'll move on to the designer where we have a sample alarm set up that'll help us trigger the Twilio voice notification. We'll also refer back to the twilio.com console where we gathered some important Twilio account information for our configuration in the last lesson.

[01:06] First, we need to make sure we've got an up-to-date copy of the Alarm Notification Module installed on our gateway. If I go to platform, system, and modules, we can confirm that real quick. Without an active Alarm Notification Module, none of our notifications would function, so this module is the foundation we'll build upon for the rest of our work. Next, we need the Twilio Integration and Alarm Notification Module. If you need that .modl file, you can grab a copy from the downloads page on the Inductive Automation website. I've included a link to that page and the Inductive University lesson on Installing or Upgrading a Module below this video. I've already got the Twilio module installed too, so let's talk about the other requirements. We'll need at least one alarm set up on one of our tags as well. Let's head over to the designer to take a look at the sample alarm we'll be using in the tag browser. I'll open up the generic sim folder and we can focus on our WriteableFloat1 tag.

[02:04] Earlier, I set up a sample alarm that'll go off if the tag value hits 1.2 or higher. Now that we have our prerequisites, we need to set up all the Twilio and Alarm Notification connections so that we'll be able to send a Twilio Voice notification when our alarm is triggered. Our first step is to set up the Twilio account configuration on the Gateway using the account settings information we gathered from our twilio.com console account dashboard. If we go to Services, Alarming, and Twilio in the side menu, we can start with a name for our Twilio account. I'll just call ours TwilioAccount. Next, we can enter the Account SID and take a look at the options for our auth token. For simplicity's sake, I'll choose embedded and add in the token. With embedded secrets, the system automatically encrypts entered passwords and saves the values securely. If you'd like to know more about how the Secure Secrets Management options work, be sure to check out the links below. If you wish to receive inbound messages, the public hostname and the public port are extremely important parts of the functionality of this feature.

[03:10] The public hostname is the public facing URL, which points to an Ignition instance. It's used for the callback mechanism that allows the outgoing message to play, and it enables users to acknowledge alarms. If this field is left blank in the Ignition configuration, Twilio also provides several places in their console to define the public hostname and avoid possible application errors. The public port is the port on the public hostname to make the connection to. I'm using Port 8043. I'll leave the other settings at their defaults, but if you'd like more information on the other configuration options, please see the links to the Ignition User Manual below this video. Now let's set up the alarm roster For Twilio voice notifications. I'll go to rosters in the side menu and click on Create Alarm Roster. Let's name this TwilioVoice. If we click on the three dots menu next to our new alarm roster, we can manage the existing users that we want to receive Twilio Voice notifications.

[04:09] I already have some users on my default user source, so I'll select default and set up the operator as the one on the on-call roster. This user already has my contact information and a sample pin number I set up for testing purposes. Our alarm notification profile needs to be set up next. I'll go to the notification page, and we can click Create Profile to get our Twilio Voice notification profile in place. Here, we can select Twilio Voice Notification. In the general settings, I'll keep it simple and give our notification profile a descriptive name -- TwilioVoiceNotification. In the Twilio section, I can choose the Twilio account we set up earlier in the gateway. Let's take a look at the configuration options. I'm gonna keep the Call Duration and Answer Timeout settings as they are, but we have a number of other settings to choose from so we can customize the call experience.

[05:02] The Acknowledgement Allowed setting allows users receiving synchronous calls to acknowledge alarms via their phone. Pin Authentication adds an optional layer of security where users can be authenticated before receiving the voice message. Broadcast Enabled ensures that all users on the designated on-call roster will be notified if this setting is enabled, while Record Calls does just what it says via the Twilio recording feature. I'll enable the first two settings to make our testing a little more interesting. Next, we can choose whatever voice we like. Language selection is the final configuration piece, and I can choose what I want from a variety of options. I'll just save my changes, and our voice notification profile will appear in the alarm notification profile screen. If you'd like to test a profile, there is a test button here above the list that allows you to enter relevant information and verify your configuration. To tie everything together, we need to create a Twilio Voice Pipeline in the designer.

[06:06] Let's hop over to the designer and go into the alarm notification pipelines workspace. I'll set up a new blank example and call it TwilioVoicePipeline. We can drag on a notification block and connect the starting point to it. Next, let's go down to the pipeline block editor. Using the dropdown in the notification tab, we can add the notification profile we set up for Twilio Voice. Here, we also need to make sure that the correct from number is selected. That number is part of the information we gathered from our twilio.com account. Now, we can add our Twilio voice on-call roster in the contacts tab to complete the notification block. Finally, so our alarm knows where to send that information, we need to go into the alarm for WriteableFloat1, scroll down to the notification section, and add in the active notification pipeline using the dropdown menu. It's time to check our work.

[07:05] I'll make sure I save all our changes in the designer, and we can play around with the values for our WriteableFloat1 tag to set off an alarm. I'll play the audio here so you can hear what that sounds like. Ignition alarm notification. Please enter your pin followed by the pound sign. At 8:55 and 44 seconds Alarm named ALARM became active with the value of 1.5. Press one to acknowledge, press two to ignore, press three to repeat. Alarm has been acknowledged. Thank you. Goodbye. Twilio Voice Notifications in Ignition provide another robust and flexible way to deliver critical alarm information. This feature complements Ignition's existing notification capabilities, offering a direct synchronous communication channel that can be tailored to your specific needs.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.