Purpose

This document guides how to configure and use the functionality of the Text App.

It guides:

An admin on how to :
- Configure General configuration
- Configure the distribution phone number for the Text bot
- Using Campaign functional
- Trace log
An end-user on how to use the text bot

Guideline

Web app

Configuration Tab

This step is important, it needs to be applied first.

Navigate to Dashboard/Text Application in LS Web Application
In the "Configuration" tab, configure some fields in the following table

Field name	Description	Note
Subscription	The keyword which end-user texts to the distribution phone number for subscribing. Keywords have been separated by a comma	Example: subscribe, sub
Unsubscription	The keyword which end-user texts to the distribution phone number for unsubscribing. Keywords have been separated by a comma	Example: unsubscribe, unsub
Text Bot URL	Using this link to reload subscription and subscription keywords when updating these keywords. Format: domain/autoenrollbot	Example: https://labvn54.primas.net:9443/autoenrollbot
Botconnector URL	Using this link to reload the configuration of BotConnector when adding/editing/deleting the phone number of the distribution group	Example: https://labvn54.primas.net:9443/botconnector
Send Mail URL	Using this link to send mail when the campaign is stopped	Example: https://labvn54.primas.net:9443/autoenrollbot/send-mail

Click the "Save Configuration" button

Distribution Group Tab

This page is used to manage the phone number of the distribution group and configure for the campaign

How to add a new distribution phone number

In the Distribution Group tab, click "Add Group"
Enter some fields by the following table

Field name	Description	Note
Phone number	The distribution group phone number	Example: 2065621001
Group Name	The distribution group name	Example: Support group
Zipwhip Session	The Zipwhip session to configure the webhook to receiving the incoming message of the distribution group phone number
User	The user who manages the corresponding distribution group
Number Of Random Selection	The number of subscribers is randomly selected to receive the message. The value is zero or empty will send all subscribers to the distribution list. If not set, not limited selection	Example: 10
Max Subscribers	The maximum number of the subscriber can be joined to the distribution list. This config only applies to the auto-enroll by text. Users can add the subscriber to the list manually from the web application without checking this config.	Example: 50
Confirm Before Publish	Text bot will confirm user before sending a message to the distribution group
Sender Authorization	If checked, only the publisher can send message to the distribution group Otherwise, anyone can send a message to the distribution group
Allow Auto-enroll	If checked, the user can subscribe distribution group Otherwise, the user can not subscribe distribution group
List Full Message	Reply this message to the subscriber's inbound message if they send the subscribe keyword at the time that the number of subscribers has reached the Max subscribers configuration.
Default Message	Reply to this message when the user's message does not match any keyword. Using {subscription} and {unsubscription} for subscription and unsubscription keyword	Example: I didn't understand your message. Please enter {subscription} for subscribe distribution group Please enter {unsubscription} for unsubscribe distribution group

Click the "Update" button

How to start the campaign

In the Distribution Group tab, when adding/editing → check the "I am Available Campaign" checkbox
Enter some fields by the following table

Field name	Description	Note
Campaign Keyword	Acceptance keywords separated by commas for the subscriber to text in. Keywords have been separated by a comma	Example: avai, available
Max Slots	A number indicates the maximum number of the subscriber can be in the eligible final list	Example: 10
Start Time	The time to start the campaign at the current date
End Time	The time to end the campaign at the current date
Campaign Closed Message	Reply this message to subscriber inbound message if they send the campaign keyword at the time that the campaign time window is inactive
Campaign Full Message	Reply this message to subscriber inbound message if they send the campaign keyword at the time that the campaign has reached the maximum slots config
Campaign Successful Message	Reply this message to subscriber inbound message if they send the campaign keyword at the campaign active time and the campaign has reached the maximum slots config (eligible to the final list)
Campaign Result Email	The email address that the system will send the result as soon as the time window is closed or it reached the max slots config

Click the "Start Campaign" button → click "Cancel"

How to stop the campaign

In the Distribution Group tab, edit the distribution group which running the campaign
Click the "Stop Campaign" button → click "Cancel"

Import/Export distribution group

Text app support export and import distribution group in the "Distribution Group" tab

Publisher/Subscriber Tab

This tab is used to manage all subscriber and publisher of all distribution group

How to add publisher/subscriber

In the "Publisher/Subscriber" tab, click the "Add Publisher/Subscriber" button
Enter some fields by the following table

Field name	Description	Note
Phone Number	The phone number of the publisher	Example: 2052089371
Phone Type	Subscriber Publisher
Group	Select distribution group
Status	Status of Subscriber/Publisher

Click the "Update" button

Campaign History Tab

All campaign history will be shown in this tab, user can review campaign information for each one.

How to get all user in campaign

In the "Campaign History" tab, choose the campaign which you want to get the user in campaign → click the "Details" button
Text app will show you all user in the corresponding campaign
- You can export all user in the campaign to an excel file

Send Message Tab

You can send message to all subscriber/publisher in the distribution group in this tab

How to send message to the distribution group

In the "Send Message" tab, choose distribution group → type the message → click the "Send" button

Message Log Tab

This tab shows all message which is sent to the distribution group

For each row, you can review sender, receiver, status of message, message,...

View Inbound Message Log

This tab shows all incoming message of the Text bot

Text bot

How to subscribe/unsubscribe distribution group

User can text the subscription/unsubscription keyword into the distribution phone number

How to register campaign list

User can text the available keyword into the distribution phone number when the campaign is running

How to send message to the distribution group

User can text any message which does not match with subscription/unsubscription/available keyword to send message to all subscribers/publishers distribution group

NOTE

Subscribers/publishers will not receive the message from the distribution group if the status is unsubscriber/inactive
User can not subscribe to the distribution group if "Allow Auto-enroll" is not checked
The Start time and End time will not be configured if the campaign is running
When the campaign list is full, the system will send mail but the campaign status is still running until the campaign is expired or the administrator click the "Stop Campaign" button in Web App