You can use @@ tags (at-at tags) in messages and message templates to automatically insert system, recipient and sender information when the messages are sent. They’re useful for personalising messages or providing message-specific information. For example, you can use the @@first_name@@ tag to add the first name of all recipients to messages.
Whispir supports a large set of standard @@ tags (as listed below) but also a range of customised tags:
- Custom fields and fields in the Events module/Event Studio are accessible via custom @@ tags. To find out how to access these fields contact the Whispir Support Team (firstname.lastname@example.org).
- Whispir’s Bulk Message feature supports custom @@ tags. Any header name in the imported contacts .CSV file can be added to your message content as a custom @@ tag.
Important! In a bulk message, to avoid any conflict with the standard @@ tags below Whispir strongly recommends that make your header names different to the standard tags. For example, use ‘dates’ and ‘times’ in your header, not ‘date’ and ‘time’ to prevent Whispir using the system's date and time instead of the values in your .CSV file. See About bulk messaging.
How to use @@ tags
In a message (or template) place your cursor at the point where you want the value to be inserted and type the tag name in the format @@tag_name@@. Ensure the tag name matches the correct format, including an underscore where a space would be.
You can view some populated fields in a message’s Preview mode. Others can’t be viewed because their value can only be determined once the message is sent. Create and send yourself a test message to check how they’re populated.
Note: If you use a particular @@ tag in a message but there’s no available data to populate it, the tag will display as empty space in the sent message. For example, if you include @@recipient_role@@ but a recipient’s contact profile doesn’t contain a value in the Role field, the message they receive will display a blank space.
Warning! If you include @@ tags in an SMS message be aware that once the tags are populated by actual data, the message’s character count could potentially exceed the single message limit. For example, @@web_link@@ is 12 characters long but the URL that will replace the tag is likely to be much longer. Your SMS message might end up being sent as more than one message and therefore incur additional charges.
Standard @@ tags
Date and time
@@dd@@ – Current day with leading zero (for example, 08)
@@mm@@ – Current month with leading zero (for example, 06)
@@yy@@ – Current year, short form (for example, 18)
@@yyyy@@ – Current year, long form (for example, 2018)
@@day@@ – Day in spoken form (for example, Wednesday)
@@month@@ – Month in spoken form (for example, June)
@@hrs@@ – Current hour in 24-hour format, with leading zero (for example, 08)
@@min@@ – Current minute with leading zero (for example, 07)
@@sec@@ – Current second with leading zero (for example, 09)
@@date@@ – Current date (for example, yyyy/mm/dd)
@@time@@ – Current time in 24 -hour format
@@short_hour@@ – Current time in 12-hour format (for example, 01:05 am)
@@messagelabel@@ – Message label
@@messagecategories@@ – Category names attached to this message, separated
@@pin@@ – Whispir message retrieval service callback PIN
@@web_link@@ – Link to a message’s web content
@@first_name@@ – Recipient's first name
@@recipient_first_name@@ – Recipient's first name
@@last_name@@ – Recipient's last name
@@personal_phone_primary@@ – Recipient's primary personal phone
@@personal_email_primary@@ – Recipient's primary personal email address
@@personal_address_primary@@ – Recipient's primary personal address
@@recipient_additionalrole@@ – The existing Additional Role field
@@recipient_last_name@@ – Recipient's last name
@@recipient_email@@ – Recipient's current default email address for the Email channel
@@recipient_role@@ – Recipient's role
@@recipient_sms@@ – Recipient's current default phone number for the Mobile channel
@@recipient_voice@@ – Recipient's current default phone number for the Voice channel
@@work_address_primary@@ – Recipient's primary work address
@@work_mobile_secondary@@ – Recipient's secondary work mobile phone
@@distributionlistname@@ – Distribution list name
@@sender_email@@ – Message author's current default email address
@@sender_first_name@@ – Message author's first name
@@sender_last_name@@ – Message author's last name
@@sender_full_name@@ – Message author's full name
@@sender_sms@@ – Message author's current default SMS number
@@team_name1@@ – The existing Team Name field
@@teleconf_account@@ – Voice conference account
@@teleconf_number@@ – Voice conference number
@@teleconf_mod_pin@@ – Voice moderator PIN
@@teleconf_pin@@ – Voice PIN
By request only (contact email@example.com)
@@msg_number@@ – Provides your company with a unique number for each message sent
@@ tags available for inviting active contacts
@@company_name@@ – Company name (as stored at Administration sidebar > Company Settings > General)
@@company_email@@ – Company admin email address (as stored at Administration sidebar > Company Settings > General)
@@company_phone@@ – Company phone number (as stored at Administration sidebar > Company Settings > General)
@@sender_company_name@@ – Company name (as stored at Administration sidebar > Company Settings > General)
@@portal_link@@ – The contact portal registration URL for contacts who are not yet active contacts OR the contact portal login URL for active contacts
@@ tags available for the inbound gateway (SMS In and Email In) workflow
Inbound gateway is an interface to Whispir via an inbound SMS or email, which can trigger custom actions or messages. See Set up an inbound gateway using address mapping for more information.
The @@ tags below can be used with messages in the inbound gateway workflow:
@@body@@ – Captures the original content of the inbound SMS or email message that triggered the workflow
@@fromuser@@ – Captures the originator (that is, the mobile number or email address) of the inbound SMS or email message that triggered the workflow
@@subject@@ – Captures the original subject of the inbound email message that triggered the workflow
- About creating a ‘classic’ message
- About message templates
- About the Rich Message Studio
- About bulk messaging
- About messaging
- Invite and manage active contacts
- About SMS message length