Skip to content

Thomas/regal voice #3693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 20, 2022
Merged

Thomas/regal voice #3693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28c25de
Update name for Regal Voice
Oct 20, 2022
0aaa8a1
Update regal voice source name and support email address
Oct 20, 2022
3c1a015
Merge branch 'develop' into thomas/regal-voice
Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/connections/destinations/catalog/regal-voice/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,18 @@ rewrite: true
title: Regal.io Destination
id: 5f33e746fad0d620b8a4b144
---
[Regal.io](https://www.regal.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a next-gen customer engagement platform that helps brands proactively engage and convert customers before they buy elsewhere.

Regal.io maintains this destination. For any issues with the destination, contact their [Regal.io support team](mailto:support@regalvoice.com).
[Regal.io](https://www.regal.io/?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.

> note "Note:"
Regal.io maintains this destination. For any issues with the destination, contact their [Regal.io support team](mailto:support@regal.io).


> note ""
> Regal.io is available in the U.S only.

> note "Note:"
> The Regal.io Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal.io Destination and its documentation, [contact the Regal.io support team](mailto:support@regalvoice.com)!
> note ""
> The Regal.io Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Regal.io Destination and its documentation, [contact the Regal.io support team](mailto:support@regal.io).



## Getting Started
Expand All @@ -21,7 +24,7 @@ Regal.io maintains this destination. For any issues with the destination, contac
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for "Regal.io" in the Destinations Catalog, and select the "Regal.io" destination.
3. Choose which Source should send data to the "Regal.io" destination.
4. Email support@regalvoice.com to get your "API key".
4. Email support@regal.io to get your "API key".
5. Enter the "API Key" in the "Regal.io" destination settings in Segment.


Expand Down
30 changes: 15 additions & 15 deletions src/connections/sources/catalog/cloud-apps/regal-voice/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
---
title: Regal Voice Source
title: Regal.io Source
source-type: event
id: 1QTd6JKw53
---
{% include content/source-region-unsupported.md %}

[Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform built for B2C services brands to proactively reach out to customers on voice and sms before they buy elsewhere.
[Regal.io](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform built for B2C services brands to proactively reach out to customers on voice and sms before they buy elsewhere.

This source is maintained by Regal Voice. For any issues with the source, [contact the Regal Voice Support team](mailto:support@regalvoice.com).
This source is maintained by Regal.io. For any issues with the source, [contact the Regal.io Support team](mailto:support@regal.io).

> success ""
> **Good to know**: This page is about the Regal Voice Segment source, which sends data _into_ Segment. There's also a page about the [Regal Voice Segment destination](/docs/connections/destinations/catalog/regal-voice/), which receives data from Segment!
> **Good to know**: This page is about the Regal.io Segment source, which sends data _into_ Segment. There's also a page about the [Regal.io Segment destination](/docs/connections/destinations/catalog/regal-voice/), which receives data from Segment!

## Getting Started

1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
2. Search for "Regal Voice" in the Sources Catalog, select click Regal Voice, and click **Add Source**.
2. Search for "Regal.io" in the Sources Catalog, select click Regal.io, and click **Add Source**.
3. On the next screen, give the Source a nickname and configure any other settings.

The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
5. Click **Add Source** to save your settings.
6. Copy the Write key from the Segment UI and email it to support@regalvoice.com.
6. Copy the Write key from the Segment UI and email it to support@regal.io.

## Events

The table below lists events that Regal Voice sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Regal Voice includes the `userId` if available.
The table below lists events that Regal.io sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations. Regal.io includes the `userId` if available.

| Event name | Property description |
| ---------------------------- | ----------------------------------------------------------------------------------------------------- |
Expand All @@ -36,10 +36,10 @@ The table below lists events that Regal Voice sends to Segment. These events app
| contact.attribute.edited | A contact's attributes were edited by an agent. |
| contact.experiment.assigned | A contact was assigned to an experiment. |
| scheduled.callback.requested | A callback was scheduled. |
| sms.conversation.completed | An SMS conversation between a contact and an agent was completed in the Regal Voice agent desktop. |
| sms.queued | An SMS was queued to be sent from Regal Voice to contact. |
| sms.sent | An SMS was sent from Regal Voice to contact. |
| sms.undelivered | An SMS was undelivered from Regal Voice to contact. |
| sms.conversation.completed | An SMS conversation between a contact and an agent was completed in the Regal.io agent desktop. |
| sms.queued | An SMS was queued to be sent from Regal.io to contact. |
| sms.sent | An SMS was sent from Regal.io to contact. |
| sms.undelivered | An SMS was undelivered from Regal.io to contact. |
| sms.received | An SMS was received from a contact. |
| task.canceled | A call or SMS task was canceled. |
| task.created | A call or SMS task was created. |
Expand Down Expand Up @@ -82,18 +82,18 @@ The table below lists events that Regal Voice sends to Segment. These events app
| `media_url` | Media URL (if it was an MMS) |
| `notes` | Task notes |
| `objections` | Task objections |
| `phone` | The phone number the subscription updated was applied to; phone number is the unique identifier for a contact in Regal voice |
| `phone` | The phone number the subscription updated was applied to; phone number is the unique identifier for a contact in Regal.io |
| `queue` | Task Queue |
| `recording_link` | Call recording link |
| `regal_voice_phone` | Regal Voice phone number |
| `regal_voice_phone` | Regal.io phone number |
| `regal_voice_phone_internal_name` | Internal name of phone line displayed to agents
| `reserved_agent_email` | Email of the agent the task reservation is for
| `reserved_agent_full_name` | Full name of the agent the task reservation is for
| `scheduling_agent_email` | Email of the agent who scheduled the callback |
| `scheduling_agent_fullname` | Full name of the agent who scheduled the callback |
| `scheduling_agent_id` | Email of the agent who scheduled the callback |
| `sms_conversation_id` | 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) |
| `source` | Source of the subscription update. A source value that starts with "Brand." indicates that the subscription update was initiated by the Brand (outside of the Regal Voice platform). A source value that starts with "RegalVoice." indicates that the subscription update was initiated through the Regal Voice platform. |
| `source` | Source of the subscription update. A source value that starts with "Brand." indicates that the subscription update was initiated by the Brand (outside of the Regal.io platform). A source value that starts with "RegalVoice." indicates that the subscription update was initiated through the Regal.io platform. |
| `started_at` | UTC timestamp when the conversation was started |
| `talk_time` | Duration of conversation (ended_at - started_at) |
| `target_agent_fullname` | Full name of the agent who contact (and all contact's tasks) are assigned to |
Expand All @@ -111,4 +111,4 @@ Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don't appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.

If there are any issues with how the events are arriving to Segment, [contact the Regal Voice support team](mailto:support@regalvoice.com).
If there are any issues with how the events are arriving to Segment, [contact the Regal.io support team](mailto:support@regal.io).