You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/regal-voice/index.md
+37-39Lines changed: 37 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ rewrite: true
3
3
title: Regal Voice Destination
4
4
---
5
5
6
-
[Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen outbound phone marketing and sales platform that helps consumer and financial services brands proactively engage and convert customers before they buy elsewhere.
6
+
[Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform that helps brands proactively engage and convert customers before they buy elsewhere.
7
7
8
8
Regal Voice maintains this destination. For any issues with the destination, contact their [Regal Voice support team](mailto:[email protected]).
9
9
@@ -61,13 +61,44 @@ analytics.identify({
61
61
62
62
Segment sends Identify calls to Regal Voice as an identify event.
63
63
64
-
For Regal Voice to trigger outbound voice or sms messages, Regal Voice must have the user's explicit opt-in for those channels.
64
+
Identify events are used to create users and update user attributes. If an identify event contains a phone, Regal Voice will create a contact in your Audience.
65
65
66
-
Anytime you collect opt-in for sms or voice calls, you should use an `identify` call to pass that opt-in information to Regal Voice. For many brands, this may happen before a user creates an account in your application.
66
+
## Track
67
+
68
+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does.
69
+
70
+
Segment recommends calling `track` on any user or system event that you may want Regal Voice to be able to use for lead scoring or as triggers or conditions when sending voice and sms campaigns.
71
+
72
+
Segment sends `track` calls to Regal Voice as a track event. Pass all attributes relevant to your use case into the `properties` object.
73
+
74
+
Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel.
75
+
76
+
An example for a financial services company might be that you want to tigger an outbound call to a user for whom a 'Loan Application Approved' event has been received, but not a 'Loan Signed' event (with some parameter around timing).
77
+
78
+
In that case, an example `track` call for the 'Loan Application Approved' event would look like:
79
+
80
+
```js
81
+
analytics.track('Loan Application Approved', {
82
+
loanType:'Personal loan',
83
+
amount:30000
84
+
currency:'USD'
85
+
term:12
86
+
})
87
+
```
88
+
89
+
## Collecting OptIn
90
+
91
+
In order to trigger outbound calls or sms messages from Regal Voice, you must collect the user’s explicit opt-in for those channels along with the user’s phone number.
92
+
93
+
There are 2 options for how you can let Regal Voice know a user has opted in:
94
+
95
+
1. Anytime you collect opt-in for sms or voice calls, you can trigger a track event after a user opts in and let the Regal Voice team know what track event is synonymous with opt-in collected (there is no required format for this event). The product will then automatically subscribe users who perform that event. (Note: for Regal Voice to subscribe a user, there must already be a phone provided for that user.)
96
+
97
+
2. Alternatively, anytime you collect opt-in for sms or voice calls, you can use an `identify` call to pass that opt-in information to Regal Voice by adding an optIn object.
67
98
68
99
Below is an example of what an `identify` call would look like for a user who opted into multiple channels (sms and voice calls) at once:
69
100
70
-
```js
101
+
```js
71
102
analytics.identify({
72
103
phone:'+19175554444',
73
104
age:30,
@@ -91,43 +122,10 @@ analytics.identify({
91
122
})
92
123
```
93
124
94
-
Supported messaging channels are: `sms`, `voice` and `email`.
125
+
Supported messaging channels are: `sms`, `voice` and `email`.
95
126
96
-
The `ip` field is required if you are opting in users server side.
127
+
For the identify method, the `ip` field is required if you are opting in users server side. (If you are opting in users client side, Segment automatically adds ip to the context, so you are not required to add it to the optIn object)
97
128
98
129
Make sure to include `timestamp` with the exact time the user opted in. Since traits are [cached](/docs/connections/sources/catalog/libraries/website/javascript/identity/#clearing-traits) and sent with subsequent Identify calls, Regal Voice ignores opt-ins that do not have a `timestamp` date.
99
130
100
-
101
-
## Track
102
-
103
-
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does.
104
-
105
-
Segment recommends calling `track` on any user or system event that you may want Regal Voice to be able to use for lead scoring or as triggers or conditions when sending voice and sms campaigns.
106
-
107
-
Segment sends `track` calls to Regal Voice as a track event. Pass allattributes relevant to your use case into the `properties` object.
108
-
109
-
Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel.
110
-
111
-
An example for a financial services company might be that you want to tigger an outbound call to a user for whom a 'Loan Application Approved' event has been received, but not a 'Loan Signed' event (with some parameter around timing).
112
-
113
-
In that case, an example`track` call for the 'Loan Application Approved' event would look like:
114
-
115
-
```js
116
-
analytics.track('Loan Application Approved', {
117
-
loanType:'Personal loan',
118
-
amount:30000
119
-
currency:'USD'
120
-
term:12
121
-
})
122
-
```
123
-
124
-
Regal Voice communications can also be triggered reactively in response to a user's request for a call back. For example, when a user schedules a call back on your site, the associated `track` call would look like:
0 commit comments