Skip to content

Commit d6c47fd

Browse files
DarkZatarraDaniel Bacanusanscontext
authored
Regalvoice Source Documentation (#1582)
* Small update to events and parameters lists * Second round of updates * Update src/connections/destinations/catalog/regal-voice/index.md Co-authored-by: Daniel Bacanu <[email protected]> Co-authored-by: LRubin <[email protected]>
1 parent f27d0ed commit d6c47fd

File tree

2 files changed

+111
-20
lines changed
  • src/connections
    • destinations/catalog/regal-voice
    • sources/catalog/cloud-apps/regal-voice

2 files changed

+111
-20
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ analytics.identify({
7777
{
7878
channel: "sms",
7979
subscribed: true,
80-
subscribedAt: "2020-08-25T21:23:43Z",
80+
timestamp: "2020-08-25T21:23:43Z",
8181
ip: "172.16.254.1",
8282
text: "By clicking the 'Submit' button below, I agree to receive automated marketing SMS and calls."
8383
},
8484
{
8585
channel: "voice",
8686
subscribed: true,
87-
subscribedAt: "2020-08-25T21:23:43Z",
87+
timestamp: "2020-08-25T21:23:43Z",
8888
ip: "172.16.254.1",
8989
text: "By clicking the 'Submit' button below, I agree to receive automated marketing SMS and calls."
9090
}]
@@ -95,7 +95,7 @@ Supported messaging channels are: `sms`, `voice` and `email`.
9595

9696
The `ip` field is required if you are opting in users server side.
9797

98-
Make sure to include `subscribedAt` 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 without a `subscribedAt` date.
98+
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.
9999

100100

101101
## Track

‎src/connections/sources/catalog/cloud-apps/regal-voice/index.md‎

Lines changed: 108 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,39 @@ The table below lists events that Regal Voice sends to Segment. These events app
3131
</tr>
3232
<tr>
3333
<td>contact.subscribed</td>
34-
<td>A Contact was subscribed to a marketing channel</td>
34+
<td>A contact was subscribed to a marketing channel</td>
3535
</tr>
3636
<tr>
3737
<td>contact.unsubscribed</td>
38-
<td>A Contact was unsubscribed from a marketing channel</td>
38+
<td>A contact was unsubscribed from a marketing channel</td>
3939
</tr>
4040
<tr>
4141
<td>sms.queued</td>
42-
<td>An sms was queued to be sent from RegalVoice to Contact</td>
42+
<td>An sms was queued to be sent from RegalVoice to contact</td>
4343
</tr>
4444
<tr>
4545
<td>sms.sent</td>
46-
<td>An sms was sent from RegalVoice to Contact</td>
46+
<td>An sms was sent from RegalVoice to contact</td>
4747
</tr>
4848
<tr>
49-
<td>sms.delivered</td>
50-
<td>An sms was delivered from RegalVoice to Contact</td>
49+
<td>sms.undelivered</td>
50+
<td>An sms was undelivered from RegalVoice to contact</td>
5151
</tr>
5252
<tr>
53-
<td>sms.undelivered</td>
54-
<td>An sms was undelivered from RegalVoice to Contact</td>
53+
<td>sms.received</td>
54+
<td>An sms was received from a contact</td>
55+
</tr>
56+
<tr>
57+
<td>task.created</td>
58+
<td>A call or sms task was created</td>
59+
</tr>
60+
<tr>
61+
<td>sms.conversation_completed</td>
62+
<td>An SMS conversation between a contact and an agent was completed in the Regal Voice agent desktop</td>
63+
</tr>
64+
<tr>
65+
<td>call.completed</td>
66+
<td>An inbound or outbound call with a contact was completed. This includes calls that were not answered</td>
5567
</tr>
5668
</table>
5769

@@ -64,16 +76,15 @@ The table below lists events that Regal Voice sends to Segment. These events app
6476
</tr>
6577
<tr>
6678
<td>`channel`</td>
67-
<td>Marketing channel of the subscription update. Acceptible value are: "voice", "sms", "email"
68-
</td>
79+
<td>The marketing channel: "voice" or "sms"</td>
6980
</tr>
7081
<tr>
7182
<td>`phone`</td>
72-
<td>The phone number the subscription update was applied to. Phone number is the unique identifier for a Contact in Regal Voice</td>
83+
<td>The phone number the subscription update was applied to. Phone number is the unique identifier for a contact in Regal Voice</td>
7384
</tr>
7485
<tr>
7586
<td>`email`</td>
76-
<td>The last email associated with the Contact</td>
87+
<td>The last email associated with the contact</td>
7788
</tr>
7889
<tr>
7990
<td>`ip`</td>
@@ -87,18 +98,18 @@ The table below lists events that Regal Voice sends to Segment. These events app
8798
</tr>
8899
<tr>
89100
<td>`text`</td>
90-
<td>Only applies to contact.subscribed event. The exact text the Contact was presented for opt in</td>
101+
<td>The exact text the contact was presented for opt in</td>
91102
</tr>
92103
<tr>
93104
<td>`timestamp`</td>
94105
<td>Unix timestamp for when the event took place</td>
95106
</tr>
96107
<tr>
97108
<td>`contact_phone`</td>
98-
<td>Phone number of the Contact</td>
109+
<td>Phone number of the contact</td>
99110
</tr>
100111
<tr>
101-
<td>`regal_voice_number`</td>
112+
<td>`regal_voice_phone`</td>
102113
<td>RegalVoice phone number</td>
103114
</tr>
104115
<tr>
@@ -107,7 +118,7 @@ The table below lists events that Regal Voice sends to Segment. These events app
107118
</tr>
108119
<tr>
109120
<td>`direction`</td>
110-
<td>Direction of the SMS (INBOUND or OUTBOUND)</td>
121+
<td>INBOUND or OUTBOUND</td>
111122
</tr>
112123
<tr>
113124
<td>`from_number`</td>
@@ -123,7 +134,87 @@ The table below lists events that Regal Voice sends to Segment. These events app
123134
</tr>
124135
<tr>
125136
<td>`sms_conversation_id`</td>
126-
<td>Unique ID of the conversation (if the sms was part of a two-way conversation with an Agent, rather than just an automated outbound sms)</td>
137+
<td>Task ID for the conversation. (If the sms was part of a two-way conversation with an Agent, rather than just an automated outbound sms)</td>
138+
</tr>
139+
<tr>
140+
<td>`campaign_friendly_id`</td>
141+
<td>Campaign Friendly Id as seen in the App</td>
142+
</tr>
143+
<tr>
144+
<td>`campaign_id`</td>
145+
<td>Campaign Id</td>
146+
</tr>
147+
<tr>
148+
<td>`campaign_name`</td>
149+
<td>Campaign Name</td>
150+
</tr>
151+
<tr>
152+
<td>`queue`</td>
153+
<td>Task Queue</td>
154+
</tr>
155+
<tr>
156+
<td>`scheduling_agent_fullname`</td>
157+
<td>Full name of the agent who scheduled the Callback</td>
158+
</tr>
159+
<tr>
160+
<td>`scheduling_agent_id`</td>
161+
<td>Email of the agent who scheduled the Callback</td>
162+
</tr>
163+
<tr>
164+
<td>`target_agent_fullname`</td>
165+
<td>Full name of the agent who contact (and all contact’s tasks) are assigned to</td>
166+
</tr>
167+
<tr>
168+
<td>`target_agent_id`</td>
169+
<td>Email of the agent who contact (and all contact’s tasks) are assigned to</td>
170+
</tr>
171+
<tr>
172+
<td>`task_id`</td>
173+
<td>Unique identifier for the task. Will match the call_id or sms_conversation_id of a completed task event.</td>
174+
</tr>
175+
<tr>
176+
<td>`type`</td>
177+
<td>Task Type</td>
178+
</tr>
179+
<tr>
180+
<td>`call_id`</td>
181+
<td>Task Id for the call</td>
182+
</tr>
183+
<tr>
184+
<td>`disposition`</td>
185+
<td>Task disposition</td>
186+
</tr>
187+
<tr>
188+
<td>`objections`</td>
189+
<td>Task objections</td>
190+
</tr>
191+
<tr>
192+
<td>`notes`</td>
193+
<td>Task notes</td>
194+
</tr>
195+
<tr>
196+
<td>`handle_time`</td>
197+
<td>Full duration task was being handled, including talk time and wrap time (completed_at - started_at)</td>
198+
</tr>
199+
<tr>
200+
<td>`wrapup_time`</td>
201+
<td>Duration task was in wrap up (completed_at - ended_at)</td>
202+
</tr>
203+
<tr>
204+
<td>`talk_time`</td>
205+
<td>Duration of conversation (ended_at - started_at)</td>
206+
</tr>
207+
<tr>
208+
<td>`started_at`</td>
209+
<td>UTC timestamp when the conversation was started</td>
210+
</tr>
211+
<tr>
212+
<td>`ended_at`</td>
213+
<td>UTC timestamp when the conversation was ended</td>
214+
</tr>
215+
<tr>
216+
<td>`completed_at`</td>
217+
<td>UTC Timestamp when the task was completed</td>
127218
</tr>
128219
</table>
129220

0 commit comments

Comments
 (0)