Skip to content

Commit 313677f

Browse files
committed
Update regalvoice destination docs
1 parent 082da9c commit 313677f

File tree

1 file changed

+14
-18
lines changed
  • src/connections/destinations/catalog/regal-voice

1 file changed

+14
-18
lines changed

src/connections/destinations/catalog/regal-voice/index.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ rewrite: true
33
title: Regal Voice Destination
44
---
55

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.
77

88
Regal Voice maintains this destination. For any issues with the destination, contact their [Regal Voice support team](mailto:[email protected]).
99

@@ -59,15 +59,21 @@ analytics.identify({
5959
});
6060
```
6161

62-
Segment sends Identify calls to Regal Voice as an identify event.
62+
Segment sends Identify calls to Regal Voice as an identify event. If an identify event contains a phone, Regal Voice will create a contact in your Audience.
6363

64-
For Regal Voice to trigger outbound voice or sms messages, Regal Voice must have the user's explicit opt-in for those channels.
6564

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.
65+
## Collecting OptIn
66+
67+
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.
68+
There are 2 options for how you can let Regal Voice know a user has opted in.
69+
70+
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.)
71+
72+
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.
6773

6874
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:
6975

70-
```js
76+
```js
7177
analytics.identify({
7278
phone: '+19175554444',
7379
age: 30,
@@ -91,9 +97,9 @@ analytics.identify({
9197
})
9298
```
9399

94-
Supported messaging channels are: `sms`, `voice` and `email`.
100+
Supported messaging channels are: `sms`, `voice` and `email`.
95101

96-
The `ip` field is required if you are opting in users server side.
102+
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)
97103

98104
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.
99105

@@ -104,7 +110,7 @@ If you aren't familiar with the Segment Spec, take a look at the [Track method d
104110

105111
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.
106112

107-
Segment sends `track` calls to Regal Voice as a track event. Pass allattributes relevant to your use case into the `properties` object.
113+
Segment sends `track` calls to Regal Voice as a track event. Pass all attributes relevant to your use case into the `properties` object.
108114

109115
Regal Voice communications can be triggered proactively to a user based on their activity or inactivity - in order to nudge them through your funnel.
110116

@@ -120,14 +126,4 @@ analytics.track('Loan Application Approved', {
120126
term: 12
121127
})
122128
```
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:
125-
126-
```js
127-
analytics.track('Call Back Requested', {
128-
timing: '2020-09-01 15:40:00 -04:00',
129-
expiry: 3600,
130-
urgency: 'scheduled'
131-
}
132-
```
133129
---

0 commit comments

Comments
 (0)