How to Use Tag Types and Operators

Context Based Tag Behaviour Explained

The behavior of tags will vary depending on where they are utilized:

• When tags are applied to endpoints, they act as filters to determine how calls will be routed.
• When tags are applied to numbers, they will preemptively tag any leads calling that number.
• When tags are applied to a conversion criteria or webhook, Retreaver will be instructed to only trigger those events if matching tags are found within that call similarly to a filter.

Assigning Tags to a Retreaver Component

1. When working with a tag field, typically named "Matches" or "Tag List" - You may click on the Wizard icon next to any tag input field to open the tag wizard helper. These input fields can be found in Call Endpoints (Buyers), Numbers, Conversion Groups, and Webhooks.
   
   
2. Once you open the Tag Wizard, you'll first need to choose which data type this tag is going to be.
3. You can select the Tag Key you want to use, which is used to define the name of the data attribute you wish to represent. If you would like to use a custom Tag, you will first need to Create a Tag.
4. Now select the relevant Operator and Value for the type of tag you're adding. Retreaver will evaluate the tag value present on a call using the operator you selected. If the call conforms to the resulting expression, we'll consider it a match and trigger the actions associated with that component.
   
   
5. Lastly click Add to complete adding a Tag using the Wizard, you can choose to add more tags or continue with the individual page you're on.

Viewing your Call Tags

Reporting in Retreaver includes all call tags that have been associated with a call, these tags are visible in your call log, call overview & call reports to help you monitor and analyze your phone calls.

Tags are visible in your Call Log under the "Tags" column. Hovering over the tags will display their values.


Tags are also visible on the call overview page. Click on a specific UUID in your call log to view the call overview page.

You can also view your tags in a call report by including tags as a column when exporting your report.

Retreaver provides commonly used tags out of the box but also give you the freedom of creating your own tags allowing for flexible control and customization over your call tracking efforts.

Enabling IVR prompts for unresolved tags

You may enable prompts on tags to trigger an IVR or audio file and prompt callers for any unresolved tags. Only unresolved tags that are currently utilized on a campaign or call-buyer will trigger the prompt.

Example: If a caller previously filled out the tag value in a form submission, the tag prompt will be skipped, otherwise prompt the caller for additional information before attempting to route the call.

View our "How to Tag and Filter calls using Prompts guide" to learn more.

Substituting Tag Values using Replacement Tokens

Tags can be used to substitute values for outbound webhooks and even IVR message prompts by employing a concept of "replacement tokens".

Substitute a tag value by placing the tag key and surrounding it with square brackets, this will instruct Retreaver to automatically substitute the tag key with the associated tag value if it is present on that action.

Note* If the tag value is empty at the time when performing an action, no value be will be inserted. This could cause critical webhook errors down the line, avoid any issues by ensuring that your calls contain all the necessary data when utilizing them inside of webhooks. 

---

Substituting values inside of a webhook:

Say you wish to substitute tag values into a CRM webhook to create a customer profile, you could do so by filling out the field name, followed by the replacement token value as so:

www.CRM.com/create_lead/?phone_number=[caller_number]&publisher=[affiliate_id]

---

Substituting values inside of an IVR message:

Say you wish to utilize the first name you previously tagged to a call inside an IVR greeting message, you could do so by modifying the prompt text to include:

"Hello [first_name], we will connect you to an agent shortly". 

View our "How To Use Tag Values To Create Dynamic Prompts" guide for a demonstration on using replacement tokens inside IVR prompt messages.

List of available Tag Data Types

Below are the different Tag types available when creating a new Tag.

The variety of types should make it easy to track and route calls based on any type of tag you require. You can track and route calls based on data such as your caller's credit rating under a numeric type or first name under a text type for example. Each tag data type will offer different operators that you may utilize to control actions within Retreaver.

Possible uses of date tags include:

• Sale date for a mortgage.
• Date of birth for insurance.
• Graduation date for education.
• End or open date for a time-based offer.

Possible uses of numeric tags include:

• Sale price for a home mortgage.
• The credit rating for loans.
• The purchase price for auto.

Possible uses of the text tags include:

• State of employment.
• Over the age of 18.
• Name of a caller fetched from a CRM.
• Lead status of the caller.
• Session cookie or ID.

Using Tag Operators

Using tags with operators, you can more selectively control which Buyers get routed to, which conversion group is used, or which Webhooks are fired.

---

Text Tag Operators

You can use matching operators =~ and !~ on text tags to test for the presence or absence of a string or regular expression. Also available is the exclusion or not equal to operator, allowing you to block calls with certain attributes.

== 

Exactly equals. The value on the call is exactly this value. This is the default operator.
mortgage_type:==purchase

---

!=

Not equal to. The value on the call is anything that is not this value. mortgage_type:!=refinance

---

=~

Matches. Exactly matches the given string or regular expression. caller_state:=~california|new york

---

!~

Does not match. The value tagged on the call does not match the given string or regular expression.
keyword:!~free

---

Numeric, Date, and Date-time Tag Operators

We now support a full range of operators on numeric, date, and date-time Tags. You can create ranges by adding more than one Tag. For example, a Buyer tagged with loan_amount:>100000 and loan_amount:<600000 will only receive calls where the caller is looking for a loan between $100,000.00 and $600,000.00.

Note regarding numeric, date and date-time tag operations and comparisons:
Such tags must be created inside of the Retreaver platform. This will register tag values as their respective data types, otherwise tags will be treated as strings/text by default. Not creating/registering tags could cause unexpected behaviors during the comparison process. 

== [default]

Equals. The value on the call is exactly this value.

loan_amount:==1500

---

!=

Is not equal to. The value on the call is anything but this value. callback_at:!=2014-12-25

---

<

Less than. The value on the call is less than the given value.

loan_amount:<1000000

---

>

Greater than. The value on the call is greater than the given value.

loan_amount:>0

---

<=

Less than or equal to. The value on the call is not greater than the given value. loan_amount:<=1000000

---

>=

Greater than or equal to. The value tagged on the call is not less than the given value. loan_amount:>=100000

Note: sub_id=test and sub_id:test both represent an "equal to" operator regardless of tag data type.

Checking for the Presence or Absence of a Tag Value

Certain call networks might require the presence of certain tags to ensure TCPA consent is present, or they might require the absence of a tag to ensure a lead is valid through the absence of a fraud_score attribute.

In either scenario, you can achieve the desired filter results by applying the following regular expressions to your tag values:

You can test for the presence of a tag using the ".+" regular expression. IE "leadid:~.+"
Use the "matches" operator when filtering for text tag presence inside of the tag wizard.

You can test for the absence of a tag using the ".+" regular expression. IE "fraud_caller_score:!~.+"
Use the "does not match" operator when filtering for text tag absence inside of the tag wizard.

Matching buyers using multiple tag values

Created tags that are associated on a buyer level act as a filter for that agent. You can add duplicate keys with different values but at least one value must match with the key in order to route to that buyer.

You generally also want to have a fallback Buyer that takes any value for a given key. If a buyer accepts all values for a tag key, simply leave it untagged.

A Buyer could accept several different values for an offer and exclude certain other ones: Product_Interest:Insurance, Product_Interest:Healthcare, Product_Interest!=Phoneplan will route calls to that buyer if they are interested in Insurance or Healthcare but NOT Phoneplans

You could create a buyer that only accepts calls from a specific publisher or callers from specific states looking for a specific service. Any criteria you can think of can be used to direct traffic within Retreaver using tags.