Regal Voice Source
Good to know: Event source
The Regal Voice Source is an event source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.
Regal Voice 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.
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, which receives data from Segment!
- From your workspace’s Sources catalog page click Add Source.
- Search for “Regal Voice” in the Sources Catalog, select click Regal Voice, and click Add Source.
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).
- Click Add Source to save your settings.
- Copy the Write key from the Segment UI and email it to firstname.lastname@example.org.
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.
|contact.subscribed||A Contact was subscribed to a marketing channel|
|contact.unsubscribed||A Contact was unsubscribed from a marketing channel|
|sms.queued||An sms was queued to be sent from RegalVoice to Contact|
|sms.sent||An sms was sent from RegalVoice to Contact|
|sms.delivered||An sms was delivered from RegalVoice to Contact|
|sms.undelivered||An sms was undelivered from RegalVoice to Contact|
||Marketing channel of the subscription update. Acceptible value are: “voice”, “sms”, “email”|
||The phone number the subscription update was applied to. Phone number is the unique identifier for a Contact in Regal Voice|
|The last email associated with the Contact|
||The IP address from where the subscription update was initiated.|
||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 supscription update was initiated through the Regal Voice platform.|
||Only applies to contact.subscribed event. The exact text the Contact was presented for opt in|
||Unix timestamp for when the event took place|
||Phone number of the Contact|
||RegalVoice phone number|
||Content of the message|
||Direction of the SMS (INBOUND or OUTBOUND)|
||Phone number that sent the message|
||Phone number to which the message was sent|
||Media URL (if it was an MMS)|
||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)|
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 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.
This page was last modified: 06 Jan 2021
Questions? Problems? Need more info? Contact us, and we can help!