Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated README

  • Loading branch information...
commit b27eb9835ef41123ccdd7798d15cf7a4b076b345 1 parent 331b67f
@chadsmith authored
Showing with 109 additions and 0 deletions.
  1. +109 −0 README.md
View
109 README.md
@@ -0,0 +1,109 @@
+# Polls for OpenVBX
+
+This plugin allows you to conduct phone polls in OpenVBX. Use it with the [Match plugin][1] for SMS polling.
+
+[1]: https://github.com/chadsmith/OpenVBX-Plugin-Match
+
+## Installation
+
+[Download][2] the plugin and extract to /plugins
+
+[2]: https://github.com/chadsmith/OpenVBX-Plugin-Polls/archives/master
+
+## Usage
+
+Once installed, POLLS will appear in the OpenVBX sidebar
+
+### Creating a poll
+
+1. Click Manage Polls in the OpenVBX sidebar
+2. Click Add Poll
+3. Enter a name for your poll (this is only seen by you)
+4. Enter one or more options for poll responses (these are only seen by you)
+
+### Gathering a response
+
+Responses are recorded one option at a time so it's best to use the Poll applet after a Menu or Match applet
+
+1. Add the Poll applet to your Call or SMS flow
+2. Select the poll
+3. Select the option of the poll response
+
+### Viewing poll responses
+
+1. Click Manage Polls in the OpenVBX sidebar
+2. Find the poll you want to view
+3. Click the number of Responses
+
+## Examples
+
+### Creating a poll
+
+Poll Name
+
+`Best Ninja Turtle`
+
+Options
+
+`Leo`
+`Raph`
+`Mikey`
+`Donny`
+
+### Call Flow
+
+**Menu Applet**
+
+Read Text
+
+`Thank you for calling the Ninja Turtle Poll. Which Ninja Turtle do you think is the best? For Leonardo, press 1. For Raphael, press 2. For Michelangelo, press 3. For Donatello, press 4.`
+
+Menu Options
+
+Enter 1 for the first keypress and drop a Poll applet
+
+**Poll Applet**
+
+Select *Best Ninja Turtle*
+
+Select *Leo*
+
+Drop a Greeting applet for the next applet
+
+**Greeting Applet**
+
+Read Text
+
+`Your vote for Leonardo has been recorded.`
+
+Return to the **Menu Applet** and repeat for keypresses 2-4
+
+### SMS Flow
+
+**Match Applet**
+
+Enter *Leo* for the first keyword and drop a Poll applet
+
+**Pool Applet**
+
+Select *Best Ninja Turtle*
+
+Select *Leo*
+
+Drop Send a Reply for the next applet
+
+**Reply Applet**
+
+Message
+
+`Your vote for Leonardo has been recorded.`
+
+Return to the **Match Applet** and repeat for keywords Raph, Mikey and Donny
+
+Drop Send a Reply for the default response
+
+**Reply Applet**
+
+Message
+
+`Thank you for texting the Ninja Turtle Poll. Which Ninja Turtle do you think is the best? Reply with Leo, Raph, Mikey or Donny to vote.`
Please sign in to comment.
Something went wrong with that request. Please try again.